' . "\n";
- echo '
';
+ $hidden_class = in_array($box['id'], $hidden) ? ' hide-if-js' : '';
+ echo '
' . "\n";
+ echo '
';
echo "
{$box['title']} \n";
echo '
' . "\n";
call_user_func($box['callback'], $object, $box);
@@ -3043,21 +1000,24 @@ function remove_meta_box($id, $page, $context) {
/**
* {@internal Missing Short Description}}
*
- * @since unknown
+ * @since 2.7.0
*
- * @param unknown_type $page
+ * @param unknown_type $screen
*/
-function meta_box_prefs($page) {
+function meta_box_prefs($screen) {
global $wp_meta_boxes;
- if ( empty($wp_meta_boxes[$page]) )
+ if ( is_string($screen) )
+ $screen = convert_to_screen($screen);
+
+ if ( empty($wp_meta_boxes[$screen->id]) )
return;
- $hidden = get_hidden_meta_boxes($page);
+ $hidden = get_hidden_meta_boxes($screen);
- foreach ( array_keys($wp_meta_boxes[$page]) as $context ) {
- foreach ( array_keys($wp_meta_boxes[$page][$context]) as $priority ) {
- foreach ( $wp_meta_boxes[$page][$context][$priority] as $box ) {
+ foreach ( array_keys($wp_meta_boxes[$screen->id]) as $context ) {
+ foreach ( array_keys($wp_meta_boxes[$screen->id][$context]) as $priority ) {
+ foreach ( $wp_meta_boxes[$screen->id][$context][$priority] as $box ) {
if ( false == $box || ! $box['title'] )
continue;
// Submit box cannot be hidden
@@ -3072,12 +1032,27 @@ function meta_box_prefs($page) {
}
}
-function get_hidden_meta_boxes($page) {
- $hidden = (array) get_user_option( "meta-box-hidden_$page", 0, false );
+/**
+ * Get Hidden Meta Boxes
+ *
+ * @since 2.7.0
+ *
+ * @param string|object $screen Screen identifier
+ * @return array Hidden Meta Boxes
+ */
+function get_hidden_meta_boxes( $screen ) {
+ if ( is_string( $screen ) )
+ $screen = convert_to_screen( $screen );
+
+ $hidden = get_user_option( "metaboxhidden_{$screen->id}" );
// Hide slug boxes by default
- if ( empty($hidden[0]) ) {
- $hidden = array('slugdiv');
+ if ( !is_array( $hidden ) ) {
+ if ( 'post' == $screen->base || 'page' == $screen->base )
+ $hidden = array('slugdiv', 'trackbacksdiv', 'postcustom', 'postexcerpt', 'commentstatusdiv', 'commentsdiv', 'authordiv', 'revisionsdiv');
+ else
+ $hidden = array( 'slugdiv' );
+ $hidden = apply_filters('default_hidden_meta_boxes', $hidden, $screen);
}
return $hidden;
@@ -3086,16 +1061,31 @@ function get_hidden_meta_boxes($page) {
/**
* Add a new section to a settings page.
*
+ * Part of the Settings API. Use this to define new settings sections for an admin page.
+ * Show settings sections in your admin page callback function with do_settings_sections().
+ * Add settings fields to your section with add_settings_field()
+ *
+ * The $callback argument should be the name of a function that echoes out any
+ * content you want to show at the top of the settings section before the actual
+ * fields. It can output nothing if you want.
+ *
* @since 2.7.0
*
- * @param string $id String for use in the 'id' attribute of tags.
- * @param string $title Title of the section.
- * @param string $callback Function that fills the section with the desired content. The function should echo its output.
- * @param string $page The type of settings page on which to show the section (general, reading, writing, ...).
+ * @global $wp_settings_sections Storage array of all settings sections added to admin pages
+ *
+ * @param string $id Slug-name to identify the section. Used in the 'id' attribute of tags.
+ * @param string $title Formatted title of the section. Shown as the heading for the section.
+ * @param string $callback Function that echos out any content at the top of the section (between heading and fields).
+ * @param string $page The slug-name of the settings page on which to show the section. Built-in pages include 'general', 'reading', 'writing', 'discussion', 'media', etc. Create your own using add_options_page();
*/
function add_settings_section($id, $title, $callback, $page) {
global $wp_settings_sections;
+ if ( 'misc' == $page ) {
+ _deprecated_argument( __FUNCTION__, '3.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) );
+ $page = 'general';
+ }
+
if ( !isset($wp_settings_sections) )
$wp_settings_sections = array();
if ( !isset($wp_settings_sections[$page]) )
@@ -3107,20 +1097,35 @@ function add_settings_section($id, $title, $callback, $page) {
}
/**
- * Add a new field to a settings page.
+ * Add a new field to a section of a settings page
+ *
+ * Part of the Settings API. Use this to define a settings field that will show
+ * as part of a settings section inside a settings page. The fields are shown using
+ * do_settings_fields() in do_settings-sections()
+ *
+ * The $callback argument should be the name of a function that echoes out the
+ * html input tags for this setting field. Use get_option() to retrive existing
+ * values to show.
*
* @since 2.7.0
*
- * @param string $id String for use in the 'id' attribute of tags.
- * @param string $title Title of the field.
- * @param string $callback Function that fills the field with the desired content. The function should echo its output.
- * @param string $page The type of settings page on which to show the field (general, reading, writing, ...).
- * @param string $section The section of the settingss page in which to show the box (default, ...).
+ * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections
+ *
+ * @param string $id Slug-name to identify the field. Used in the 'id' attribute of tags.
+ * @param string $title Formatted title of the field. Shown as the label for the field during output.
+ * @param string $callback Function that fills the field with the desired form inputs. The function should echo its output.
+ * @param string $page The slug-name of the settings page on which to show the section (general, reading, writing, ...).
+ * @param string $section The slug-name of the section of the settingss page in which to show the box (default, ...).
* @param array $args Additional arguments
*/
function add_settings_field($id, $title, $callback, $page, $section = 'default', $args = array()) {
global $wp_settings_fields;
+ if ( 'misc' == $page ) {
+ _deprecated_argument( __FUNCTION__, '3.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) );
+ $page = 'general';
+ }
+
if ( !isset($wp_settings_fields) )
$wp_settings_fields = array();
if ( !isset($wp_settings_fields[$page]) )
@@ -3132,11 +1137,17 @@ function add_settings_field($id, $title, $callback, $page, $section = 'default',
}
/**
- * {@internal Missing Short Description}}
+ * Prints out all settings sections added to a particular settings page
*
- * @since unknown
+ * Part of the Settings API. Use this in a settings page callback function
+ * to output all the sections and fields that were added to that $page with
+ * add_settings_section() and add_settings_field()
*
- * @param unknown_type $page
+ * @global $wp_settings_sections Storage array of all settings sections added to admin pages
+ * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections
+ * @since 2.7.0
+ *
+ * @param string $page The slug name of the page whos settings sections you want to output
*/
function do_settings_sections($page) {
global $wp_settings_sections, $wp_settings_fields;
@@ -3156,12 +1167,18 @@ function do_settings_sections($page) {
}
/**
- * {@internal Missing Short Description}}
+ * Print out the settings fields for a particular settings section
+ *
+ * Part of the Settings API. Use this in a settings page to output
+ * a specific section. Should normally be called by do_settings_sections()
+ * rather than directly.
*
- * @since unknown
+ * @global $wp_settings_fields Storage array of settings fields and their pages/sections
*
- * @param unknown_type $page
- * @param unknown_type $section
+ * @since 2.7.0
+ *
+ * @param string $page Slug title of the admin page who's settings fields you want to show.
+ * @param section $section Slug title of the settings section who's fields you want to show.
*/
function do_settings_fields($page, $section) {
global $wp_settings_fields;
@@ -3183,37 +1200,139 @@ function do_settings_fields($page, $section) {
}
/**
- * {@internal Missing Short Description}}
+ * Register a settings error to be displayed to the user
+ *
+ * Part of the Settings API. Use this to show messages to users about settings validation
+ * problems, missing settings or anything else.
*
- * @since unknown
+ * Settings errors should be added inside the $sanitize_callback function defined in
+ * register_setting() for a given setting to give feedback about the submission.
*
- * @param unknown_type $page
+ * By default messages will show immediately after the submission that generated the error.
+ * Additional calls to settings_errors() can be used to show errors even when the settings
+ * page is first accessed.
+ *
+ * @since 3.0.0
+ *
+ * @global array $wp_settings_errors Storage array of errors registered during this pageload
+ *
+ * @param string $setting Slug title of the setting to which this error applies
+ * @param string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
+ * @param string $message The formatted message text to display to the user (will be shown inside styled
and
)
+ * @param string $type The type of message it is, controls HTML class. Use 'error' or 'updated'.
*/
-function manage_columns_prefs($page) {
- $columns = get_column_headers($page);
+function add_settings_error( $setting, $code, $message, $type = 'error' ) {
+ global $wp_settings_errors;
- $hidden = get_hidden_columns($page);
+ if ( !isset($wp_settings_errors) )
+ $wp_settings_errors = array();
- foreach ( $columns as $column => $title ) {
- // Can't hide these
- if ( 'cb' == $column || 'title' == $column || 'name' == $column || 'username' == $column || 'media' == $column || 'comment' == $column )
- continue;
- if ( empty($title) )
- continue;
+ $new_error = array(
+ 'setting' => $setting,
+ 'code' => $code,
+ 'message' => $message,
+ 'type' => $type
+ );
+ $wp_settings_errors[] = $new_error;
+}
- if ( 'comments' == $column )
- $title = __('Comments');
- $id = "$column-hide";
- echo '';
- echo ' \n";
+/**
+ * Fetch settings errors registered by add_settings_error()
+ *
+ * Checks the $wp_settings_errors array for any errors declared during the current
+ * pageload and returns them.
+ *
+ * If changes were just submitted ($_GET['settings-updated']) and settings errors were saved
+ * to the 'settings_errors' transient then those errors will be returned instead. This
+ * is used to pass errors back across pageloads.
+ *
+ * Use the $sanitize argument to manually re-sanitize the option before returning errors.
+ * This is useful if you have errors or notices you want to show even when the user
+ * hasn't submitted data (i.e. when they first load an options page, or in admin_notices action hook)
+ *
+ * @since 3.0.0
+ *
+ * @global array $wp_settings_errors Storage array of errors registered during this pageload
+ *
+ * @param string $setting Optional slug title of a specific setting who's errors you want.
+ * @param boolean $sanitize Whether to re-sanitize the setting value before returning errors.
+ * @return array Array of settings errors
+ */
+function get_settings_errors( $setting = '', $sanitize = FALSE ) {
+ global $wp_settings_errors;
+
+ // If $sanitize is true, manually re-run the sanitizisation for this option
+ // This allows the $sanitize_callback from register_setting() to run, adding
+ // any settings errors you want to show by default.
+ if ( $sanitize )
+ sanitize_option( $setting, get_option($setting));
+
+ // If settings were passed back from options.php then use them
+ // Ignore transients if $sanitize is true, we dont' want the old values anyway
+ if ( isset($_GET['settings-updated']) && $_GET['settings-updated'] && get_transient('settings_errors') ) {
+ $settings_errors = get_transient('settings_errors');
+ delete_transient('settings_errors');
+ // Otherwise check global in case validation has been run on this pageload
+ } elseif ( count( $wp_settings_errors ) ) {
+ $settings_errors = $wp_settings_errors;
+ } else {
+ return;
+ }
+
+ // Filter the results to those of a specific setting if one was set
+ if ( $setting ) {
+ foreach ( (array) $settings_errors as $key => $details )
+ if ( $setting != $details['setting'] )
+ unset( $settings_errors[$key] );
+ }
+ return $settings_errors;
+}
+
+/**
+ * Display settings errors registered by add_settings_error()
+ *
+ * Part of the Settings API. Outputs a
-
array(__('Edit Posts'), 'edit_posts'));
- break;
- case 'edit-pages.php':
- $default_action = array('page-new.php' => array(__('New Page'), 'edit_pages'));
- break;
- case 'page-new.php':
- $default_action = array('edit-pages.php' => array(__('Edit Pages'), 'edit_pages'));
- break;
- case 'upload.php':
- $default_action = array('media-new.php' => array(__('New Media'), 'upload_files'));
- break;
- case 'media-new.php':
- $default_action = array('upload.php' => array(__('Edit Media'), 'upload_files'));
- break;
- case 'link-manager.php':
- $default_action = array('link-add.php' => array(__('New Link'), 'manage_links'));
- break;
- case 'link-add.php':
- $default_action = array('link-manager.php' => array(__('Edit Links'), 'manage_links'));
- break;
- case 'users.php':
- $default_action = array('user-new.php' => array(__('New User'), 'create_users'));
- break;
- case 'user-new.php':
- $default_action = array('users.php' => array(__('Edit Users'), 'edit_users'));
- break;
- case 'plugins.php':
- $default_action = array('plugin-install.php' => array(__('Install Plugins'), 'install_plugins'));
- break;
- case 'plugin-install.php':
- $default_action = array('plugins.php' => array(__('Manage Plugins'), 'activate_plugins'));
- break;
- case 'themes.php':
- $default_action = array('theme-install.php' => array(__('Install Themes'), 'install_themes'));
- break;
- case 'theme-install.php':
- $default_action = array('themes.php' => array(__('Manage Themes'), 'switch_themes'));
- break;
- default:
- $default_action = array('post-new.php' => array(__('New Post'), 'edit_posts'));
- break;
+ $default_action = false;
+
+ if ( is_string($screen) )
+ $screen = convert_to_screen($screen);
+
+ if ( $screen->is_user )
+ return;
+
+ if ( isset($screen->post_type) ) {
+ $post_type_object = get_post_type_object($screen->post_type);
+ if ( 'add' != $screen->action )
+ $default_action = array('post-new.php?post_type=' . $post_type_object->name => array($post_type_object->labels->new_item, $post_type_object->cap->edit_posts));
+ else
+ $default_action = array('edit.php?post_type=' . $post_type_object->name => array($post_type_object->labels->name, $post_type_object->cap->edit_posts));
+ }
+
+ if ( !$default_action ) {
+ if ( $screen->is_network ) {
+ $default_action = array('sites.php' => array( __('Sites'), 'manage_sites'));
+ } else {
+ switch ( $screen->id ) {
+ case 'upload':
+ $default_action = array('media-new.php' => array(__('New Media'), 'upload_files'));
+ break;
+ case 'media':
+ $default_action = array('upload.php' => array(__('Edit Media'), 'upload_files'));
+ break;
+ case 'link-manager':
+ case 'link':
+ if ( 'add' != $screen->action )
+ $default_action = array('link-add.php' => array(__('New Link'), 'manage_links'));
+ else
+ $default_action = array('link-manager.php' => array(__('Edit Links'), 'manage_links'));
+ break;
+ case 'users':
+ $default_action = array('user-new.php' => array(__('New User'), 'create_users'));
+ break;
+ case 'user':
+ $default_action = array('users.php' => array(__('Edit Users'), 'edit_users'));
+ break;
+ case 'plugins':
+ $default_action = array('plugin-install.php' => array(__('Install Plugins'), 'install_plugins'));
+ break;
+ case 'plugin-install':
+ $default_action = array('plugins.php' => array(__('Manage Plugins'), 'activate_plugins'));
+ break;
+ case 'themes':
+ $default_action = array('theme-install.php' => array(__('Install Themes'), 'install_themes'));
+ break;
+ case 'theme-install':
+ $default_action = array('themes.php' => array(__('Manage Themes'), 'switch_themes'));
+ break;
+ default:
+ $default_action = array('post-new.php' => array(__('New Post'), 'edit_posts'));
+ break;
+ }
+ }
}
- $actions = array(
- 'post-new.php' => array(__('New Post'), 'edit_posts'),
- 'edit.php?post_status=draft' => array(__('Drafts'), 'edit_posts'),
- 'page-new.php' => array(__('New Page'), 'edit_pages'),
- 'media-new.php' => array(__('Upload'), 'upload_files'),
- 'edit-comments.php' => array(__('Comments'), 'moderate_comments')
+ if ( !$screen->is_network ) {
+ $actions = array(
+ 'post-new.php' => array(__('New Post'), 'edit_posts'),
+ 'edit.php?post_status=draft' => array(__('Drafts'), 'edit_posts'),
+ 'post-new.php?post_type=page' => array(__('New Page'), 'edit_pages'),
+ 'media-new.php' => array(__('Upload'), 'upload_files'),
+ 'edit-comments.php' => array(__('Comments'), 'moderate_comments')
+ );
+ } else {
+ $actions = array(
+ 'sites.php' => array( __('Sites'), 'manage_sites'),
+ 'users.php' => array( __('Users'), 'manage_network_users')
);
+ }
$default_key = array_keys($default_action);
$default_key = $default_key[0];
if ( isset($actions[$default_key]) )
unset($actions[$default_key]);
$actions = array_merge($default_action, $actions);
- $actions = apply_filters('favorite_actions', $actions);
+ $actions = apply_filters( 'favorite_actions', $actions, $screen );
$allowed_actions = array();
foreach ( $actions as $action => $data ) {
@@ -3360,11 +1506,10 @@ function favorite_actions( $screen = null ) {
* returned.
*
* @since 2.7.0
- * @param int $id The post id. If not supplied the global $post is used.
- *
+ * @param int $post_id The post id. If not supplied the global $post is used.
+ * @return string The post title if set
*/
-function _draft_or_post_title($post_id = 0)
-{
+function _draft_or_post_title( $post_id = 0 ) {
$title = get_the_title($post_id);
if ( empty($title) )
$title = __('(no title)');
@@ -3382,7 +1527,7 @@ function _draft_or_post_title($post_id = 0)
*
*/
function _admin_search_query() {
- echo isset($_GET['s']) ? esc_attr( stripslashes( $_GET['s'] ) ) : '';
+ echo isset($_REQUEST['s']) ? esc_attr( stripslashes( $_REQUEST['s'] ) ) : '';
}
/**
@@ -3394,6 +1539,11 @@ function _admin_search_query() {
*
*/
function iframe_header( $title = '', $limit_styles = false ) {
+ show_admin_bar( false );
+ global $hook_suffix, $current_screen, $current_user, $admin_body_class, $wp_locale;
+ $admin_body_class = preg_replace('/[^a-z0-9_-]+/i', '-', $hook_suffix);
+ $admin_body_class .= ' iframe';
+
?>
>
@@ -3409,15 +1559,40 @@ wp_enqueue_style( 'colors' );
//',
+ 'uid': 'ID; ?>',
+ 'time':''
+ },
+ ajaxurl = '',
+ pagenow = 'id; ?>',
+ typenow = 'post_type) ) echo $current_screen->post_type; ?>',
+ adminpage = '',
+ thousandsSeparator = 'number_format['thousands_sep'] ); ?>',
+ decimalPoint = 'number_format['decimal_point'] ); ?>',
+ isRtl = ;
//]]>
-
>
+ class="no-js ">
+
$state$sep";
}
}
+
+ if ( get_post_format( $post->ID ) )
+ echo ' - ' . get_post_format_string( get_post_format( $post->ID ) ) . ' ';
+}
+
+/**
+ * Convert a screen string to a screen object
+ *
+ * @since 3.0.0
+ *
+ * @param string $screen The name of the screen
+ * @return object An object containing the safe screen name and id
+ */
+function convert_to_screen( $screen ) {
+ $screen = str_replace( array('.php', '-new', '-add', '-network', '-user' ), '', $screen);
+
+ if ( is_network_admin() )
+ $screen .= '-network';
+ elseif ( is_user_admin() )
+ $screen .= '-user';
+
+ $screen = (string) apply_filters( 'screen_meta_screen', $screen );
+ $screen = (object) array('id' => $screen, 'base' => $screen);
+ return $screen;
}
function screen_meta($screen) {
- global $wp_meta_boxes, $_wp_contextual_help;
+ global $wp_meta_boxes, $_wp_contextual_help, $wp_list_table, $wp_current_screen_options;
- $screen = str_replace('.php', '', $screen);
- $screen = str_replace('-new', '', $screen);
- $screen = str_replace('-add', '', $screen);
- $screen = apply_filters('screen_meta_screen', $screen);
+ if ( is_string($screen) )
+ $screen = convert_to_screen($screen);
+
+ $columns = get_column_headers( $screen );
+ $hidden = get_hidden_columns( $screen );
- $column_screens = get_column_headers($screen);
$meta_screens = array('index' => 'dashboard');
- if ( isset($meta_screens[$screen]) )
- $screen = $meta_screens[$screen];
+ if ( isset($meta_screens[$screen->id]) ) {
+ $screen->id = $meta_screens[$screen->id];
+ $screen->base = $screen->id;
+ }
+
$show_screen = false;
- $show_on_screen = false;
- if ( !empty($wp_meta_boxes[$screen]) || !empty($column_screens) ) {
+ if ( !empty($wp_meta_boxes[$screen->id]) || !empty($columns) )
$show_screen = true;
- $show_on_screen = true;
- }
$screen_options = screen_options($screen);
if ( $screen_options )
@@ -3500,109 +1699,89 @@ function screen_meta($screen) {
if ( !isset($_wp_contextual_help) )
$_wp_contextual_help = array();
- $settings = '';
+ $settings = apply_filters('screen_settings', '', $screen);
- switch ( $screen ) {
- case 'post':
- if ( !isset($_wp_contextual_help['post']) ) {
- $help = drag_drop_help();
- $help .= '' . __('Writing Posts ') . '
';
- $_wp_contextual_help['post'] = $help;
- }
- break;
- case 'page':
- if ( !isset($_wp_contextual_help['page']) ) {
- $help = drag_drop_help();
- $_wp_contextual_help['page'] = $help;
- }
- break;
- case 'dashboard':
- if ( !isset($_wp_contextual_help['dashboard']) ) {
- $help = '' . __('The modules on this screen can be arranged in several columns. You can select the number of columns from the Screen Options tab.') . "
\n";
- $help .= drag_drop_help();
- $_wp_contextual_help['dashboard'] = $help;
- }
- break;
- case 'link':
- if ( !isset($_wp_contextual_help['link']) ) {
- $help = drag_drop_help();
- $_wp_contextual_help['link'] = $help;
- }
- break;
- case 'options-general':
- if ( !isset($_wp_contextual_help['options-general']) )
- $_wp_contextual_help['options-general'] = __('General Settings ');
- break;
- case 'theme-install':
- case 'plugin-install':
- if ( ( !isset($_GET['tab']) || 'dashboard' == $_GET['tab'] ) && !isset($_wp_contextual_help[$screen]) ) {
- $help = plugins_search_help();
- $_wp_contextual_help[$screen] = $help;
- }
- break;
+ switch ( $screen->id ) {
case 'widgets':
- if ( !isset($_wp_contextual_help['widgets']) ) {
- $help = widgets_help();
- $_wp_contextual_help['widgets'] = $help;
- }
$settings = '' . __('Enable accessibility mode') . ' ' . __('Disable accessibility mode') . "
\n";
$show_screen = true;
break;
}
+ if ( ! empty( $settings ) )
+ $show_screen = true;
+
+ if ( !empty($wp_current_screen_options) )
+ $show_screen = true;
+
?>
-
+
-
' . sprintf(__('Get help with “%s”'), $title) . '';
- else
- $contextual_help .= '
' . __('Get help with this page') . ' ';
- $contextual_help .= '
' . $_wp_contextual_help[$screen] . "
\n";
-
- $contextual_help .= '
' . __('Other Help') . ' ';
+ if ( isset($_wp_contextual_help[$screen->id]) ) {
+ $contextual_help .= '
' . $_wp_contextual_help[$screen->id] . "
\n";
} else {
- $contextual_help .= '
' . __('Help') . ' ';
+ $contextual_help .= '
\n";
}
- $contextual_help .= '
\n";
- echo apply_filters('contextual_help', $contextual_help, $screen);
+ echo apply_filters('contextual_help', $contextual_help, $screen->id, $screen);
?>
@@ -3631,54 +1810,40 @@ function screen_meta($screen) {
function add_contextual_help($screen, $help) {
global $_wp_contextual_help;
+ if ( is_string($screen) )
+ $screen = convert_to_screen($screen);
+
if ( !isset($_wp_contextual_help) )
$_wp_contextual_help = array();
- $_wp_contextual_help[$screen] = $help;
-}
-
-function drag_drop_help() {
- return '
-
' . __('Most of the modules on this screen can be moved. If you hover your mouse over the title bar of a module you’ll notice the 4 arrow cursor appears to let you know it is movable. Click on it, hold down the mouse button and start dragging the module to a new location. As you drag the module, notice the dotted gray box that also moves. This box indicates where the module will be placed when you release the mouse button.') . '
-
' . __('The same modules can be expanded and collapsed by clicking once on their title bar and also completely hidden from the Screen Options tab.') . '
-';
-}
-
-function plugins_search_help() {
- return '
-
' . __('Search help') . '
' .
- '
' . __('You may search based on 3 criteria:') . 'Term: Searches theme names and descriptions for the specified term.') . 'Tag: Searches for themes tagged as such.') . 'Author: Searches for themes created by the Author, or which the Author contributed to.') . '
-';
-}
-
-function widgets_help() {
- return '
-
' . __('Widgets are added and arranged by simple drag ’n’ drop. If you hover your mouse over the titlebar of a widget, you’ll see a 4-arrow cursor which indicates that the widget is movable. Click on the titlebar, hold down the mouse button and drag the widget to a sidebar. As you drag, you’ll see a dotted box that also moves. This box shows where the widget will go once you drop it.') . '
-
' . __('To remove a widget from a sidebar, drag it back to Available Widgets or click on the arrow on its titlebar to reveal its settings, and then click Remove.') . '
-
' . __('To remove a widget from a sidebar and keep its configuration , drag it to Inactive Widgets.') . '
-
' . __('The Inactive Widgets area stores widgets that are configured but not curently used. If you change themes and the new theme has fewer sidebars than the old, all extra widgets will be stored to Inactive Widgets automatically.') . '
-';
+ $_wp_contextual_help[$screen->id] = $help;
}
function screen_layout($screen) {
- global $screen_layout_columns;
+ global $screen_layout_columns, $wp_current_screen_options;
+
+ if ( is_string($screen) )
+ $screen = convert_to_screen($screen);
- $columns = array('dashboard' => 4, 'post' => 2, 'page' => 2, 'link' => 2);
- $columns = apply_filters('screen_layout_columns', $columns, $screen);
+ // Back compat for plugins using the filter instead of add_screen_option()
+ $columns = apply_filters('screen_layout_columns', array(), $screen->id, $screen);
+ if ( !empty($columns) && isset($columns[$screen->id]) )
+ add_screen_option('layout_columns', array('max' => $columns[$screen->id]) );
- if ( !isset($columns[$screen]) ) {
+ if ( !isset($wp_current_screen_options['layout_columns']) ) {
$screen_layout_columns = 0;
return '';
- }
+ }
- $screen_layout_columns = get_user_option("screen_layout_$screen");
- $num = $columns[$screen];
+ $screen_layout_columns = get_user_option("screen_layout_$screen->id");
+ $num = $wp_current_screen_options['layout_columns']['max'];
- if ( ! $screen_layout_columns )
+ if ( ! $screen_layout_columns ) {
+ if ( isset($wp_current_screen_options['layout_columns']['default']) )
+ $screen_layout_columns = $wp_current_screen_options['layout_columns']['default'];
+ else
$screen_layout_columns = 2;
+ }
$i = 1;
$return = '
' . __('Screen Layout') . " \n
" . __('Number of Columns:') . "\n";
@@ -3690,69 +1855,99 @@ function screen_layout($screen) {
return $return;
}
+/**
+ * Register and configure an admin screen option
+ *
+ * @since 3.1.0
+ *
+ * @param string $option An option name.
+ * @param mixed $args Option dependent arguments
+ * @return void
+ */
+function add_screen_option( $option, $args = array() ) {
+ global $wp_current_screen_options;
+
+ if ( !isset($wp_current_screen_options) )
+ $wp_current_screen_options = array();
+
+ $wp_current_screen_options[$option] = $args;
+}
+
function screen_options($screen) {
- switch ( $screen ) {
- case 'edit':
- $per_page_label = __('Posts per page:');
- break;
- case 'edit-pages':
- $per_page_label = __('Pages per page:');
- break;
- case 'edit-comments':
- $per_page_label = __('Comments per page:');
- break;
- case 'upload':
- $per_page_label = __('Media items per page:');
- break;
- case 'categories':
- $per_page_label = __('Categories per page:');
- break;
- case 'edit-tags':
- $per_page_label = __('Tags per page:');
- break;
- case 'plugins':
- $per_page_label = __('Plugins per page:');
- break;
- default:
- return '';
+ global $wp_current_screen_options;
+
+ if ( is_string($screen) )
+ $screen = convert_to_screen($screen);
+
+ if ( !isset($wp_current_screen_options['per_page']) )
+ return '';
+
+ $per_page_label = $wp_current_screen_options['per_page']['label'];
+
+ if ( empty($wp_current_screen_options['per_page']['option']) ) {
+ $option = str_replace( '-', '_', "{$screen->id}_per_page" );
+ } else {
+ $option = $wp_current_screen_options['per_page']['option'];
}
- $option = str_replace( '-', '_', "${screen}_per_page" );
- $per_page = (int) get_user_option( $option, 0, false );
+ $per_page = (int) get_user_option( $option );
if ( empty( $per_page ) || $per_page < 1 ) {
- if ( 'plugins' == $screen )
- $per_page = 999;
+ if ( isset($wp_current_screen_options['per_page']['default']) )
+ $per_page = $wp_current_screen_options['per_page']['default'];
else
$per_page = 20;
}
+
if ( 'edit_comments_per_page' == $option )
$per_page = apply_filters( 'comments_per_page', $per_page, isset($_REQUEST['comment_status']) ? $_REQUEST['comment_status'] : 'all' );
- elseif ( 'categories' == $option )
+ elseif ( 'categories_per_page' == $option )
$per_page = apply_filters( 'edit_categories_per_page', $per_page );
else
$per_page = apply_filters( $option, $per_page );
- $return = '
' . __('Options') . " \n";
- $return .= "
\n";
+ // Back compat
+ if ( isset( $screen->post_type ) )
+ $per_page = apply_filters( 'edit_posts_per_page', $per_page, $screen->post_type );
+
+ $return = "
\n";
if ( !empty($per_page_label) )
- $return .= "$per_page_label $per_page_label \n";
+ $return .= get_submit_button( __( 'Apply' ), 'button', 'screen-options-apply', false );
$return .= "
\n";
return $return;
}
-function screen_icon($name = '') {
- global $parent_file, $hook_suffix;
+function screen_icon($screen = '') {
+ global $current_screen, $typenow;
+
+ if ( empty($screen) )
+ $screen = $current_screen;
+ elseif ( is_string($screen) )
+ $name = $screen;
+
+ $class = 'icon32';
if ( empty($name) ) {
- if ( isset($parent_file) && !empty($parent_file) )
- $name = substr($parent_file, 0, -4);
+ if ( !empty($screen->parent_base) )
+ $name = $screen->parent_base;
else
- $name = str_replace(array('.php', '-new', '-add'), '', $hook_suffix);
+ $name = $screen->base;
+
+ if ( 'edit' == $name && isset($screen->post_type) && 'page' == $screen->post_type )
+ $name = 'edit-pages';
+
+ $post_type = '';
+ if ( isset( $screen->post_type ) )
+ $post_type = $screen->post_type;
+ elseif ( $current_screen == $screen )
+ $post_type = $typenow;
+ if ( $post_type )
+ $class .= ' ' . sanitize_html_class( 'icon32-posts-' . $post_type );
}
+
?>
-
+
+/**
+ * Get the current screen object
+ *
+ * @since 3.1.0
+ *
+ * @return object Current screen object
+ */
+function get_current_screen() {
+ global $current_screen;
+
+ if ( !isset($current_screen) )
+ return null;
+
+ return $current_screen;
+}
+
+/**
+ * Set the current screen object
+ *
+ * @since 3.0.0
+ *
+ * @uses $current_screen
+ *
+ * @param string $id Screen id, optional.
+ */
+function set_current_screen( $id = '' ) {
+ global $current_screen, $hook_suffix, $typenow, $taxnow;
+
+ $action = '';
+
+ if ( empty($id) ) {
+ $current_screen = $hook_suffix;
+ $current_screen = str_replace('.php', '', $current_screen);
+ if ( preg_match('/-add|-new$/', $current_screen) )
+ $action = 'add';
+ $current_screen = str_replace('-new', '', $current_screen);
+ $current_screen = str_replace('-add', '', $current_screen);
+ $current_screen = array('id' => $current_screen, 'base' => $current_screen);
+ } else {
+ $id = sanitize_key($id);
+ if ( false !== strpos($id, '-') ) {
+ list( $id, $typenow ) = explode('-', $id, 2);
+ if ( taxonomy_exists( $typenow ) ) {
+ $id = 'edit-tags';
+ $taxnow = $typenow;
+ $typenow = '';
+ }
+ }
+ $current_screen = array('id' => $id, 'base' => $id);
+ }
+
+ $current_screen = (object) $current_screen;
+
+ $current_screen->action = $action;
+
+ // Map index to dashboard
+ if ( 'index' == $current_screen->base )
+ $current_screen->base = 'dashboard';
+ if ( 'index' == $current_screen->id )
+ $current_screen->id = 'dashboard';
+
+ if ( 'edit' == $current_screen->id ) {
+ if ( empty($typenow) )
+ $typenow = 'post';
+ $current_screen->id .= '-' . $typenow;
+ $current_screen->post_type = $typenow;
+ } elseif ( 'post' == $current_screen->id ) {
+ if ( empty($typenow) )
+ $typenow = 'post';
+ $current_screen->id = $typenow;
+ $current_screen->post_type = $typenow;
+ } elseif ( 'edit-tags' == $current_screen->id ) {
+ if ( empty($taxnow) )
+ $taxnow = 'post_tag';
+ $current_screen->id = 'edit-' . $taxnow;
+ $current_screen->taxonomy = $taxnow;
+ }
+
+ $current_screen->is_network = is_network_admin();
+ $current_screen->is_user = is_user_admin();
+
+ if ( $current_screen->is_network ) {
+ $current_screen->base .= '-network';
+ $current_screen->id .= '-network';
+ } elseif ( $current_screen->is_user ) {
+ $current_screen->base .= '-user';
+ $current_screen->id .= '-user';
+ }
+
+ $current_screen = apply_filters('current_screen', $current_screen);
+}
+
+/**
+ * Echos a submit button, with provided text and appropriate class
+ *
+ * @since 3.1.0
+ *
+ * @param string $text The text of the button (defaults to 'Save Changes')
+ * @param string $type The type of button. One of: primary, secondary, delete
+ * @param string $name The HTML name of the submit button. Defaults to "submit". If no id attribute
+ * is given in $other_attributes below, $name will be used as the button's id.
+ * @param bool $wrap True if the output button should be wrapped in a paragraph tag,
+ * false otherwise. Defaults to true
+ * @param array|string $other_attributes Other attributes that should be output with the button,
+ * mapping attributes to their values, such as array( 'tabindex' => '1' ).
+ * These attributes will be ouput as attribute="value", such as tabindex="1".
+ * Defaults to no other attributes. Other attributes can also be provided as a
+ * string such as 'tabindex="1"', though the array format is typically cleaner.
+ */
+function submit_button( $text = NULL, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = NULL ) {
+ echo get_submit_button( $text, $type, $name, $wrap, $other_attributes );
+}
+
+/**
+ * Returns a submit button, with provided text and appropriate class
+ *
+ * @since 3.1.0
+ *
+ * @param string $text The text of the button (defaults to 'Save Changes')
+ * @param string $type The type of button. One of: primary, secondary, delete
+ * @param string $name The HTML name of the submit button. Defaults to "submit". If no id attribute
+ * is given in $other_attributes below, $name will be used as the button's id.
+ * @param bool $wrap True if the output button should be wrapped in a paragraph tag,
+ * false otherwise. Defaults to true
+ * @param array|string $other_attributes Other attributes that should be output with the button,
+ * mapping attributes to their values, such as array( 'tabindex' => '1' ).
+ * These attributes will be ouput as attribute="value", such as tabindex="1".
+ * Defaults to no other attributes. Other attributes can also be provided as a
+ * string such as 'tabindex="1"', though the array format is typically cleaner.
+ */
+function get_submit_button( $text = NULL, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = NULL ) {
+ switch ( $type ) :
+ case 'primary' :
+ case 'secondary' :
+ $class = 'button-' . $type;
+ break;
+ case 'delete' :
+ $class = 'button-secondary delete';
+ break;
+ default :
+ $class = $type; // Custom cases can just pass in the classes they want to be used
+ endswitch;
+ $text = ( NULL == $text ) ? __( 'Save Changes' ) : $text;
+
+ // Default the id attribute to $name unless an id was specifically provided in $other_attributes
+ $id = $name;
+ if ( is_array( $other_attributes ) && isset( $other_attributes['id'] ) ) {
+ $id = $other_attributes['id'];
+ unset( $other_attributes['id'] );
+ }
+
+ $attributes = '';
+ if ( is_array( $other_attributes ) ) {
+ foreach ( $other_attributes as $attribute => $value ) {
+ $attributes .= $attribute . '="' . esc_attr( $value ) . '" '; // Trailing space is important
+ }
+ } else if ( !empty( $other_attributes ) ) { // Attributes provided as a string
+ $attributes = $other_attributes;
+ }
+
+ $button = '
';
+
+ if ( $wrap ) {
+ $button = '
' . $button . '
';
+ }
+
+ return $button;
+}
+
