PUM_Admin_Pages

Class PUM_Admin_Pages


Description Description


Source Source

File: classes/Admin/Pages.php

class PUM_Admin_Pages {


	/**
	 * @var array
	 */
	public static $pages = array();

	/**
	 *
	 */
	public static function init() {
		add_action( 'admin_menu', array( __CLASS__, 'register_pages' ) );
		add_action( 'admin_head',  array( __CLASS__, 'reorder_admin_submenu' ) );
	}

	/**
	 * Returns the requested pages handle.
	 *
	 * @param $key
	 *
	 * @return bool|mixed
	 */
	public static function get_page( $key ) {
		return isset( self::$pages[ $key ] ) ? self::$pages[ $key ] : false;
	}

	/**
	 * Creates the admin submenu pages under the Popup Maker menu and assigns their
	 * links to global variables
	 */
	public static function register_pages() {

		$admin_pages = apply_filters( 'pum_admin_pages', array(
			'subscribers' => array(
				'page_title'  => __( 'Subscribers', 'popup-maker' ),
				'capability'  => 'manage_options',
				'callback'    => array( 'PUM_Admin_Subscribers', 'page' ),
			),
			'settings'   => array(
				'page_title'  => __( 'Settings', 'popup-maker' ),
				'capability'  => 'manage_options',
				'callback'    => array( 'PUM_Admin_Settings', 'page' ),
			),
			'extensions' => array(
				'page_title'  => __( 'Upgrade', 'popup-maker' ),
				'capability'  => 'edit_posts',
				'callback'    => array( 'PUM_Admin_Extend', 'page' ),
			),
			'support'    => array(
				'page_title'  => __( 'Help & Support', 'popup-maker' ),
				'capability'  => 'edit_posts',
				'callback'    => array( 'PUM_Admin_Support', 'page' ),
			),
			'tools'      => array(
				'page_title'  => __( 'Tools', 'popup-maker' ),
				'capability'  => 'manage_options',
				'callback'    => array( 'PUM_Admin_Tools', 'page' ),
			),
		) );

		foreach ( $admin_pages as $key => $page ) {
			$page = wp_parse_args( $page, array(
				'parent_slug' => 'edit.php?post_type=popup',
				'page_title'  => '',
				'menu_title'  => '',
				'capability'  => 'manage_options',
				'menu_slug'   => '',
				'callback'    => '',
			) );

			// Backward compatibility.
			$page['capability'] = apply_filters( 'popmake_admin_submenu_' . $key . '_capability', $page['capability'] );

			if ( empty( $page['menu_slug'] ) ) {
				$page['menu_slug'] = 'pum-' . $key;
			}

			if ( ! empty( $page['page_title'] ) && empty( $page['menu_title'] ) ) {
				$page['menu_title'] = $page['page_title'];
			} elseif ( ! empty( $page['menu_title'] ) && empty( $page['page_title'] ) ) {
				$page['page_title'] = $page['menu_title'];
			}

			self::$pages[ $key ] = add_submenu_page( $page['parent_slug'], $page['page_title'], $page['menu_title'], $page['capability'], $page['menu_slug'], $page['callback'] );
			// For backward compatibility.
			$GLOBALS[ "popmake_" . $key . "_page" ] = self::$pages[ $key ];
		}

		// Add shortcut to theme editor from Appearance menu.
		add_theme_page( __( 'Popup Themes', 'popup-maker' ), __( 'Popup Themes', 'popup-maker' ), 'edit_posts', 'edit.php?post_type=popup_theme' );
	}


	/**
	 * Submenu filter function. Tested with Wordpress 4.1.1
	 * Sort and order submenu positions to match our custom order.
	 *
	 * @since 1.4
	 */
	public static function reorder_admin_submenu() {
		global $submenu;

		if ( isset( $submenu['edit.php?post_type=popup'] ) ) {
			// Sort the menu according to your preferences
			usort( $submenu['edit.php?post_type=popup'], array( __CLASS__, 'reorder_submenu_array' ) );
		}
	}

	/**
	 * Reorders the submenu by title.
	 *
	 * Forces $first_pages to load in order at the beginning of the menu
	 * and $last_pages to load in order at the end. All remaining menu items will
	 * go out in generic order.
	 *
	 * @since 1.4
	 *
	 * @param $a
	 * @param $b
	 *
	 * @return int
	 */
	public static function reorder_submenu_array( $a, $b ) {
		$first_pages = apply_filters( 'pum_admin_submenu_first_pages', array(
			__( 'All Popups', 'popup-maker' ),
			__( 'Add New', 'popup-maker' ),
			__( 'All Themes', 'popup-maker' ),
			__( 'Categories', 'popup-maker' ),
			__( 'Tags', 'popup-maker' ),
		) );
		$last_pages  = apply_filters( 'pum_admin_submenu_last_pages', array(
			__( 'Extend', 'popup-maker' ),
			__( 'Settings', 'popup-maker' ),
			__( 'Tools', 'popup-maker' ),
			__( 'Support Forum', 'popup-maker' ),
			__( 'Account', 'popup-maker' ),
			__( 'Contact Us', 'popup-maker' ),
			__( 'Help & Support', 'popup-maker' ),
		) );

		$a_val = strip_tags( $a[0], false );
		$b_val = strip_tags( $b[0], false );

		// Sort First Page Keys.
		if ( in_array( $a_val, $first_pages ) && ! in_array( $b_val, $first_pages ) ) {
			return - 1;
		} elseif ( ! in_array( $a_val, $first_pages ) && in_array( $b_val, $first_pages ) ) {
			return 1;
		} elseif ( in_array( $a_val, $first_pages ) && in_array( $b_val, $first_pages ) ) {
			$a_key = array_search( $a_val, $first_pages );
			$b_key = array_search( $b_val, $first_pages );

			return ( $a_key < $b_key ) ? - 1 : 1;
		}

		// Sort Last Page Keys.
		if ( in_array( $a_val, $last_pages ) && ! in_array( $b_val, $last_pages ) ) {
			return 1;
		} elseif ( ! in_array( $a_val, $last_pages ) && in_array( $b_val, $last_pages ) ) {
			return - 1;
		} elseif ( in_array( $a_val, $last_pages ) && in_array( $b_val, $last_pages ) ) {
			$a_key = array_search( $a_val, $last_pages );
			$b_key = array_search( $b_val, $last_pages );

			return ( $a_key < $b_key ) ? - 1 : 1;
		}

		// Sort remaining keys
		return $a > $b ? 1 : - 1;
	}
}

Top ↑

Changelog Changelog

Changelog
Version Description
1.7.0 Introduced.

Top ↑

Methods Methods

  • get_page — Returns the requested pages handle.
  • init
  • register_pages — Creates the admin submenu pages under the Popup Maker menu and assigns their links to global variables
  • reorder_admin_submenu — Submenu filter function. Tested with Wordpress 4.1.1 Sort and order submenu positions to match our custom order.
  • reorder_submenu_array — Reorders the submenu by title.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.