UI String */ function get_column_headers( $screen ) { if ( is_string( $screen ) ) $screen = convert_to_screen( $screen ); static $column_headers = array(); if ( ! isset( $column_headers[ $screen->id ] ) ) $column_headers[ $screen->id ] = apply_filters( 'manage_' . $screen->id . '_columns', array() ); return $column_headers[ $screen->id ]; } /** * Get a list of hidden columns. * * @since 2.7.0 * * @param string|WP_Screen $screen The screen you want the hidden columns for * @return array */ function get_hidden_columns( $screen ) { if ( is_string( $screen ) ) $screen = convert_to_screen( $screen ); return (array) get_user_option( 'manage' . $screen->id . 'columnshidden' ); } /** * Prints the meta box preferences for screen meta. * * @since 2.7.0 * * @param string|WP_Screen $screen */ function meta_box_prefs( $screen ) { global $wp_meta_boxes; if ( is_string( $screen ) ) $screen = convert_to_screen( $screen ); if ( empty($wp_meta_boxes[$screen->id]) ) return; $hidden = get_hidden_meta_boxes($screen); foreach ( array_keys($wp_meta_boxes[$screen->id]) as $context ) { foreach ( array_keys($wp_meta_boxes[$screen->id][$context]) as $priority ) { foreach ( $wp_meta_boxes[$screen->id][$context][$priority] as $box ) { if ( false == $box || ! $box['title'] ) continue; // Submit box cannot be hidden if ( 'submitdiv' == $box['id'] || 'linksubmitdiv' == $box['id'] ) continue; $box_id = $box['id']; echo ''; echo ''; echo "{$box['title']}\n"; } } } } /** * Get Hidden Meta Boxes * * @since 2.7.0 * * @param string|WP_Screen $screen Screen identifier * @return array Hidden Meta Boxes */ function get_hidden_meta_boxes( $screen ) { if ( is_string( $screen ) ) $screen = convert_to_screen( $screen ); $hidden = get_user_option( "metaboxhidden_{$screen->id}" ); $use_defaults = ! is_array( $hidden ); // Hide slug boxes by default if ( $use_defaults ) { $hidden = array(); if ( 'post' == $screen->base ) { if ( 'post' == $screen->post_type || 'page' == $screen->post_type ) $hidden = array('slugdiv', 'trackbacksdiv', 'postcustom', 'postexcerpt', 'commentstatusdiv', 'commentsdiv', 'authordiv', 'revisionsdiv'); else $hidden = array( 'slugdiv' ); } $hidden = apply_filters( 'default_hidden_meta_boxes', $hidden, $screen ); } return apply_filters( 'hidden_meta_boxes', $hidden, $screen, $use_defaults ); } /** * Convert a screen string to a screen object * * @since 3.0.0 * * @param string $hook_name The hook name (also known as the hook suffix) used to determine the screen. * @return WP_Screen Screen object. */ function convert_to_screen( $hook_name ) { return WP_Screen::get( $hook_name ); } /** * Add contextual help text for a page. * * Creates a 'Screen Info' help tab. * * @since 2.7.0 * * @param string $screen The handle for the screen to add help to. This is usually the hook name returned by the add_*_page() functions. * @param string $help The content of a 'Screen Info' help tab. * * @todo: deprecate? */ function add_contextual_help( $screen, $help ) { if ( is_string( $screen ) ) $screen = convert_to_screen( $screen ); WP_Screen::add_old_compat_help( $screen, $help ); } /** * Register and configure an admin screen option * * @since 3.1.0 * * @param string $option An option name. * @param mixed $args Option-dependent arguments. * @return void */ function add_screen_option( $option, $args = array() ) { $current_screen = get_current_screen(); if ( ! $current_screen ) return; return $current_screen->add_option( $option, $args ); } /** * Displays a screen icon. * * @uses get_screen_icon() * @since 2.7.0 * * @param string|WP_Screen $screen Optional. Accepts a screen object (and defaults to the current screen object) * which it uses to determine an icon HTML ID. Or, if a string is provided, it is used to form the icon HTML ID. */ function screen_icon( $screen = '' ) { echo get_screen_icon( $screen ); } /** * Gets a screen icon. * * @since 3.2.0 * * @param string|WP_Screen $screen Optional. Accepts a screen object (and defaults to the current screen object) * which it uses to determine an icon HTML ID. Or, if a string is provided, it is used to form the icon HTML ID. * @return string HTML for the screen icon. */ function get_screen_icon( $screen = '' ) { if ( empty( $screen ) ) $screen = get_current_screen(); elseif ( is_string( $screen ) ) $icon_id = $screen; $class = 'icon32'; if ( empty( $icon_id ) ) { if ( ! empty( $screen->parent_base ) ) $icon_id = $screen->parent_base; else $icon_id = $screen->base; if ( 'page' == $screen->post_type ) $icon_id = 'edit-pages'; if ( $screen->post_type ) $class .= ' ' . sanitize_html_class( 'icon32-posts-' . $screen->post_type ); } return '

'; } /** * Get the current screen object * * @since 3.1.0 * * @return object Current screen object */ function get_current_screen() { global $current_screen; if ( ! isset( $current_screen ) ) return null; return $current_screen; } /** * Set the current screen object * * @since 3.0.0 * @uses $current_screen * * @param mixed $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen, * or an existing screen object. */ function set_current_screen( $hook_name = '' ) { WP_Screen::get( $hook_name )->set_current_screen(); } /** * A class representing the admin screen. * * @since 3.3.0 * @access public */ final class WP_Screen { /** * Any action associated with the screen. 'add' for *-add.php and *-new.php screens. Empty otherwise. * * @since 3.3.0 * @var string * @access public */ public $action = ''; /** * The base type of the screen. This is typically the same as $id but with any post types and taxonomies stripped. * For example, for an $id of 'edit-post' the base is 'edit'. * * @since 3.3.0 * @var string * @access public */ public $base; /** * The unique ID of the screen. * * @since 3.3.0 * @var string * @access public */ public $id; /** * Whether the screen is in the network admin. * * @since 3.3.0 * @var bool * @access public */ public $is_network; /** * Whether the screen is in the user admin. * * @since 3.3.0 * @var bool * @access public */ public $is_user; /** * The base menu parent. * This is derived from $parent_file by removing the query string and any .php extension. * $parent_file values of 'edit.php?post_type=page' and 'edit.php?post_type=post' have a $parent_base of 'edit'. * * @since 3.3.0 * @var string * @access public */ public $parent_base; /** * The parent_file for the screen per the admin menu system. * Some $parent_file values are 'edit.php?post_type=page', 'edit.php', and 'options-general.php'. * * @since 3.3.0 * @var string * @access public */ public $parent_file; /** * The post type associated with the screen, if any. * The 'edit.php?post_type=page' screen has a post type of 'page'. * The 'edit-tags.php?taxonomy=$taxonomy&post_type=page' screen has a post type of 'page'. * * @since 3.3.0 * @var string * @access public */ public $post_type; /** * The taxonomy associated with the screen, if any. * The 'edit-tags.php?taxonomy=category' screen has a taxonomy of 'category'. * @since 3.3.0 * @var string * @access public */ public $taxonomy; /** * The help tab data associated with the screen, if any. * * @since 3.3.0 * @var array * @access private */ private $_help_tabs = array(); /** * The help sidebar data associated with screen, if any. * * @since 3.3.0 * @var string * @access private */ private $_help_sidebar = ''; /** * Stores old string-based help. */ private static $_old_compat_help = array(); /** * The screen options associated with screen, if any. * * @since 3.3.0 * @var array * @access private */ private $_options = array(); /** * The screen object registry. * * @since 3.3.0 * @var array * @access private */ private static $_registry = array(); /** * Stores the result of the public show_screen_options function. * * @since 3.3.0 * @var bool * @access private */ private $_show_screen_options; /** * Stores the 'screen_settings' section of screen options. * * @since 3.3.0 * @var string * @access private */ private $_screen_settings; /** * Fetches a screen object. * * @since 3.3.0 * @access public * * @param string $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen. * Defaults to the current $hook_suffix global. * @return WP_Screen Screen object. */ public function get( $hook_name = '' ) { if ( is_a( $hook_name, 'WP_Screen' ) ) return $hook_name; $action = $post_type = $taxonomy = ''; if ( $hook_name ) { if ( '-network' == substr( $hook_name, -8 ) ) $hook_name = str_replace( '-network', '', $hook_name ); elseif ( '-user' == substr( $hook_name, -5 ) ) $hook_name = str_replace( '-user', '', $hook_name ); $id = sanitize_key( $hook_name ); if ( false !== strpos( $id, '-' ) ) { list( $id, $second ) = explode( '-', $id, 2 ); if ( taxonomy_exists( $second ) ) { $id = 'edit-tags'; $taxonomy = $second; } elseif ( post_type_exists( $second ) ) { $post_type = $second; } else { $id .= '-' . $second; } } } else { $id = $GLOBALS['hook_suffix']; $id = str_replace( '.php', '', $id ); if ( in_array( substr( $id, -4 ), array( '-add', '-new' ) ) ) $action = 'add'; $id = str_replace( array( '-new', '-add' ), '', $id ); } if ( 'index' == $id ) $id = 'dashboard'; $base = $id; // If this is the current screen, see if we can be more accurate for post types and taxonomies. if ( ! $hook_name ) { switch ( $base ) { case 'post' : if ( isset( $_GET['post'] ) ) $post_id = (int) $_GET['post']; elseif ( isset( $_POST['post_ID'] ) ) $post_id = (int) $_POST['post_ID']; else $post_id = 0; if ( $post_id ) { $post = get_post( $post_id ); if ( $post ) $post_type = $post->post_type; } elseif ( isset( $_POST['post_type'] ) && post_type_exists( $_POST['post_type'] ) ) { $post_type = $_GET['post_type']; } elseif ( $action == 'add' && isset( $_GET['post_type'] ) && post_type_exists( $_GET['post_type'] ) ) { $post_type = $_GET['post_type']; } break; case 'edit' : if ( isset( $_GET['post_type'] ) && post_type_exists( $_GET['post_type'] ) ) $post_type = $_GET['post_type']; break; case 'edit-tags' : if ( isset( $_REQUEST['taxonomy'] ) && taxonomy_exists( $_REQUEST['taxonomy'] ) ) $taxonomy = $_REQUEST['taxonomy']; if ( isset( $_REQUEST['post_type'] ) && post_type_exists( $_REQUEST['post_type'] ) ) $post_type = $_REQUEST['post_type']; else if ( is_object_in_taxonomy( 'post', $taxonomy ? $taxonomy : 'post_tag' ) ) $post_type = 'post'; break; } } switch ( $base ) { case 'post' : if ( ! $post_type ) $post_type = 'post'; $id = $post_type; break; case 'edit' : if ( ! $post_type ) $post_type = 'post'; $id .= '-' . $post_type; break; case 'edit-tags' : if ( ! $taxonomy ) $taxonomy = 'post_tag'; $id = 'edit-' . $taxonomy; break; } if ( is_network_admin() ) { $id .= '-network'; $base .= '-network'; } elseif ( is_user_admin() ) { $id .= '-user'; $base .= '-user'; } if ( isset( self::$_registry[ $id ] ) ) return self::$_registry[ $id ]; $screen = new WP_Screen(); $screen->id = $id; $screen->base = $base; $screen->action = $action; $screen->post_type = $post_type; $screen->taxonomy = $taxonomy; $screen->is_user = is_user_admin(); $screen->is_network = is_network_admin(); self::$_registry[ $id ] = $screen; return $screen; } /** * Makes the screen object the current screen. * * @see set_current_screen() * @since 3.3.0 */ function set_current_screen() { global $current_screen, $taxnow, $typenow; $current_screen = $this; $taxnow = $this->taxonomy; $typenow = $this->post_type; $current_screen = apply_filters( 'current_screen', $current_screen ); } /** * Constructor * * @since 3.3.0 * @access private */ private function __construct() {} /** * Sets the old string-based contextual help for the screen. * * For backwards compatibility. * * @since 3.3.0 * * @param WP_Screen $screen A screen object. * @param string $help Help text. */ static function add_old_compat_help( $screen, $help ) { self::$_old_compat_help[ $screen->id ] = $help; } /** * Set the parent information for the screen. * This is called in admin-header.php after the menu parent for the screen has been determined. * * @since 3.3.0 * * @param string $parent_file The parent file of the screen. Typically the $parent_file global. */ function set_parentage( $parent_file ) { $this->parent_file = $parent_file; list( $this->parent_base ) = explode( '?', $parent_file ); $this->parent_base = str_replace( '.php', '', $this->parent_base ); } /** * Adds an option for the screen. * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add screen options. * * @since 3.3.0 * * @param string $option Option ID * @param mixed $args Option-dependent arguments. */ public function add_option( $option, $args = array() ) { $this->_options[ $option ] = $args; } /** * Gets the arguments for an option for the screen. * * @since 3.3.0 * * @param string */ public function get_option( $option, $key = false ) { if ( ! isset( $this->_options[ $option ] ) ) return null; if ( $key ) { if ( isset( $this->_options[ $option ][ $key ] ) ) return $this->_options[ $option ][ $key ]; return null; } return $this->_options[ $option ]; } /** * Add a help tab to the contextual help for the screen. * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add contextual help tabs. * * @since 3.3.0 * * @param array $args * - string - title - Title for the tab. * - string - id - Tab ID. Must be HTML-safe. * - string - content - Help tab content in plain text or HTML. Optional. * - callback - callback - A callback to generate the tab content. Optional. * */ public function add_help_tab( $args ) { $defaults = array( 'title' => false, 'id' => false, 'content' => '', 'callback' => false, ); $args = wp_parse_args( $args, $defaults ); $args['id'] = sanitize_html_class( $args['id'] ); // Ensure we have an ID and title. if ( ! $args['id'] || ! $args['title'] ) return; $this->_help_tabs[] = $args; } /** * Add a sidebar to the contextual help for the screen. * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add a sidebar to the contextual help. * * @since 3.3.0 * * @param string $content Sidebar content in plain text or HTML. */ public function add_help_sidebar( $content ) { $this->_help_sidebar = $content; } /** * Render the screen's help section. * * This will trigger the deprecated filters for backwards compatibility. * * @since 3.3.0 */ public function render_screen_meta() { // Call old contextual_help_list filter. self::$_old_compat_help = apply_filters( 'contextual_help_list', self::$_old_compat_help, $this ); if ( isset( self::$_old_compat_help[ $this->id ] ) || empty($this->_help_tabs ) ) { // Call old contextual_help filter. if ( isset( self::$_old_compat_help[ $this->id ] ) ) $contextual_help = apply_filters( 'contextual_help', self::$_old_compat_help[ $this->id ], $this->id, $this ); if ( empty( $contextual_help ) ) { $default_help = __( 'Documentation' ); $default_help .= '
'; $default_help .= __( 'Support Forums' ); $contextual_help = '

' . apply_filters( 'default_contextual_help', $default_help ) . '

'; } $this->add_help_tab( array( 'id' => 'contextual-help', 'title' => __('Screen Info'), 'content' => $contextual_help, ) ); } // Add screen options tab if ( $this->show_screen_options() ) { $this->add_help_tab( array( 'id' => 'screen-options', 'title' => __('Screen Options'), 'callback' => array( $this, 'render_screen_options' ), ) ); $_options_tab = array_pop( $this->_help_tabs ); array_unshift( $this->_help_tabs, $_options_tab ); } // Time to render! ?>

_show_screen_options ) ) return $this->_show_screen_options; $columns = get_column_headers( $this ); $show_screen = ! empty( $wp_meta_boxes[ $this->id ] ) || $columns || $this->get_option( 'per_page' ); $this->_screen_settings = apply_filters( 'screen_settings', '', $this ); switch ( $this->id ) { case 'widgets': $this->_screen_settings = '

' . __('Enable accessibility mode') . '' . __('Disable accessibility mode') . "

\n"; break; } if ( $this->_screen_settings || $this->_options ) $show_screen = true; $this->_show_screen_options = apply_filters( 'screen_options_show_screen', $show_screen, $this ); return $this->_show_screen_options; } /** * Render the screen options tab. * * @since 3.3.0 */ public function render_screen_options() { global $wp_meta_boxes, $wp_list_table; $columns = get_column_headers( $this ); $hidden = get_hidden_columns( $this ); ?> id, $this ); if ( ! empty( $columns ) && isset( $columns[ $this->id ] ) ) $this->add_option( 'layout_columns', array('max' => $columns[ $this->id ] ) ); if ( ! $this->get_option('layout_columns') ) { $screen_layout_columns = 0; return; } $screen_layout_columns = get_user_option("screen_layout_$this->id"); $num = $this->get_option( 'layout_columns', 'max' ); if ( ! $screen_layout_columns || 'auto' == $screen_layout_columns ) { if ( $this->get_option( 'layout_columns', 'default' ) ) $screen_layout_columns = $this->get_option( 'layout_columns', 'default' ); } ?>

get_option( 'per_page' ) ) return; $per_page_label = $this->get_option( 'per_page', 'label' ); $option = $this->get_option( 'per_page', 'option' ); if ( ! $option ) $option = str_replace( '-', '_', "{$this->id}_per_page" ); $per_page = (int) get_user_option( $option ); if ( empty( $per_page ) || $per_page < 1 ) { $per_page = $this->get_option( 'per_page', 'default' ); if ( ! $per_page ) $per_page = 20; } if ( 'edit_comments_per_page' == $option ) { $comment_status = isset( $_REQUEST['comment_status'] ) ? $_REQUEST['comment_status'] : 'all'; $per_page = apply_filters( 'comments_per_page', $per_page, $comment_status ); } elseif ( 'categories_per_page' == $option ) { $per_page = apply_filters( 'edit_categories_per_page', $per_page ); } else { $per_page = apply_filters( $option, $per_page ); } // Back compat if ( isset( $this->post_type ) ) $per_page = apply_filters( 'edit_posts_per_page', $per_page, $this->post_type ); ?>