wp/wp-admin/includes/screen.php
author ymh <ymh.work@gmail.com>
Thu, 07 Nov 2013 00:08:07 +0000
changeset 1 f6eb5a861d2f
parent 0 d970ebf37754
child 5 5e2f62d02dcd
permissions -rw-r--r--
remove unnessary files. Make timthumb work
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
 * WordPress Administration Screen API.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
 * @package WordPress
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
 * @subpackage Administration
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
 * Get the column headers for a screen
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
 * @param string|WP_Screen $screen The screen you want the headers for
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
 * @return array Containing the headers in the format id => UI String
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
function get_column_headers( $screen ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
	if ( is_string( $screen ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
		$screen = convert_to_screen( $screen );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
	static $column_headers = array();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
	if ( ! isset( $column_headers[ $screen->id ] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
		$column_headers[ $screen->id ] = apply_filters( 'manage_' . $screen->id . '_columns', array() );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
	return $column_headers[ $screen->id ];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
 * Get a list of hidden columns.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
 * @param string|WP_Screen $screen The screen you want the hidden columns for
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
 * @return array
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
function get_hidden_columns( $screen ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
	if ( is_string( $screen ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
		$screen = convert_to_screen( $screen );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
	return (array) get_user_option( 'manage' . $screen->id . 'columnshidden' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
 * Prints the meta box preferences for screen meta.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
 * @param string|WP_Screen $screen
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
function meta_box_prefs( $screen ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
	global $wp_meta_boxes;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
	if ( is_string( $screen ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
		$screen = convert_to_screen( $screen );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
	if ( empty($wp_meta_boxes[$screen->id]) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
		return;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
	$hidden = get_hidden_meta_boxes($screen);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
	foreach ( array_keys($wp_meta_boxes[$screen->id]) as $context ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
		foreach ( array_keys($wp_meta_boxes[$screen->id][$context]) as $priority ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
			foreach ( $wp_meta_boxes[$screen->id][$context][$priority] as $box ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
				if ( false == $box || ! $box['title'] )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
					continue;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
				// Submit box cannot be hidden
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
				if ( 'submitdiv' == $box['id'] || 'linksubmitdiv' == $box['id'] )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
					continue;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
				$box_id = $box['id'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
				echo '<label for="' . $box_id . '-hide">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
				echo '<input class="hide-postbox-tog" name="' . $box_id . '-hide" type="checkbox" id="' . $box_id . '-hide" value="' . $box_id . '"' . (! in_array($box_id, $hidden) ? ' checked="checked"' : '') . ' />';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
				echo "{$box['title']}</label>\n";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
			}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
 * Get Hidden Meta Boxes
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
 * @param string|WP_Screen $screen Screen identifier
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
 * @return array Hidden Meta Boxes
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    86
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    87
function get_hidden_meta_boxes( $screen ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    88
	if ( is_string( $screen ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
		$screen = convert_to_screen( $screen );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    91
	$hidden = get_user_option( "metaboxhidden_{$screen->id}" );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    92
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    93
	$use_defaults = ! is_array( $hidden );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    94
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    95
	// Hide slug boxes by default
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    96
	if ( $use_defaults ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    97
		$hidden = array();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    98
		if ( 'post' == $screen->base ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    99
			if ( 'post' == $screen->post_type || 'page' == $screen->post_type || 'attachment' == $screen->post_type )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   100
				$hidden = array('slugdiv', 'trackbacksdiv', 'postcustom', 'postexcerpt', 'commentstatusdiv', 'commentsdiv', 'authordiv', 'revisionsdiv');
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
			else
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
				$hidden = array( 'slugdiv' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   103
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   104
		$hidden = apply_filters( 'default_hidden_meta_boxes', $hidden, $screen );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   105
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   106
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   107
	return apply_filters( 'hidden_meta_boxes', $hidden, $screen, $use_defaults );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   108
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   109
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   110
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   111
 * Register and configure an admin screen option
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   112
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   113
 * @since 3.1.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   114
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   115
 * @param string $option An option name.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   116
 * @param mixed $args Option-dependent arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   117
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   118
function add_screen_option( $option, $args = array() ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   119
	$current_screen = get_current_screen();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   120
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   121
	if ( ! $current_screen )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   122
		return;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   123
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   124
	$current_screen->add_option( $option, $args );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   125
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   126
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   127
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   128
 * Displays a screen icon.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   129
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   130
 * @uses get_screen_icon()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   131
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   132
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   133
 * @param string|WP_Screen $screen Optional. Accepts a screen object (and defaults to the current screen object)
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   134
 * 	which it uses to determine an icon HTML ID. Or, if a string is provided, it is used to form the icon HTML ID.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   135
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   136
function screen_icon( $screen = '' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   137
	echo get_screen_icon( $screen );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   138
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   139
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   140
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   141
 * Gets a screen icon.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   142
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   143
 * @since 3.2.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   144
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   145
 * @global $post_ID
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   146
 * @param string|WP_Screen $screen Optional. Accepts a screen object (and defaults to the current screen object)
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   147
 * 	which it uses to determine an icon HTML ID. Or, if a string is provided, it is used to form the icon HTML ID.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   148
 * @return string HTML for the screen icon.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   149
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   150
function get_screen_icon( $screen = '' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   151
	if ( empty( $screen ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   152
		$screen = get_current_screen();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   153
	elseif ( is_string( $screen ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   154
		$icon_id = $screen;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   155
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   156
	$class = 'icon32';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   157
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   158
	if ( empty( $icon_id ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   159
		if ( ! empty( $screen->parent_base ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   160
			$icon_id = $screen->parent_base;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   161
		else
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   162
			$icon_id = $screen->base;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   163
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   164
		if ( 'page' == $screen->post_type )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   165
			$icon_id = 'edit-pages';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   166
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   167
		if ( $screen->post_type )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   168
			$class .= ' ' . sanitize_html_class( 'icon32-posts-' . $screen->post_type );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   169
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   170
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   171
	return '<div id="icon-' . esc_attr( $icon_id ) . '" class="' . $class . '"><br /></div>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   172
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   173
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   174
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   175
 * Get the current screen object
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   176
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   177
 * @since 3.1.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   178
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   179
 * @return WP_Screen Current screen object
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   180
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   181
function get_current_screen() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   182
	global $current_screen;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   183
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   184
	if ( ! isset( $current_screen ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   185
		return null;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   186
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   187
	return $current_screen;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   188
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   189
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   190
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   191
 * Set the current screen object
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   192
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   193
 * @since 3.0.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   194
 * @uses $current_screen
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   195
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   196
 * @param mixed $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   197
 *	or an existing screen object.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   198
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   199
function set_current_screen( $hook_name = '' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   200
	WP_Screen::get( $hook_name )->set_current_screen();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   201
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   202
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   203
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   204
 * A class representing the admin screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   205
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   206
 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   207
 * @access public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   208
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   209
final class WP_Screen {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   210
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   211
	 * Any action associated with the screen. 'add' for *-add.php and *-new.php screens. Empty otherwise.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   212
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   213
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   214
	 * @var string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   215
	 * @access public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   216
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   217
	public $action;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   218
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   219
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   220
	 * The base type of the screen. This is typically the same as $id but with any post types and taxonomies stripped.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   221
	 * For example, for an $id of 'edit-post' the base is 'edit'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   222
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   223
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   224
	 * @var string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   225
	 * @access public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   226
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   227
	public $base;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   228
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   229
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   230
	 * The number of columns to display. Access with get_columns().
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   231
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   232
	 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   233
	 * @var int
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   234
	 * @access private
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   235
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   236
	private $columns = 0;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   237
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   238
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   239
	 * The unique ID of the screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   240
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   241
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   242
	 * @var string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   243
	 * @access public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   244
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   245
	public $id;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   246
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   247
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   248
	 * Which admin the screen is in. network | user | site | false
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   249
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   250
	 * @since 3.5.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   251
	 * @var string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   252
	 * @access protected
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   253
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   254
	protected $in_admin;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   255
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   256
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   257
	 * Whether the screen is in the network admin.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   258
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   259
	 * Deprecated. Use in_admin() instead.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   260
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   261
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   262
	 * @deprecated 3.5.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   263
	 * @var bool
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   264
	 * @access public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   265
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   266
	public $is_network;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   267
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   268
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   269
	 * Whether the screen is in the user admin.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   270
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   271
	 * Deprecated. Use in_admin() instead.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   272
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   273
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   274
	 * @deprecated 3.5.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   275
	 * @var bool
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   276
	 * @access public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   277
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   278
	public $is_user;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   279
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   280
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   281
	 * The base menu parent.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   282
	 * This is derived from $parent_file by removing the query string and any .php extension.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   283
	 * $parent_file values of 'edit.php?post_type=page' and 'edit.php?post_type=post' have a $parent_base of 'edit'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   284
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   285
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   286
	 * @var string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   287
	 * @access public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   288
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   289
	public $parent_base;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   290
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   291
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   292
	 * The parent_file for the screen per the admin menu system.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   293
	 * Some $parent_file values are 'edit.php?post_type=page', 'edit.php', and 'options-general.php'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   294
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   295
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   296
	 * @var string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   297
	 * @access public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   298
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   299
	public $parent_file;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   300
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   301
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   302
	 * The post type associated with the screen, if any.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   303
	 * The 'edit.php?post_type=page' screen has a post type of 'page'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   304
	 * The 'edit-tags.php?taxonomy=$taxonomy&post_type=page' screen has a post type of 'page'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   305
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   306
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   307
	 * @var string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   308
	 * @access public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   309
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   310
	public $post_type;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   311
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   312
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   313
	 * The taxonomy associated with the screen, if any.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   314
	 * The 'edit-tags.php?taxonomy=category' screen has a taxonomy of 'category'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   315
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   316
	 * @var string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   317
	 * @access public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   318
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   319
	public $taxonomy;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   320
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   321
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   322
	 * The help tab data associated with the screen, if any.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   323
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   324
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   325
	 * @var array
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   326
	 * @access private
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   327
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   328
	private $_help_tabs = array();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   329
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   330
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   331
	 * The help sidebar data associated with screen, if any.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   332
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   333
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   334
	 * @var string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   335
	 * @access private
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   336
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   337
	private $_help_sidebar = '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   338
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   339
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   340
	 * Stores old string-based help.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   341
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   342
	private static $_old_compat_help = array();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   343
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   344
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   345
	 * The screen options associated with screen, if any.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   346
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   347
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   348
	 * @var array
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   349
	 * @access private
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   350
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   351
	private $_options = array();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   352
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   353
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   354
	 * The screen object registry.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   355
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   356
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   357
	 * @var array
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   358
	 * @access private
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   359
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   360
	private static $_registry = array();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   361
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   362
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   363
	 * Stores the result of the public show_screen_options function.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   364
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   365
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   366
	 * @var bool
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   367
	 * @access private
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   368
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   369
	private $_show_screen_options;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   370
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   371
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   372
	 * Stores the 'screen_settings' section of screen options.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   373
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   374
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   375
	 * @var string
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   376
	 * @access private
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   377
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   378
	private $_screen_settings;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   379
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   380
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   381
	 * Fetches a screen object.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   382
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   383
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   384
	 * @access public
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   385
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   386
	 * @param string $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   387
	 * 	Defaults to the current $hook_suffix global.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   388
	 * @return WP_Screen Screen object.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   389
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   390
	public static function get( $hook_name = '' ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   391
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   392
		if ( is_a( $hook_name, 'WP_Screen' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   393
			return $hook_name;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   394
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   395
		$post_type = $taxonomy = null;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   396
		$in_admin = false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   397
		$action = '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   398
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   399
		if ( $hook_name )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   400
			$id = $hook_name;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   401
		else
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   402
			$id = $GLOBALS['hook_suffix'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   403
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   404
		// For those pesky meta boxes.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   405
		if ( $hook_name && post_type_exists( $hook_name ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   406
			$post_type = $id;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   407
			$id = 'post'; // changes later. ends up being $base.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   408
		} else {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   409
			if ( '.php' == substr( $id, -4 ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   410
				$id = substr( $id, 0, -4 );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   411
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   412
			if ( 'post-new' == $id || 'link-add' == $id || 'media-new' == $id || 'user-new' == $id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   413
				$id = substr( $id, 0, -4 );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   414
				$action = 'add';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   415
			}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   416
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   417
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   418
		if ( ! $post_type && $hook_name ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   419
			if ( '-network' == substr( $id, -8 ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   420
				$id = substr( $id, 0, -8 );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   421
				$in_admin = 'network';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   422
			} elseif ( '-user' == substr( $id, -5 ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   423
				$id = substr( $id, 0, -5 );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   424
				$in_admin = 'user';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   425
			}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   426
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   427
			$id = sanitize_key( $id );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   428
			if ( 'edit-comments' != $id && 'edit-tags' != $id && 'edit-' == substr( $id, 0, 5 ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   429
				$maybe = substr( $id, 5 );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   430
				if ( taxonomy_exists( $maybe ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   431
					$id = 'edit-tags';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   432
					$taxonomy = $maybe;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   433
				} elseif ( post_type_exists( $maybe ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   434
					$id = 'edit';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   435
					$post_type = $maybe;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   436
				}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   437
			}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   438
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   439
			if ( ! $in_admin )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   440
				$in_admin = 'site';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   441
		} else {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   442
			if ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   443
				$in_admin = 'network';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   444
			elseif ( defined( 'WP_USER_ADMIN' ) && WP_USER_ADMIN )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   445
				$in_admin = 'user';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   446
			else
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   447
				$in_admin = 'site';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   448
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   449
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   450
		if ( 'index' == $id )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   451
			$id = 'dashboard';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   452
		elseif ( 'front' == $id )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   453
			$in_admin = false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   454
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   455
		$base = $id;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   456
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   457
		// If this is the current screen, see if we can be more accurate for post types and taxonomies.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   458
		if ( ! $hook_name ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   459
			if ( isset( $_REQUEST['post_type'] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   460
				$post_type = post_type_exists( $_REQUEST['post_type'] ) ? $_REQUEST['post_type'] : false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   461
			if ( isset( $_REQUEST['taxonomy'] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   462
				$taxonomy = taxonomy_exists( $_REQUEST['taxonomy'] ) ? $_REQUEST['taxonomy'] : false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   463
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   464
			switch ( $base ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   465
				case 'post' :
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   466
					if ( isset( $_GET['post'] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   467
						$post_id = (int) $_GET['post'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   468
					elseif ( isset( $_POST['post_ID'] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   469
						$post_id = (int) $_POST['post_ID'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   470
					else
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   471
						$post_id = 0;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   472
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   473
					if ( $post_id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   474
						$post = get_post( $post_id );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   475
						if ( $post )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   476
							$post_type = $post->post_type;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   477
					}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   478
					break;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   479
				case 'edit-tags' :
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   480
					if ( null === $post_type && is_object_in_taxonomy( 'post', $taxonomy ? $taxonomy : 'post_tag' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   481
						$post_type = 'post';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   482
					break;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   483
			}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   484
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   485
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   486
		switch ( $base ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   487
			case 'post' :
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   488
				if ( null === $post_type )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   489
					$post_type = 'post';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   490
				$id = $post_type;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   491
				break;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   492
			case 'edit' :
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   493
				if ( null === $post_type )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   494
					$post_type = 'post';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   495
				$id .= '-' . $post_type;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   496
				break;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   497
			case 'edit-tags' :
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   498
				if ( null === $taxonomy )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   499
					$taxonomy = 'post_tag';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   500
				// The edit-tags ID does not contain the post type. Look for it in the request.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   501
				if ( null === $post_type ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   502
					$post_type = 'post';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   503
					if ( isset( $_REQUEST['post_type'] ) && post_type_exists( $_REQUEST['post_type'] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   504
						$post_type = $_REQUEST['post_type'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   505
				}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   506
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   507
				$id = 'edit-' . $taxonomy;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   508
				break;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   509
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   510
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   511
		if ( 'network' == $in_admin ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   512
			$id   .= '-network';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   513
			$base .= '-network';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   514
		} elseif ( 'user' == $in_admin ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   515
			$id   .= '-user';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   516
			$base .= '-user';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   517
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   518
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   519
		if ( isset( self::$_registry[ $id ] ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   520
			$screen = self::$_registry[ $id ];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   521
			if ( $screen === get_current_screen() )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   522
				return $screen;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   523
		} else {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   524
			$screen = new WP_Screen();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   525
			$screen->id     = $id;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   526
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   527
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   528
		$screen->base       = $base;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   529
		$screen->action     = $action;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   530
		$screen->post_type  = (string) $post_type;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   531
		$screen->taxonomy   = (string) $taxonomy;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   532
		$screen->is_user    = ( 'user' == $in_admin );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   533
		$screen->is_network = ( 'network' == $in_admin );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   534
		$screen->in_admin   = $in_admin;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   535
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   536
		self::$_registry[ $id ] = $screen;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   537
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   538
		return $screen;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   539
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   540
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   541
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   542
	 * Makes the screen object the current screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   543
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   544
	 * @see set_current_screen()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   545
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   546
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   547
	function set_current_screen() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   548
		global $current_screen, $taxnow, $typenow;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   549
		$current_screen = $this;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   550
		$taxnow = $this->taxonomy;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   551
		$typenow = $this->post_type;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   552
		do_action( 'current_screen', $current_screen );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   553
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   554
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   555
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   556
	 * Constructor
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   557
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   558
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   559
	 * @access private
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   560
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   561
	private function __construct() {}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   562
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   563
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   564
	 * Indicates whether the screen is in a particular admin
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   565
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   566
	 * @since 3.5.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   567
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   568
	 * @param string $admin The admin to check against (network | user | site).
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   569
	 * If empty any of the three admins will result in true.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   570
	 * @return boolean True if the screen is in the indicated admin, false otherwise.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   571
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   572
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   573
	public function in_admin( $admin = null ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   574
		if ( empty( $admin ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   575
			return (bool) $this->in_admin;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   576
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   577
		return ( $admin == $this->in_admin );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   578
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   579
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   580
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   581
	 * Sets the old string-based contextual help for the screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   582
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   583
	 * For backwards compatibility.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   584
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   585
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   586
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   587
	 * @param WP_Screen $screen A screen object.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   588
	 * @param string $help Help text.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   589
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   590
	static function add_old_compat_help( $screen, $help ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   591
		self::$_old_compat_help[ $screen->id ] = $help;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   592
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   593
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   594
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   595
	 * Set the parent information for the screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   596
	 * This is called in admin-header.php after the menu parent for the screen has been determined.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   597
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   598
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   599
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   600
	 * @param string $parent_file The parent file of the screen. Typically the $parent_file global.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   601
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   602
	function set_parentage( $parent_file ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   603
		$this->parent_file = $parent_file;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   604
		list( $this->parent_base ) = explode( '?', $parent_file );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   605
		$this->parent_base = str_replace( '.php', '', $this->parent_base );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   606
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   607
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   608
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   609
	 * Adds an option for the screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   610
	 * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add screen options.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   611
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   612
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   613
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   614
	 * @param string $option Option ID
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   615
	 * @param mixed $args Option-dependent arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   616
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   617
	public function add_option( $option, $args = array() ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   618
		$this->_options[ $option ] = $args;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   619
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   620
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   621
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   622
	 * Gets the arguments for an option for the screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   623
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   624
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   625
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   626
	 * @param string $option Option ID.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   627
	 * @param mixed $key Optional. Specific array key for when the option is an array.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   628
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   629
	public function get_option( $option, $key = false ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   630
		if ( ! isset( $this->_options[ $option ] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   631
			return null;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   632
		if ( $key ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   633
			if ( isset( $this->_options[ $option ][ $key ] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   634
				return $this->_options[ $option ][ $key ];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   635
			return null;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   636
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   637
		return $this->_options[ $option ];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   638
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   639
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   640
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   641
	 * Gets the help tabs registered for the screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   642
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   643
	 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   644
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   645
	 * @return array Help tabs with arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   646
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   647
	public function get_help_tabs() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   648
		return $this->_help_tabs;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   649
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   650
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   651
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   652
	 * Gets the arguments for a help tab.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   653
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   654
	 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   655
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   656
	 * @param string $id Help Tab ID.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   657
	 * @return array Help tab arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   658
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   659
	public function get_help_tab( $id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   660
		if ( ! isset( $this->_help_tabs[ $id ] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   661
			return null;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   662
		return $this->_help_tabs[ $id ];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   663
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   664
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   665
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   666
	 * Add a help tab to the contextual help for the screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   667
	 * Call this on the load-$pagenow hook for the relevant screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   668
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   669
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   670
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   671
	 * @param array $args
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   672
	 * - string   - title    - Title for the tab.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   673
	 * - string   - id       - Tab ID. Must be HTML-safe.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   674
	 * - string   - content  - Help tab content in plain text or HTML. Optional.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   675
	 * - callback - callback - A callback to generate the tab content. Optional.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   676
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   677
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   678
	public function add_help_tab( $args ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   679
		$defaults = array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   680
			'title'    => false,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   681
			'id'       => false,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   682
			'content'  => '',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   683
			'callback' => false,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   684
		);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   685
		$args = wp_parse_args( $args, $defaults );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   686
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   687
		$args['id'] = sanitize_html_class( $args['id'] );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   688
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   689
		// Ensure we have an ID and title.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   690
		if ( ! $args['id'] || ! $args['title'] )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   691
			return;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   692
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   693
		// Allows for overriding an existing tab with that ID.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   694
		$this->_help_tabs[ $args['id'] ] = $args;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   695
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   696
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   697
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   698
	 * Removes a help tab from the contextual help for the screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   699
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   700
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   701
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   702
	 * @param string $id The help tab ID.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   703
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   704
	public function remove_help_tab( $id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   705
		unset( $this->_help_tabs[ $id ] );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   706
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   707
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   708
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   709
	 * Removes all help tabs from the contextual help for the screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   710
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   711
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   712
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   713
	public function remove_help_tabs() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   714
		$this->_help_tabs = array();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   715
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   716
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   717
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   718
	 * Gets the content from a contextual help sidebar.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   719
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   720
	 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   721
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   722
	 * @return string Contents of the help sidebar.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   723
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   724
	public function get_help_sidebar() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   725
		return $this->_help_sidebar;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   726
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   727
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   728
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   729
	 * Add a sidebar to the contextual help for the screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   730
	 * 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.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   731
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   732
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   733
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   734
	 * @param string $content Sidebar content in plain text or HTML.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   735
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   736
	public function set_help_sidebar( $content ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   737
		$this->_help_sidebar = $content;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   738
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   739
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   740
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   741
	 * Gets the number of layout columns the user has selected.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   742
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   743
	 * The layout_columns option controls the max number and default number of
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   744
	 * columns. This method returns the number of columns within that range selected
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   745
	 * by the user via Screen Options. If no selection has been made, the default
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   746
	 * provisioned in layout_columns is returned. If the screen does not support
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   747
	 * selecting the number of layout columns, 0 is returned.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   748
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   749
	 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   750
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   751
	 * @return int Number of columns to display.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   752
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   753
	public function get_columns() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   754
		return $this->columns;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   755
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   756
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   757
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   758
	 * Render the screen's help section.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   759
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   760
	 * This will trigger the deprecated filters for backwards compatibility.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   761
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   762
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   763
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   764
	public function render_screen_meta() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   765
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   766
		// Call old contextual_help_list filter.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   767
		self::$_old_compat_help = apply_filters( 'contextual_help_list', self::$_old_compat_help, $this );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   768
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   769
		$old_help = isset( self::$_old_compat_help[ $this->id ] ) ? self::$_old_compat_help[ $this->id ] : '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   770
		$old_help = apply_filters( 'contextual_help', $old_help, $this->id, $this );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   771
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   772
		// Default help only if there is no old-style block of text and no new-style help tabs.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   773
		if ( empty( $old_help ) && ! $this->get_help_tabs() ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   774
			$default_help = apply_filters( 'default_contextual_help', '' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   775
			if ( $default_help )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   776
				$old_help = '<p>' . $default_help . '</p>';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   777
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   778
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   779
		if ( $old_help ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   780
			$this->add_help_tab( array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   781
				'id'      => 'old-contextual-help',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   782
				'title'   => __('Overview'),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   783
				'content' => $old_help,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   784
			) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   785
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   786
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   787
		$help_sidebar = $this->get_help_sidebar();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   788
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   789
		$help_class = 'hidden';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   790
		if ( ! $help_sidebar )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   791
			$help_class .= ' no-sidebar';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   792
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   793
		// Time to render!
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   794
		?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   795
		<div id="screen-meta" class="metabox-prefs">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   796
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   797
			<div id="contextual-help-wrap" class="<?php echo esc_attr( $help_class ); ?>" tabindex="-1" aria-label="<?php esc_attr_e('Contextual Help Tab'); ?>">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   798
				<div id="contextual-help-back"></div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   799
				<div id="contextual-help-columns">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   800
					<div class="contextual-help-tabs">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   801
						<ul>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   802
						<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   803
						$class = ' class="active"';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   804
						foreach ( $this->get_help_tabs() as $tab ) :
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   805
							$link_id  = "tab-link-{$tab['id']}";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   806
							$panel_id = "tab-panel-{$tab['id']}";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   807
							?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   808
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   809
							<li id="<?php echo esc_attr( $link_id ); ?>"<?php echo $class; ?>>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   810
								<a href="<?php echo esc_url( "#$panel_id" ); ?>" aria-controls="<?php echo esc_attr( $panel_id ); ?>">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   811
									<?php echo esc_html( $tab['title'] ); ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   812
								</a>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   813
							</li>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   814
						<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   815
							$class = '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   816
						endforeach;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   817
						?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   818
						</ul>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   819
					</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   820
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   821
					<?php if ( $help_sidebar ) : ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   822
					<div class="contextual-help-sidebar">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   823
						<?php echo $help_sidebar; ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   824
					</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   825
					<?php endif; ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   826
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   827
					<div class="contextual-help-tabs-wrap">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   828
						<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   829
						$classes = 'help-tab-content active';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   830
						foreach ( $this->get_help_tabs() as $tab ):
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   831
							$panel_id = "tab-panel-{$tab['id']}";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   832
							?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   833
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   834
							<div id="<?php echo esc_attr( $panel_id ); ?>" class="<?php echo $classes; ?>">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   835
								<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   836
								// Print tab content.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   837
								echo $tab['content'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   838
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   839
								// If it exists, fire tab callback.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   840
								if ( ! empty( $tab['callback'] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   841
									call_user_func_array( $tab['callback'], array( $this, $tab ) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   842
								?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   843
							</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   844
						<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   845
							$classes = 'help-tab-content';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   846
						endforeach;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   847
						?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   848
					</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   849
				</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   850
			</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   851
		<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   852
		// Setup layout columns
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   853
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   854
		// Back compat for plugins using the filter instead of add_screen_option()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   855
		$columns = apply_filters( 'screen_layout_columns', array(), $this->id, $this );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   856
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   857
		if ( ! empty( $columns ) && isset( $columns[ $this->id ] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   858
			$this->add_option( 'layout_columns', array('max' => $columns[ $this->id ] ) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   859
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   860
		if ( $this->get_option( 'layout_columns' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   861
			$this->columns = (int) get_user_option("screen_layout_$this->id");
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   862
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   863
			if ( ! $this->columns && $this->get_option( 'layout_columns', 'default' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   864
				$this->columns = $this->get_option( 'layout_columns', 'default' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   865
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   866
		$GLOBALS[ 'screen_layout_columns' ] = $this->columns; // Set the global for back-compat.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   867
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   868
		// Add screen options
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   869
		if ( $this->show_screen_options() )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   870
			$this->render_screen_options();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   871
		?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   872
		</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   873
		<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   874
		if ( ! $this->get_help_tabs() && ! $this->show_screen_options() )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   875
			return;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   876
		?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   877
		<div id="screen-meta-links">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   878
		<?php if ( $this->get_help_tabs() ) : ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   879
			<div id="contextual-help-link-wrap" class="hide-if-no-js screen-meta-toggle">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   880
			<a href="#contextual-help-wrap" id="contextual-help-link" class="show-settings" aria-controls="contextual-help-wrap" aria-expanded="false"><?php _e( 'Help' ); ?></a>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   881
			</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   882
		<?php endif;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   883
		if ( $this->show_screen_options() ) : ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   884
			<div id="screen-options-link-wrap" class="hide-if-no-js screen-meta-toggle">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   885
			<a href="#screen-options-wrap" id="show-settings-link" class="show-settings" aria-controls="screen-options-wrap" aria-expanded="false"><?php _e( 'Screen Options' ); ?></a>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   886
			</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   887
		<?php endif; ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   888
		</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   889
		<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   890
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   891
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   892
	public function show_screen_options() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   893
		global $wp_meta_boxes;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   894
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   895
		if ( is_bool( $this->_show_screen_options ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   896
			return $this->_show_screen_options;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   897
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   898
		$columns = get_column_headers( $this );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   899
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   900
		$show_screen = ! empty( $wp_meta_boxes[ $this->id ] ) || $columns || $this->get_option( 'per_page' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   901
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   902
		switch ( $this->id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   903
			case 'widgets':
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   904
				$this->_screen_settings = '<p><a id="access-on" href="widgets.php?widgets-access=on">' . __('Enable accessibility mode') . '</a><a id="access-off" href="widgets.php?widgets-access=off">' . __('Disable accessibility mode') . "</a></p>\n";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   905
				break;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   906
			default:
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   907
				$this->_screen_settings = '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   908
				break;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   909
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   910
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   911
		$this->_screen_settings = apply_filters( 'screen_settings', $this->_screen_settings, $this );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   912
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   913
		if ( $this->_screen_settings || $this->_options )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   914
			$show_screen = true;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   915
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   916
		$this->_show_screen_options = apply_filters( 'screen_options_show_screen', $show_screen, $this );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   917
		return $this->_show_screen_options;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   918
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   919
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   920
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   921
	 * Render the screen options tab.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   922
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   923
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   924
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   925
	public function render_screen_options() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   926
		global $wp_meta_boxes, $wp_list_table;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   927
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   928
		$columns = get_column_headers( $this );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   929
		$hidden  = get_hidden_columns( $this );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   930
		$post    = get_post();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   931
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   932
		?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   933
		<div id="screen-options-wrap" class="hidden" tabindex="-1" aria-label="<?php esc_attr_e('Screen Options Tab'); ?>">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   934
		<form id="adv-settings" action="" method="post">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   935
		<?php if ( isset( $wp_meta_boxes[ $this->id ] ) || $this->get_option( 'per_page' ) || ( $columns && empty( $columns['_title'] ) ) ) : ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   936
			<h5><?php _e( 'Show on screen' ); ?></h5>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   937
		<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   938
		endif;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   939
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   940
		if ( isset( $wp_meta_boxes[ $this->id ] ) ) : ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   941
			<div class="metabox-prefs">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   942
				<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   943
					meta_box_prefs( $this );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   944
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   945
					if ( 'dashboard' === $this->id && has_action( 'welcome_panel' ) && current_user_can( 'edit_theme_options' ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   946
						if ( isset( $_GET['welcome'] ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   947
							$welcome_checked = empty( $_GET['welcome'] ) ? 0 : 1;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   948
							update_user_meta( get_current_user_id(), 'show_welcome_panel', $welcome_checked );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   949
						} else {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   950
							$welcome_checked = get_user_meta( get_current_user_id(), 'show_welcome_panel', true );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   951
							if ( 2 == $welcome_checked && wp_get_current_user()->user_email != get_option( 'admin_email' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   952
								$welcome_checked = false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   953
						}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   954
						echo '<label for="wp_welcome_panel-hide">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   955
						echo '<input type="checkbox" id="wp_welcome_panel-hide"' . checked( (bool) $welcome_checked, true, false ) . ' />';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   956
						echo _x( 'Welcome', 'Welcome panel' ) . "</label>\n";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   957
					}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   958
				?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   959
				<br class="clear" />
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   960
			</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   961
			<?php endif;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   962
			if ( $columns ) :
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   963
				if ( ! empty( $columns['_title'] ) ) : ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   964
			<h5><?php echo $columns['_title']; ?></h5>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   965
			<?php endif; ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   966
			<div class="metabox-prefs">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   967
				<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   968
				$special = array('_title', 'cb', 'comment', 'media', 'name', 'title', 'username', 'blogname');
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   969
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   970
				foreach ( $columns as $column => $title ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   971
					// Can't hide these for they are special
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   972
					if ( in_array( $column, $special ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   973
						continue;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   974
					if ( empty( $title ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   975
						continue;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   976
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   977
					if ( 'comments' == $column )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   978
						$title = __( 'Comments' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   979
					$id = "$column-hide";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   980
					echo '<label for="' . $id . '">';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   981
					echo '<input class="hide-column-tog" name="' . $id . '" type="checkbox" id="' . $id . '" value="' . $column . '"' . checked( !in_array($column, $hidden), true, false ) . ' />';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   982
					echo "$title</label>\n";
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   983
				}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   984
				?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   985
				<br class="clear" />
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   986
			</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   987
		<?php endif;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   988
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   989
		$this->render_screen_layout();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   990
		$this->render_per_page_options();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   991
		echo $this->_screen_settings;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   992
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   993
		?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   994
		<div><?php wp_nonce_field( 'screen-options-nonce', 'screenoptionnonce', false ); ?></div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   995
		</form>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   996
		</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   997
		<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   998
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   999
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1000
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1001
	 * Render the option for number of columns on the page
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1002
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1003
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1004
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1005
	function render_screen_layout() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1006
		if ( ! $this->get_option('layout_columns') )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1007
			return;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1008
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1009
		$screen_layout_columns = $this->get_columns();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1010
		$num = $this->get_option( 'layout_columns', 'max' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1011
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1012
		?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1013
		<h5 class="screen-layout"><?php _e('Screen Layout'); ?></h5>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1014
		<div class='columns-prefs'><?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1015
			_e('Number of Columns:');
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1016
			for ( $i = 1; $i <= $num; ++$i ):
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1017
				?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1018
				<label class="columns-prefs-<?php echo $i; ?>">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1019
					<input type='radio' name='screen_columns' value='<?php echo esc_attr( $i ); ?>'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1020
						<?php checked( $screen_layout_columns, $i ); ?> />
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1021
					<?php echo esc_html( $i ); ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1022
				</label>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1023
				<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1024
			endfor; ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1025
		</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1026
		<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1027
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1028
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1029
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1030
	 * Render the items per page option
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1031
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1032
	 * @since 3.3.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1033
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1034
	function render_per_page_options() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1035
		if ( ! $this->get_option( 'per_page' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1036
			return;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1037
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1038
		$per_page_label = $this->get_option( 'per_page', 'label' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1039
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1040
		$option = $this->get_option( 'per_page', 'option' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1041
		if ( ! $option )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1042
			$option = str_replace( '-', '_', "{$this->id}_per_page" );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1043
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1044
		$per_page = (int) get_user_option( $option );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1045
		if ( empty( $per_page ) || $per_page < 1 ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1046
			$per_page = $this->get_option( 'per_page', 'default' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1047
			if ( ! $per_page )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1048
				$per_page = 20;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1049
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1050
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1051
		if ( 'edit_comments_per_page' == $option ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1052
			$comment_status = isset( $_REQUEST['comment_status'] ) ? $_REQUEST['comment_status'] : 'all';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1053
			$per_page = apply_filters( 'comments_per_page', $per_page, $comment_status );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1054
		} elseif ( 'categories_per_page' == $option ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1055
			$per_page = apply_filters( 'edit_categories_per_page', $per_page );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1056
		} else {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1057
			$per_page = apply_filters( $option, $per_page );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1058
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1059
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1060
		// Back compat
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1061
		if ( isset( $this->post_type ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1062
			$per_page = apply_filters( 'edit_posts_per_page', $per_page, $this->post_type );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1063
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1064
		?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1065
		<div class="screen-options">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1066
			<?php if ( $per_page_label ) : ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1067
				<input type="number" step="1" min="1" max="999" class="screen-per-page" name="wp_screen_options[value]"
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1068
					id="<?php echo esc_attr( $option ); ?>" maxlength="3"
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1069
					value="<?php echo esc_attr( $per_page ); ?>" />
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1070
				<label for="<?php echo esc_attr( $option ); ?>">
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1071
					<?php echo esc_html( $per_page_label ); ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1072
				</label>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1073
			<?php endif;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1074
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1075
			echo get_submit_button( __( 'Apply' ), 'button', 'screen-options-apply', false ); ?>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1076
			<input type='hidden' name='wp_screen_options[option]' value='<?php echo esc_attr($option); ?>' />
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1077
		</div>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1078
		<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1079
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
  1080
}