X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/af50974463450c98503e763a7836a50e260461a9..16e7b37c7914d753890c1a05a9335f3b43751eb8:/wp-admin/includes/template.php diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index 425e40b0..edf9a864 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -8,126 +8,34 @@ * @subpackage Administration */ +/** Walker_Category_Checklist class */ +require_once( ABSPATH . 'wp-admin/includes/class-walker-category-checklist.php' ); + +/** WP_Internal_Pointers class */ +require_once( ABSPATH . 'wp-admin/includes/class-wp-internal-pointers.php' ); + // // Category Checklists // /** - * Walker to output an unordered list of category checkbox input elements. + * Output an unordered list of checkbox input elements labeled with category names. * * @since 2.5.1 * - * @see Walker - * @see wp_category_checklist() * @see wp_terms_checklist() - */ -class Walker_Category_Checklist extends Walker { - public $tree_type = 'category'; - public $db_fields = array ('parent' => 'parent', 'id' => 'term_id'); //TODO: decouple this - - /** - * Starts the list before the elements are added. - * - * @see Walker:start_lvl() - * - * @since 2.5.1 - * - * @param string $output Passed by reference. Used to append additional content. - * @param int $depth Depth of category. Used for tab indentation. - * @param array $args An array of arguments. @see wp_terms_checklist() - */ - public function start_lvl( &$output, $depth = 0, $args = array() ) { - $indent = str_repeat("\t", $depth); - $output .= "$indent\n"; - } - - /** - * Start the element output. - * - * @see Walker::start_el() - * - * @since 2.5.1 - * - * @param string $output Passed by reference. Used to append additional content. - * @param object $category The current term object. - * @param int $depth Depth of the term in reference to parents. Default 0. - * @param array $args An array of arguments. @see wp_terms_checklist() - * @param int $id ID of the current term. - */ - public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) { - if ( empty( $args['taxonomy'] ) ) { - $taxonomy = 'category'; - } else { - $taxonomy = $args['taxonomy']; - } - - if ( $taxonomy == 'category' ) { - $name = 'post_category'; - } else { - $name = 'tax_input[' . $taxonomy . ']'; - } - $args['popular_cats'] = empty( $args['popular_cats'] ) ? array() : $args['popular_cats']; - $class = in_array( $category->term_id, $args['popular_cats'] ) ? ' class="popular-category"' : ''; - - $args['selected_cats'] = empty( $args['selected_cats'] ) ? array() : $args['selected_cats']; - - /** This filter is documented in wp-includes/category-template.php */ - $output .= "\n
  • " . - ''; - } - - /** - * Ends the element output, if needed. - * - * @see Walker::end_el() - * - * @since 2.5.1 - * - * @param string $output Passed by reference. Used to append additional content. - * @param object $category The current term object. - * @param int $depth Depth of the term in reference to parents. Default 0. - * @param array $args An array of arguments. @see wp_terms_checklist() - */ - public function end_el( &$output, $category, $depth = 0, $args = array() ) { - $output .= "
  • \n"; - } -} - -/** - * Output an unordered list of checkbox input elements labelled - * with category names. - * - * @since 2.5.1 * - * @todo Properly document optional arguments as such. - * - * @see wp_terms_checklist() - * - * @param int $post_id Mark categories associated with this post as checked. $selected_cats must not be an array. - * @param int $descendants_and_self ID of the category to output along with its descendents. - * @param bool|array $selected_cats List of categories to mark as checked. - * @param bool|array $popular_cats Override the list of categories that receive the "popular-category" class. - * @param object $walker Walker object to use to build the output. - * @param bool $checked_ontop Move checked items out of the hierarchy and to the top of the list. + * @param int $post_id Optional. Post to generate a categories checklist for. Default 0. + * $selected_cats must not be an array. Default 0. + * @param int $descendants_and_self Optional. ID of the category to output along with its descendants. + * Default 0. + * @param array $selected_cats Optional. List of categories to mark as checked. Default false. + * @param array $popular_cats Optional. List of categories to receive the "popular-category" class. + * Default false. + * @param object $walker Optional. Walker object to use to build the output. + * Default is a Walker_Category_Checklist instance. + * @param bool $checked_ontop Optional. Whether to move checked items out of the hierarchy and to + * the top of the list. Default true. */ function wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $selected_cats = false, $popular_cats = false, $walker = null, $checked_ontop = true ) { wp_terms_checklist( $post_id, array( @@ -143,14 +51,28 @@ function wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $select /** * Output an unordered list of checkbox input elements labelled with term names. * - * Taxonomy independent version of {@see wp_category_checklist()}. + * Taxonomy-independent version of wp_category_checklist(). * * @since 3.0.0 - * - * @todo Properly document optional default arguments. - * - * @param int $post_id Post ID. - * @param array $args Arguments to form the terms checklist. + * @since 4.4.0 Introduced the `$echo` argument. + * + * @param int $post_id Optional. Post ID. Default 0. + * @param array|string $args { + * Optional. Array or string of arguments for generating a terms checklist. Default empty array. + * + * @type int $descendants_and_self ID of the category to output along with its descendants. + * Default 0. + * @type array $selected_cats List of categories to mark as checked. Default false. + * @type array $popular_cats List of categories to receive the "popular-category" class. + * Default false. + * @type object $walker Walker object to use to build the output. + * Default is a Walker_Category_Checklist instance. + * @type string $taxonomy Taxonomy to generate the checklist for. Default 'category'. + * @type bool $checked_ontop Whether to move checked items out of the hierarchy and to + * the top of the list. Default true. + * @type bool $echo Whether to echo the generated markup. False to return the markup instead + * of echoing it. Default true. + * } */ function wp_terms_checklist( $post_id = 0, $args = array() ) { $defaults = array( @@ -159,11 +81,12 @@ function wp_terms_checklist( $post_id = 0, $args = array() ) { 'popular_cats' => false, 'walker' => null, 'taxonomy' => 'category', - 'checked_ontop' => true + 'checked_ontop' => true, + 'echo' => true, ); /** - * Filter the taxonomy terms checklist arguments. + * Filters the taxonomy terms checklist arguments. * * @since 3.4.0 * @@ -176,7 +99,7 @@ function wp_terms_checklist( $post_id = 0, $args = array() ) { $r = wp_parse_args( $params, $defaults ); - if ( empty( $r['walker'] ) || ! is_a( $r['walker'], 'Walker' ) ) { + if ( empty( $r['walker'] ) || ! ( $r['walker'] instanceof Walker ) ) { $walker = new Walker_Category_Checklist; } else { $walker = $r['walker']; @@ -190,6 +113,8 @@ function wp_terms_checklist( $post_id = 0, $args = array() ) { $tax = get_taxonomy( $taxonomy ); $args['disabled'] = ! current_user_can( $tax->cap->assign_terms ); + $args['list_only'] = ! empty( $r['list_only'] ); + if ( is_array( $r['selected_cats'] ) ) { $args['selected_cats'] = $r['selected_cats']; } elseif ( $post_id ) { @@ -220,12 +145,14 @@ function wp_terms_checklist( $post_id = 0, $args = array() ) { $categories = (array) get_terms( $taxonomy, array( 'get' => 'all' ) ); } + $output = ''; + if ( $r['checked_ontop'] ) { // Post process $categories rather than adding an exclude to the get_terms() query to keep the query the same across all posts (for any query cache) $checked_categories = array(); $keys = array_keys( $categories ); - foreach( $keys as $k ) { + foreach ( $keys as $k ) { if ( in_array( $categories[$k]->term_id, $args['selected_cats'] ) ) { $checked_categories[] = $categories[$k]; unset( $categories[$k] ); @@ -233,10 +160,16 @@ function wp_terms_checklist( $post_id = 0, $args = array() ) { } // Put checked cats on top - echo call_user_func_array( array( $walker, 'walk' ), array( $checked_categories, 0, $args ) ); + $output .= call_user_func_array( array( $walker, 'walk' ), array( $checked_categories, 0, $args ) ); } // Then the rest of them - echo call_user_func_array( array( $walker, 'walk' ), array( $categories, 0, $args ) ); + $output .= call_user_func_array( array( $walker, 'walk' ), array( $categories, 0, $args ) ); + + if ( $r['echo'] ) { + echo $output; + } + + return $output; } /** @@ -250,7 +183,7 @@ function wp_terms_checklist( $post_id = 0, $args = array() ) { * @since 2.5.0 * * @param string $taxonomy Taxonomy to retrieve terms from. - * @param int $default Unused. + * @param int $default Not used. * @param int $number Number of terms to retrieve. Defaults to 10. * @param bool $echo Optionally output the list as well. Defaults to true. * @return array List of popular term IDs. @@ -270,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"' : ''; @@ -292,7 +225,7 @@ function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $ech } /** - * {@internal Missing Short Description}} + * Outputs a link category checklist element. * * @since 2.5.1 * @@ -301,11 +234,14 @@ function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $ech function wp_link_category_checklist( $link_id = 0 ) { $default = 1; + $checked_categories = array(); + if ( $link_id ) { $checked_categories = wp_get_link_cats( $link_id ); // No selected categories, strange - if ( ! count( $checked_categories ) ) + if ( ! count( $checked_categories ) ) { $checked_categories[] = $default; + } } else { $checked_categories[] = $default; } @@ -325,13 +261,12 @@ function wp_link_category_checklist( $link_id = 0 ) { } } -// adds hidden fields with the data for use in the inline editor for posts and pages /** - * {@internal Missing Short Description}} + * Adds hidden fields with the data for use in the inline editor for posts and pages. * * @since 2.7.0 * - * @param WP_Post $post + * @param WP_Post $post Post object. */ function get_inline_data($post) { $post_type_object = get_post_type_object($post->post_type); @@ -343,8 +278,9 @@ function get_inline_data($post) { /** This filter is documented in wp-admin/edit-tag-form.php */ echo ' '; } } @@ -399,19 +341,21 @@ function get_inline_data($post) { } /** - * {@internal Missing Short Description}} + * Outputs the in-line comment reply-to form in the Comments list table. * * @since 2.7.0 * - * @param int $position - * @param bool $checkbox + * @global WP_List_Table $wp_list_table + * + * @param int $position + * @param bool $checkbox * @param string $mode - * @param bool $table_row + * @param bool $table_row */ -function wp_comment_reply($position = '1', $checkbox = false, $mode = 'single', $table_row = true) { - +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 @@ -432,29 +376,44 @@ function wp_comment_reply($position = '1', $checkbox = false, $mode = 'single', return; } - if ( $mode == 'single' ) { - $wp_list_table = _get_list_table('WP_Post_Comments_List_Table'); - } else { - $wp_list_table = _get_list_table('WP_Comments_List_Table'); + if ( ! $wp_list_table ) { + if ( $mode == 'single' ) { + $wp_list_table = _get_list_table('WP_Post_Comments_List_Table'); + } else { + $wp_list_table = _get_list_table('WP_Comments_List_Table'); + } } ?> -
    + -"; + $r .= "\n\t"; $r .= "\n\t\t @@ -706,15 +672,18 @@ function meta_form( $post = null ) { * Print out HTML form date elements for editing post or comment publish date. * * @since 0.71 + * @since 4.4.0 Converted to use get_comment() instead of the global `$comment`. + * + * @global WP_Locale $wp_locale * - * @param int $edit Accepts 1|true for editing the date, 0|false for adding the date. - * @param int $for_post Accepts 1|true for applying the date to a post, 0|false for a comment. - * @param int $tab_index The tabindex attribute to add. Default 0. - * @param int $multi Optional. Whether the additional fields and buttons should be added. + * @param int|bool $edit Accepts 1|true for editing the date, 0|false for adding the date. + * @param int|bool $for_post Accepts 1|true for applying the date to a post, 0|false for a comment. + * @param int $tab_index The tabindex attribute to add. Default 0. + * @param int|bool $multi Optional. Whether the additional fields and buttons should be added. * Default 0|false. */ function touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 ) { - global $wp_locale, $comment; + global $wp_locale; $post = get_post(); if ( $for_post ) @@ -728,7 +697,7 @@ function touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 ) { // echo '
    '; $time_adj = current_time('timestamp'); - $post_date = ($for_post) ? $post->post_date : $comment->comment_date; + $post_date = ($for_post) ? $post->post_date : get_comment()->comment_date; $jj = ($edit) ? mysql2date( 'd', $post_date, false ) : gmdate( 'd', $time_adj ); $mm = ($edit) ? mysql2date( 'm', $post_date, false ) : gmdate( 'm', $time_adj ); $aa = ($edit) ? mysql2date( 'Y', $post_date, false ) : gmdate( 'Y', $time_adj ); @@ -742,23 +711,24 @@ function touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 ) { $cur_hh = gmdate( 'H', $time_adj ); $cur_mn = gmdate( 'i', $time_adj ); - $month = '\n"; for ( $i = 1; $i < 13; $i = $i +1 ) { $monthnum = zeroise($i, 2); - $month .= "\t\t\t" . '\n"; + $month .= sprintf( __( '%1$s-%2$s' ), $monthnum, $monthtext ) . "\n"; } - $month .= ''; + $month .= ''; - $day = ''; - $year = ''; - $hour = ''; - $minute = ''; + $day = ''; + $year = ''; + $hour = ''; + $minute = ''; echo '
    '; /* translators: 1: month, 2: day, 3: year, 4: hour, 5: minute */ - printf( __( '%1$s %2$s, %3$s @ %4$s : %5$s' ), $month, $day, $year, $hour, $minute ); + printf( __( '%1$s %2$s, %3$s @ %4$s:%5$s' ), $month, $day, $year, $hour, $minute ); echo '
    '; @@ -792,11 +762,13 @@ function touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 ) { * Print out option HTML elements for the page templates drop-down. * * @since 1.5.0 + * @since 4.7.0 Added the `$post_type` parameter. * - * @param string $default Optional. The template file name. Default empty. + * @param string $default Optional. The template file name. Default empty. + * @param string $post_type Optional. Post type to get templates for. Default 'post'. */ -function page_template_dropdown( $default = '' ) { - $templates = get_page_templates( get_post() ); +function page_template_dropdown( $default = '', $post_type = 'page' ) { + $templates = get_page_templates( null, $post_type ); ksort( $templates ); foreach ( array_keys( $templates ) as $template ) { $selected = selected( $default, $templates[ $template ], false ); @@ -808,16 +780,20 @@ function page_template_dropdown( $default = '' ) { * Print out option HTML elements for the page parents drop-down. * * @since 1.5.0 + * @since 4.4.0 `$post` argument was added. + * + * @global wpdb $wpdb WordPress database abstraction object. * - * @param int $default Optional. The default page ID to be pre-selected. Default 0. - * @param int $parent Optional. The parent page ID. Default 0. - * @param int $level Optional. Page depth level. Default 0. + * @param int $default Optional. The default page ID to be pre-selected. Default 0. + * @param int $parent Optional. The parent page ID. Default 0. + * @param int $level Optional. Page depth level. Default 0. + * @param int|WP_Post $post Post ID or WP_Post object. * * @return null|false Boolean False if page has no children, otherwise print out html elements */ -function parent_dropdown( $default = 0, $parent = 0, $level = 0 ) { +function parent_dropdown( $default = 0, $parent = 0, $level = 0, $post = null ) { global $wpdb; - $post = get_post(); + $post = get_post( $post ); $items = $wpdb->get_results( $wpdb->prepare("SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' ORDER BY menu_order", $parent) ); if ( $items ) { @@ -842,9 +818,9 @@ function parent_dropdown( $default = 0, $parent = 0, $level = 0 ) { * * @since 2.1.0 * - * @param string $selected slug for the role that should be already selected + * @param string $selected Slug for the role that should be already selected. */ -function wp_dropdown_roles( $selected = false ) { +function wp_dropdown_roles( $selected = '' ) { $p = ''; $r = ''; @@ -870,7 +846,7 @@ function wp_dropdown_roles( $selected = false ) { 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 * @@ -893,42 +869,56 @@ function wp_import_upload_form( $action ) {

    - +id ) ) { + return; + } $page = $screen->id; @@ -992,10 +982,12 @@ function add_meta_box( $id, $title, $callback, $screen = null, $context = 'advan * * @since 2.5.0 * + * @global array $wp_meta_boxes + * * @staticvar bool $already_sorted - * @param string|WP_Screen $screen Screen identifier - * @param string $context box context - * @param mixed $object gets passed to the box callback function as first parameter + * @param string|WP_Screen $screen Screen identifier + * @param string $context box context + * @param mixed $object gets passed to the box callback function as first parameter * @return int number of meta_boxes */ function do_meta_boxes( $screen, $context, $object ) { @@ -1037,9 +1029,21 @@ function do_meta_boxes( $screen, $context, $object ) { $i++; $hidden_class = in_array($box['id'], $hidden) ? ' hide-if-js' : ''; echo '
    ' . "\n"; - if ( 'dashboard_browser_nag' != $box['id'] ) - echo '

    '; - echo "

    {$box['title']}

    \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 ''; + } + echo "

    {$box['title']}

    \n"; echo '
    ' . "\n"; call_user_func($box['callback'], $object, $box); echo "
    \n"; @@ -1056,21 +1060,39 @@ function do_meta_boxes( $screen, $context, $object ) { } /** - * Remove a meta box from an edit form. + * Removes a meta box from one or more screens. * * @since 2.6.0 - * - * @param string $id String for use in the 'id' attribute of tags. - * @param string|object $screen The screen on which to show the box (post, page, link). - * @param string $context The context within the page where the boxes should show ('normal', 'advanced'). + * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs. + * + * @global array $wp_meta_boxes + * + * @param string $id Meta box ID (used in the 'id' attribute for the meta box). + * @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 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) { +function remove_meta_box( $id, $screen, $context ) { global $wp_meta_boxes; - if ( empty( $screen ) ) + if ( empty( $screen ) ) { $screen = get_current_screen(); - elseif ( is_string( $screen ) ) + } elseif ( is_string( $screen ) ) { $screen = convert_to_screen( $screen ); + } elseif ( is_array( $screen ) ) { + foreach ( $screen as $single_screen ) { + remove_meta_box( $id, $single_screen, $context ); + } + } + + if ( ! isset( $screen->id ) ) { + return; + } $page = $screen->id; @@ -1088,7 +1110,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. * @@ -1096,9 +1118,9 @@ function remove_meta_box($id, $screen, $context) { * * @uses global $wp_meta_boxes Used to retrieve registered meta boxes. * - * @param string|object $screen The screen identifier. - * @param string $context The meta box context. - * @param mixed $object gets passed to the section callback function as first parameter. + * @param string|object $screen The screen identifier. + * @param string $context The meta box context. + * @param mixed $object gets passed to the section callback function as first parameter. * @return int number of meta boxes as accordion sections. */ function do_accordion_sections( $screen, $context, $object ) { @@ -1139,7 +1161,7 @@ function do_accordion_sections( $screen, $context, $object ) {
  • - +

    @@ -1174,21 +1196,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'; } @@ -1207,26 +1231,39 @@ function add_settings_section($id, $title, $callback, $page) { * values to show. * * @since 2.7.0 + * @since 4.2.0 The `$class` argument was added. * * @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 settings page in which to show the box (default, ...). - * @param array $args Additional arguments + * @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 + * in a `
  • ` element when the + * field is output. + * } */ 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.' ) ); + _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'; } @@ -1244,7 +1281,7 @@ function add_settings_field($id, $title, $callback, $page, $section = 'default', * @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 + * @param string $page The slug name of the page whose settings sections you want to output */ function do_settings_sections( $page ) { global $wp_settings_sections, $wp_settings_fields; @@ -1254,7 +1291,7 @@ function do_settings_sections( $page ) { foreach ( (array) $wp_settings_sections[$page] as $section ) { if ( $section['title'] ) - echo "

    {$section['title']}

    \n"; + echo "

    {$section['title']}

    \n"; if ( $section['callback'] ) call_user_func( $section['callback'], $section ); @@ -1288,11 +1325,20 @@ function do_settings_fields($page, $section) { return; foreach ( (array) $wp_settings_fields[$page][$section] as $field ) { - echo ''; - if ( !empty($field['args']['label_for']) ) + $class = ''; + + if ( ! empty( $field['args']['class'] ) ) { + $class = ' class="' . esc_attr( $field['args']['class'] ) . '"'; + } + + echo ""; + + if ( ! empty( $field['args']['label_for'] ) ) { echo ''; - else + } else { echo ''; + } + echo ''; @@ -1315,15 +1361,14 @@ function do_settings_fields($page, $section) { * * @since 3.0.0 * - * @todo Properly document optional arguments as such. - * * @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 `

    ` tags). - * @param string $type The type of message it is, controls HTML class. Use 'error' or 'updated'. + * @param string $type Optional. Message type, controls HTML class. Accepts 'error' or 'updated'. + * Default 'error'. */ function add_settings_error( $setting, $code, $message, $type = 'error' ) { global $wp_settings_errors; @@ -1348,7 +1393,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 * @@ -1393,16 +1439,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. * @@ -1414,9 +1460,10 @@ function get_settings_errors( $setting = '', $sanitize = false ) { * * @since 3.0.0 * - * @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. - * @param boolean $hide_on_update If set to true errors will not be shown if the settings page has already been submitted. + * @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. */ function settings_errors( $setting = '', $sanitize = false, $hide_on_update = false ) { @@ -1431,7 +1478,7 @@ function settings_errors( $setting = '', $sanitize = false, $hide_on_update = fa $output = ''; foreach ( $settings_errors as $key => $details ) { $css_id = 'setting-error-' . $details['code']; - $css_class = $details['type'] . ' settings-error'; + $css_class = $details['type'] . ' settings-error notice is-dismissible'; $output .= "

    \n"; $output .= "

    {$details['message']}

    "; $output .= "
    \n"; @@ -1440,7 +1487,7 @@ function settings_errors( $setting = '', $sanitize = false, $hide_on_update = fa } /** - * {@internal Missing Short Description}} + * Outputs the modal window used for attaching media to posts or pages in the media-listing screen. * * @since 2.7.0 * @@ -1450,8 +1497,8 @@ function find_posts_div($found_action = '') { ?>
    "; $r .= "\n\t\t
    "; @@ -626,6 +574,8 @@ function _list_meta_row( $entry, &$count ) { * * @since 1.2.0 * + * @global wpdb $wpdb WordPress database abstraction object. + * * @param WP_Post $post Optional. The post being edited. */ function meta_form( $post = null ) { @@ -633,21 +583,37 @@ function meta_form( $post = null ) { $post = get_post( $post ); /** - * Filter the number of custom fields to retrieve for the drop-down - * 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. * - * @since 2.1.0 + * @since 4.4.0 * - * @param int $limit Number of custom fields to retrieve. Default 30. + * @param array|null $keys Pre-defined meta keys to be used in place of a postmeta query. Default null. + * @param WP_Post $post The current post object. */ - $limit = apply_filters( 'postmeta_form_limit', 30 ); - $sql = "SELECT meta_key - FROM $wpdb->postmeta - GROUP BY meta_key - HAVING meta_key NOT LIKE %s - ORDER BY meta_key - LIMIT %d"; - $keys = $wpdb->get_col( $wpdb->prepare( $sql, $wpdb->esc_like( '_' ) . '%', $limit ) ); + $keys = apply_filters( 'postmeta_form_keys', null, $post ); + + if ( null === $keys ) { + /** + * Filters the number of custom fields to retrieve for the drop-down + * in the Custom Fields meta box. + * + * @since 2.1.0 + * + * @param int $limit Number of custom fields to retrieve. Default 30. + */ + $limit = apply_filters( 'postmeta_form_limit', 30 ); + $sql = "SELECT DISTINCT meta_key + FROM $wpdb->postmeta + WHERE meta_key NOT BETWEEN '_' AND '_z' + HAVING meta_key NOT LIKE %s + ORDER BY meta_key + LIMIT %d"; + $keys = $wpdb->get_col( $wpdb->prepare( $sql, $wpdb->esc_like( '_' ) . '%', $limit ) ); + } + if ( $keys ) { natcasesort( $keys ); $meta_key_input_id = 'metakeyselect'; @@ -692,7 +658,7 @@ function meta_form( $post = null ) {
    - 'newmeta-submit', 'data-wp-lists' => 'add:the-list:newmeta' ) ); ?> + 'newmeta-submit', 'data-wp-lists' => 'add:the-list:newmeta' ) ); ?>
    ' . $field['title'] . ''; call_user_func($field['callback'], $field['args']); echo '