LLMS_Admin_Menus
LLMS_Admin_Menus class
Contents
Source Source
File: includes/admin/class.llms.admin.menus.php
class LLMS_Admin_Menus { /** * Constructor * * @since 1.0.0 * @since 3.19.0 Add action scheduler posts table. * * @return void */ public function __construct() { add_action( 'admin_init', array( $this, 'status_page_actions' ) ); add_action( 'admin_init', array( $this, 'builder_page_actions' ) ); add_action( 'load-admin_page_llms-course-builder', array( $this, 'builder_title' ) ); add_filter( 'custom_menu_order', array( $this, 'submenu_order' ) ); add_action( 'admin_menu', array( $this, 'display_admin_menu' ) ); add_action( 'admin_menu', array( $this, 'display_admin_menu_late' ), 7777 ); // Shame shame shame. add_action( 'admin_menu', array( $this, 'instructor_menu_hack' ) ); add_filter( 'action_scheduler_post_type_args', array( $this, 'action_scheduler_menu' ) ); } /** * If WP_DEBUG is not enabled, expose the schedule-action post type management via direct link * * EG: site.com/wp-admin/edit.php?post_type=scheduled-action * * @since 3.19.0 * * @param array $args Default custom post type arguments. * @return array */ public function action_scheduler_menu( $args ) { // If WP_DEBUG is enabled the menu item will already be displayed under "tools.php". if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) { return $args; } // Otherwise we'll add a hidden menu accessible via direct link only. return array_merge( $args, array( 'show_ui' => true, 'show_in_menu' => '', 'show_in_admin_bar' => false, ) ); } /** * Remove the default menu page from the submenu. * * @since 1.0.0 * @since 3.2.0 Unknown. * @since 5.0.0 Adds custom sorting for LifterLMS submenu items. * @since 7.1.0 Added `llms-dashboard` to the order array in first position. * * @param bool $flag Flag from core filter (always false). * @return bool */ public function submenu_order( $flag ) { global $submenu; if ( isset( $submenu['lifterlms'] ) ) { // Our desired order. $order = array( 'llms-dashboard', 'llms-settings', 'llms-reporting', 'edit.php?post_type=llms_form' ); // Temporary array to hold our submenu items. $new_submenu = array(); // Any items not defined in the $order array will be added at the end of the new array. $num_items = count( $submenu['lifterlms'] ); foreach ( $submenu['lifterlms'] as $item ) { // Locate the desired order. $key = array_search( $item[2], $order, true ); // Not found, increment the number of items to add it to the end of the array in its original order. if ( false === $key ) { $key = ++$num_items; } // Add the item to the new submenu. $new_submenu[ $key ] = $item; } // Sort. ksort( $new_submenu ); // Remove the keys so the new array doesn't skip any numbers. $submenu['lifterlms'] = array_values( $new_submenu ); } return $flag; } /** * Handle init actions on the course builder page * * Used for post-locking redirects when taking over from another user * on the course builder page. * * @since 3.13.0 * @since 3.16.7 Unknown. * * @return void */ public function builder_page_actions() { if ( ! isset( $_GET['page'] ) || 'llms-course-builder' !== $_GET['page'] ) { return; } if ( ! empty( $_GET['get-post-lock'] ) && ! empty( $_GET['course_id'] ) ) { $post_id = absint( $_GET['course_id'] ); check_admin_referer( 'lock-post_' . $post_id ); wp_set_post_lock( $post_id ); wp_safe_redirect( add_query_arg( array( 'page' => 'llms-course-builder', 'course_id' => $post_id, ), admin_url( 'admin.php' ) ) ); exit(); } add_action( 'admin_bar_menu', array( 'LLMS_Admin_Builder', 'admin_bar_menu' ), 100, 1 ); } /** * Set the global $title variable for the builder * * Prevents the <title> in the admin head being partially empty on builder screen. * * @since 3.14.9 * * @return void */ public function builder_title() { global $title; $title = __( 'Course Builder', 'lifterlms' ); } /** * Admin Menu. * * @since 1.0.0 * @since 3.13.0 Unknown. * @since 5.3.1 Use encoded SVG LifterLMS icon so that WordPress can "paint" it. * submenu page in place of NULL. * @since 7.1.0 Added the 'Dashboard' submenu page. * @since 7.4.1 Added the 'Resources' submenu page. * * @return void */ public function display_admin_menu() { global $menu; $menu[51] = array( '', 'read', 'llms-separator', '', 'wp-menu-separator' ); $icon_url = 'data:image/svg+xml;base64,' . base64_encode( file_get_contents( LLMS_PLUGIN_DIR . 'assets/images/lifterlms-icon-grey.svg' ) ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents, WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode add_menu_page( 'lifterlms', 'LifterLMS', 'read', 'lifterlms', '__return_empty_string', $icon_url, 51 ); add_submenu_page( 'lifterlms', __( 'LifterLMS Dashboard', 'lifterlms' ), __( 'Dashboard', 'lifterlms' ), 'manage_lifterlms', 'llms-dashboard', array( $this, 'dashboard_page_init' ) ); add_submenu_page( 'lifterlms', __( 'LifterLMS Settings', 'lifterlms' ), __( 'Settings', 'lifterlms' ), 'manage_lifterlms', 'llms-settings', array( $this, 'settings_page_init' ) ); add_submenu_page( 'lifterlms', __( 'LifterLMS Reporting', 'lifterlms' ), __( 'Reporting', 'lifterlms' ), 'view_lifterlms_reports', 'llms-reporting', array( $this, 'reporting_page_init' ) ); add_submenu_page( 'lifterlms', __( 'LifterLMS Import', 'lifterlms' ), __( 'Import', 'lifterlms' ), 'manage_lifterlms', 'llms-import', array( $this, 'import_page_init' ) ); add_submenu_page( 'lifterlms', __( 'LifterLMS Status', 'lifterlms' ), __( 'Status', 'lifterlms' ), 'manage_lifterlms', 'llms-status', array( $this, 'status_page_init' ) ); add_submenu_page( 'lifterlms', __( 'LifterLMS Resources', 'lifterlms' ), __( 'Resources', 'lifterlms' ), 'manage_lifterlms', 'llms-resources', array( $this, 'resources_page_init' ) ); // Passing '' to register the page without actually adding a menu item. add_submenu_page( '', __( 'LifterLMS Course Builder', 'lifterlms' ), __( 'Course Builder', 'lifterlms' ), 'edit_courses', 'llms-course-builder', array( $this, 'builder_init' ) ); } /** * Add items to the admin menu with a later priority * * @since 3.5.0 * @since 3.22.0 Unknown. * * @return void */ public function display_admin_menu_late() { /** * Disable the display and output of LifterLMS Add-ons screen. * * @since Unknown * * @param boolean $display Whether or not to display the screen. Defaults to `false` which shows the screen. */ if ( apply_filters( 'lifterlms_disable_addons_screen', false ) ) { return; } add_submenu_page( 'lifterlms', __( 'LifterLMS Add-ons, Courses, and Resources', 'lifterlms' ), __( 'Add-ons & more', 'lifterlms' ), 'manage_lifterlms', 'llms-add-ons', array( $this, 'add_ons_page_init' ) ); } /** * Output the add-ons screen. * * @since 3.5.0 * @since 3.22.0 Unknown. * @since 6.0.0 Removed loading the LLMS_Admin_AddOns class file that is now handled by the autoloader. * * @return void */ public function add_ons_page_init() { $view = new LLMS_Admin_AddOns(); $view->handle_actions(); $view->output(); } /** * Output the HTML for the Course Builder * * @since 3.13.0 * @since 3.16.0 Unknown. * @since 6.0.0 Removed loading the LLMS_Admin_Builder class file that is now handled by the autoloader. * * @return void */ public function builder_init() { LLMS_Admin_Builder::output(); } /** * Outputs the LifterLMS Importer Screen HTML * * @since 3.3.0 * * @return void */ public function import_page_init() { LLMS_Admin_Import::output(); } /** * Removes edit.php from the admin menu for instructors/asst instructors * * Note: The post screen is still technically accessible. * * Posts will need to be submitted for review as the instructors only actually have * the capability of a contributor with regards to posts * but this hack will allow instructors to publish new lessons, quizzes, & questions. * * @since 3.13.0 * @since 7.0.1 Added filterable early return allowing 3rd parties to modify * the user roles affected by this hack. * * @link https://core.trac.wordpress.org/ticket/22895 * @link https://core.trac.wordpress.org/ticket/16808 * * @return void */ public function instructor_menu_hack() { /** * Filters the WP_User roles should receive the instructor admin menu hack. * * If you wish to provide explicit access to the `post` post type, to the * instrutor or instructor's assistant role, the role will need to be * removed from this array so they can access to the post type edit.php * screen. * * @see LLMS_Admin_Menus::instructor_menu_hack * * @since 7.0.1 * * @param string[] $roles The list of WP_User roles which need the hack. */ $roles = apply_filters( 'llms_instructor_menu_hack_roles', array( 'instructor', 'instructors_assistant' ) ); $user = wp_get_current_user(); if ( array_intersect( $roles, $user->roles ) ) { remove_menu_page( 'edit.php' ); } } /** * Output the HTML for admin dashboard screen. * * @since 7.1.0 * * @return void */ public function dashboard_page_init() { LLMS_Admin_Dashboard::register_meta_boxes(); LLMS_Admin_Dashboard::output(); } /** * Output the HTML for admin settings screens * * @since Unknown * @since 6.0.0 Removed loading the LLMS_Admin_Settings class file that is now handled by the autoloader. * * @return void */ public function settings_page_init() { LLMS_Admin_Settings::output(); } /** * Output the HTML for the reporting screens * * @since 3.2.0 * @since 3.13.0 Unknown. * @since 3.35.0 Sanitize input data. * @since 4.7.0 Removed inclusion of `LLMS_Admin_Reporting` which is now loaded automatically. * * @return void */ public function reporting_page_init() { if ( isset( $_GET['student_id'] ) && ! llms_current_user_can( 'view_lifterlms_reports', llms_filter_input( INPUT_GET, 'student_id', FILTER_SANITIZE_NUMBER_INT ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended wp_die( __( 'You do not have permission to access this content.', 'lifterlms' ) ); } $reporting = new LLMS_Admin_Reporting(); $reporting->output(); } /** * Include files used on the Status page. * * @since 3.37.19 * @since 4.12.0 Added `llms_load_admin_tools` action. * @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading. * * @return void */ protected function status_page_includes() { // Tools. foreach ( glob( LLMS_PLUGIN_DIR . 'includes/admin/tools/class-llms-admin-tool-*.php' ) as $tool_path ) { require_once $tool_path; } /** * Action which can be used by 3rd parties to load custom admin page tools. * * @since 4.12.0 */ do_action( 'llms_load_admin_tools' ); } /** * Handle form submission actions on the status pages * * @since 3.11.2 * @since 3.37.19 Load tools-related files. * * @return void
Expand full source code Collapse full source code View on GitHub
Methods Methods
- __construct — Constructor
- action_scheduler_menu — If WP_DEBUG is not enabled, expose the schedule-action post type management via direct link
- add_ons_page_init — Output the add-ons screen.
- builder_init — Output the HTML for the Course Builder
- builder_page_actions — Handle init actions on the course builder page
- builder_title — Set the global $title variable for the builder
- display_admin_menu — Admin Menu
- display_admin_menu_late — Add items to the admin menu with a later priority
- import_page_init — Outputs the LifterLMS Importer Screen HTML
- instructor_menu_hack — Removes edit.php from the admin menu for instructors/asst instructors
- reporting_page_init — Output the HTML for the reporting screens
- settings_page_init — Output the HTML for admin settings screens
- status_page_actions — Handle form submission actions on the status pages
- status_page_includes — Include files used on the Status page.
- status_page_init — Output the HTML for the Status Pages
- submenu_order — Remove the default menu page from the submenu
Changelog Changelog
Version | Description |
---|---|
5.0.0 | Add custom LifterLMS submenu item sorting. |
3.37.19 | Load tools on the status page. |
3.35.0 | Sanitize input data. |
3.19.0 | Added action scheduler posts table. |
1.0.0 | Introduced. |