X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/03f2fa83c13c1b532284205fa7efcab9b8b2c41f..refs/tags/wordpress-4.6.1:/wp-admin/includes/template.php diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index e65c7d0f..57478a11 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -8,10 +8,10 @@ * @subpackage Administration */ -/** Walker_Category_Checklist class */ +/** Walker_Category_Checklist class */ require_once( ABSPATH . 'wp-admin/includes/class-walker-category-checklist.php' ); -/** WP_Internal_Pointers class */ +/** WP_Internal_Pointers class */ require_once( ABSPATH . 'wp-admin/includes/class-wp-internal-pointers.php' ); // @@ -86,7 +86,7 @@ function wp_terms_checklist( $post_id = 0, $args = array() ) { ); /** - * Filter the taxonomy terms checklist arguments. + * Filters the taxonomy terms checklist arguments. * * @since 3.4.0 * @@ -203,7 +203,7 @@ function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $ech $popular_ids = array(); foreach ( (array) $terms as $term ) { $popular_ids[] = $term->term_id; - if ( !$echo ) // hack for AJAX use + if ( !$echo ) // Hack for Ajax use. continue; $id = "popular-$taxonomy-$term->term_id"; $checked = in_array( $term->term_id, $checked_terms ) ? 'checked="checked"' : ''; @@ -311,7 +311,7 @@ function get_inline_data($post) { $terms = get_object_term_cache( $post->ID, $taxonomy_name ); if ( false === $terms ) { $terms = wp_get_object_terms( $post->ID, $taxonomy_name ); - wp_cache_add( $post->ID, $terms, $taxonomy_name . '_relationships' ); + wp_cache_add( $post->ID, wp_list_pluck( $terms, 'term_id' ), $taxonomy_name . '_relationships' ); } $term_ids = empty( $terms ) ? array() : wp_list_pluck( $terms, 'term_id' ); @@ -354,7 +354,7 @@ function get_inline_data($post) { function wp_comment_reply( $position = 1, $checkbox = false, $mode = 'single', $table_row = true ) { global $wp_list_table; /** - * Filter the in-line comment reply-to form output in the Comments + * Filters the in-line comment reply-to form output in the Comments * list table. * * Returning a non-empty value here will short-circuit display @@ -582,7 +582,7 @@ function meta_form( $post = null ) { $post = get_post( $post ); /** - * Filter values for the meta key dropdown in the Custom Fields meta box. + * Filters values for the meta key dropdown in the Custom Fields meta box. * * Returning a non-null value will effectively short-circuit and avoid a * potentially expensive query against postmeta. @@ -596,7 +596,7 @@ function meta_form( $post = null ) { if ( null === $keys ) { /** - * Filter the number of custom fields to retrieve for the drop-down + * Filters the number of custom fields to retrieve for the drop-down * in the Custom Fields meta box. * * @since 2.1.0 @@ -843,7 +843,7 @@ function wp_dropdown_roles( $selected = '' ) { function wp_import_upload_form( $action ) { /** - * Filter the maximum allowed upload size for import files. + * Filters the maximum allowed upload size for import files. * * @since 2.3.0 * @@ -1027,8 +1027,16 @@ function do_meta_boxes( $screen, $context, $object ) { $hidden_class = in_array($box['id'], $hidden) ? ' hide-if-js' : ''; echo '
' . "\n"; if ( 'dashboard_browser_nag' != $box['id'] ) { + $widget_title = $box[ 'title' ]; + + if ( is_array( $box[ 'args' ] ) && isset( $box[ 'args' ][ '__widget_basename' ] ) ) { + $widget_title = $box[ 'args' ][ '__widget_basename' ]; + // Do not pass this parameter to the user callback function. + unset( $box[ 'args' ][ '__widget_basename' ] ); + } + echo ''; } @@ -1060,12 +1068,11 @@ function do_meta_boxes( $screen, $context, $object ) { * @param string|array|WP_Screen $screen The screen or screens on which the meta box is shown (such as a * post type, 'link', or 'comment'). Accepts a single screen ID, * WP_Screen object, or array of screen IDs. - * @param string $context Optional. The context within the screen where the boxes - * should display. Available contexts vary from screen to - * screen. Post edit screen contexts include 'normal', 'side', - * and 'advanced'. Comments screen contexts include 'normal' - * and 'side'. Menus meta boxes (accordion sections) all use - * the 'side' context. Global default is 'advanced'. + * @param string $context The context within the screen where the box is set to display. + * Contexts vary from screen to screen. Post edit screen contexts + * include 'normal', 'side', and 'advanced'. Comments screen contexts + * include 'normal' and 'side'. Menus meta boxes (accordion sections) + * all use the 'side' context. */ function remove_meta_box( $id, $screen, $context ) { global $wp_meta_boxes; @@ -1100,7 +1107,7 @@ function remove_meta_box( $id, $screen, $context ) { /** * Meta Box Accordion Template Function * - * Largely made up of abstracted code from {@link do_meta_boxes()}, this + * Largely made up of abstracted code from do_meta_boxes(), this * function serves to build meta boxes as list items for display as * a collapsible accordion. * @@ -1186,21 +1193,23 @@ function do_accordion_sections( $screen, $context, $object ) { * * @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(); + * @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 callable $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', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) ); + _deprecated_argument( __FUNCTION__, '3.0.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) ); $page = 'general'; } if ( 'privacy' == $page ) { - _deprecated_argument( __FUNCTION__, '3.5', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) ); + _deprecated_argument( __FUNCTION__, '3.5.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) ); $page = 'reading'; } @@ -1223,16 +1232,16 @@ function add_settings_section($id, $title, $callback, $page) { * * @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 Optional. The slug-name of the section of the settings page - * in which to show the box. Default 'default'. - * @param array $args { + * @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 callable $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 Optional. The slug-name of the section of the settings page + * in which to show the box. Default 'default'. + * @param array $args { * Optional. Extra arguments used when outputting the field. * * @type string $label_for When supplied, the setting title will be wrapped @@ -1246,12 +1255,12 @@ function add_settings_field($id, $title, $callback, $page, $section = 'default', global $wp_settings_fields; if ( 'misc' == $page ) { - _deprecated_argument( __FUNCTION__, '3.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) ); + _deprecated_argument( __FUNCTION__, '3.0.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) ); $page = 'general'; } if ( 'privacy' == $page ) { - _deprecated_argument( __FUNCTION__, '3.5', __( 'The privacy options group has been removed. Use another settings group.' ) ); + _deprecated_argument( __FUNCTION__, '3.5.0', __( 'The privacy options group has been removed. Use another settings group.' ) ); $page = 'reading'; } @@ -1381,7 +1390,8 @@ function add_settings_error( $setting, $code, $message, $type = 'error' ) { * * 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) + * hasn't submitted data (i.e. when they first load an options page, or in the {@see 'admin_notices'} + * action hook). * * @since 3.0.0 * @@ -1426,16 +1436,16 @@ function get_settings_errors( $setting = '', $sanitize = false ) { } /** - * Display settings errors registered by {@see add_settings_error()}. + * Display settings errors registered by add_settings_error(). * * Part of the Settings API. Outputs a div for each error retrieved by - * {@see get_settings_errors()}. + * get_settings_errors(). * * This is called automatically after a settings page based on the * Settings API is submitted. Errors should be added during the validation - * callback function for a setting defined in {@see register_setting()} + * callback function for a setting defined in register_setting(). * - * The $sanitize option is passed into {@see get_settings_errors()} and will + * The $sanitize option is passed into get_settings_errors() and will * re-run the setting sanitization * on its current value. * @@ -1449,7 +1459,8 @@ function get_settings_errors( $setting = '', $sanitize = false ) { * * @param string $setting Optional slug title of a specific setting who's errors you want. * @param bool $sanitize Whether to re-sanitize the setting value before returning errors. - * @param bool $hide_on_update If set to true errors will not be shown if the settings page has already been submitted. + * @param bool $hide_on_update If set to true errors will not be shown if the settings page has + * already been submitted. */ function settings_errors( $setting = '', $sanitize = false, $hide_on_update = false ) { @@ -1483,8 +1494,8 @@ function find_posts_div($found_action = '') { ?>