X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/af50974463450c98503e763a7836a50e260461a9..53f4633144ed68c8b8fb5861f992b5489894a940:/wp-admin/includes/template.php diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index 425e40b0..d1a85870 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -82,17 +82,33 @@ class Walker_Category_Checklist extends Walker { } 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
  • " . - ''; + if ( ! empty( $args['list_only'] ) ) { + $aria_cheched = 'false'; + $inner_class = 'category'; + + if ( in_array( $category->term_id, $args['selected_cats'] ) ) { + $inner_class .= ' selected'; + $aria_cheched = 'true'; + } + + $output .= "\n" . '' . + ''; + } else { + $output .= "\n
  • " . + ''; + } } /** @@ -113,21 +129,23 @@ class Walker_Category_Checklist extends Walker { } /** - * Output an unordered list of checkbox input elements labelled - * with category names. + * Output an unordered list of checkbox input elements labeled 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 +161,25 @@ 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. + * @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. + * } */ function wp_terms_checklist( $post_id = 0, $args = array() ) { $defaults = array( @@ -176,7 +205,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 +219,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 ) { @@ -250,7 +281,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. @@ -301,11 +332,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 +359,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); @@ -403,13 +436,15 @@ function get_inline_data($post) { * * @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 * list table. @@ -432,14 +467,16 @@ 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` element when the + * field is output. + * } */ function add_settings_field($id, $title, $callback, $page, $section = 'default', $args = array()) { global $wp_settings_fields; @@ -1288,11 +1349,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 +1385,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; @@ -1414,9 +1483,9 @@ 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 +1500,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"; @@ -1505,7 +1574,7 @@ function _draft_or_post_title( $post = 0 ) { $title = get_the_title( $post ); if ( empty( $title ) ) $title = __( '(no title)' ); - return $title; + return esc_html( $title ); } /** @@ -1515,7 +1584,6 @@ function _draft_or_post_title( $post = 0 ) { * should only be used when {@link the_search_query()} cannot. * * @since 2.7.0 - * */ function _admin_search_query() { echo isset($_REQUEST['s']) ? esc_attr( wp_unslash( $_REQUEST['s'] ) ) : ''; @@ -1525,13 +1593,17 @@ function _admin_search_query() { * Generic Iframe header for use with Thickbox * * @since 2.7.0 - * @param string $title Title of the Iframe page. - * @param bool $limit_styles Limit styles to colour-related styles only (unless others are enqueued). * + * @global string $hook_suffix + * @global string $admin_body_class + * @global WP_Locale $wp_locale + * + * @param string $title Optional. Title of the Iframe page. Default empty. + * @param bool $deprecated Not used. */ -function iframe_header( $title = '', $limit_styles = false ) { +function iframe_header( $title = '', $deprecated = false ) { show_admin_bar( false ); - global $hook_suffix, $current_user, $admin_body_class, $wp_locale; + global $hook_suffix, $admin_body_class, $wp_locale; $admin_body_class = preg_replace('/[^a-z0-9_-]+/i', '-', $hook_suffix); $current_screen = get_current_screen(); @@ -1544,7 +1616,6 @@ function iframe_header( $title = '', $limit_styles = false ) { wp_enqueue_style( 'colors' ); ?> - class="wp-admin wp-core-ui no-js iframe "> + class="wp-admin wp-core-ui no-js iframe "> ID) ) $post_states['sticky'] = __('Sticky'); + if ( 'future' === $post->post_status ) { + $post_states['scheduled'] = __( 'Scheduled' ); + } + + if ( get_option( 'page_on_front' ) == $post->ID ) { + $post_states['page_on_front'] = __( 'Front Page' ); + } + + if ( get_option( 'page_for_posts' ) == $post->ID ) { + $post_states['page_for_posts'] = __( 'Posts Page' ); + } + /** - * Filter the default post display states used in the Posts list table. + * Filter the default post display states used in the posts list table. * * @since 2.8.0 * - * @param array $post_states An array of post display states. Values include 'Password protected', - * 'Private', 'Draft', 'Pending', and 'Sticky'. + * @param array $post_states An array of post display states. * @param int $post The post ID. */ $post_states = apply_filters( 'display_post_states', $post_states, $post ); @@ -1673,6 +1759,10 @@ function _post_states($post) { } +/** + * + * @param WP_Post $post + */ function _media_states( $post ) { $media_states = array(); $stylesheet = get_option('stylesheet'); @@ -1689,13 +1779,17 @@ function _media_states( $post ) { $media_states[] = __( 'Background Image' ); } + if ( $post->ID == get_option( 'site_icon' ) ) { + $media_states[] = __( 'Site Icon' ); + } + /** * Filter the default media display states for items in the Media list table. * * @since 3.2.0 * * @param array $media_states An array of media states. Default 'Header Image', - * 'Background Image'. + * 'Background Image', 'Site Icon'. */ $media_states = apply_filters( 'display_media_states', $media_states ); @@ -1724,7 +1818,6 @@ function _media_states( $post ) { function compression_test() { ?> '1' ). - * These attributes will be output 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. + * @param string $text Optional. The text of the button. Default 'Save Changes'. + * @param string $type Optional. The type of button. Accepts 'primary', 'secondary', + * or 'delete'. Default 'primary large'. + * @param string $name Optional. 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. Default 'submit'. + * @param bool $wrap Optional. True if the output button should be wrapped in a paragraph + * tag, false otherwise. Default true. + * @param array|string $other_attributes Optional. Other attributes that should be output with the button, + * mapping attributes to their values, such as `array( 'tabindex' => '1' )`. + * These attributes will be output as `attribute="value"`, such as + * `tabindex="1"`. Other attributes can also be provided as a string such + * as `tabindex="1"`, though the array format is typically cleaner. + * Default empty. + * @return string Submit button HTML. */ -function get_submit_button( $text = null, $type = 'primary large', $name = 'submit', $wrap = true, $other_attributes = null ) { +function get_submit_button( $text = '', $type = 'primary large', $name = 'submit', $wrap = true, $other_attributes = '' ) { if ( ! is_array( $type ) ) $type = explode( ' ', $type ); @@ -1849,11 +1945,15 @@ function get_submit_button( $text = null, $type = 'primary large', $name = 'subm 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 + } elseif ( ! empty( $other_attributes ) ) { // Attributes provided as a string $attributes = $other_attributes; } - $button = ''; if ( $wrap ) { @@ -1863,6 +1963,10 @@ function get_submit_button( $text = null, $type = 'primary large', $name = 'subm return $button; } +/** + * + * @global bool $is_IE + */ function _wp_admin_html_begin() { global $is_IE; @@ -1905,19 +2009,27 @@ final class WP_Internal_Pointers { * * Individual pointers (e.g. wp390_widgets) can be disabled using the following: * remove_action( 'admin_print_footer_scripts', array( 'WP_Internal_Pointers', 'pointer_wp390_widgets' ) ); + * + * @static + * + * @param string $hook_suffix The current admin page. */ public static function enqueue_scripts( $hook_suffix ) { /* * Register feature pointers - * Format: array( hook_suffix => pointer_id ) + * + * Format: + * array( + * hook_suffix => pointer callback + * ) + * + * Example: + * array( + * 'themes.php' => 'wp390_widgets' + * ) */ - $registered_pointers = array( - 'post-new.php' => 'wp410_dfw', - 'post.php' => 'wp410_dfw', - 'edit.php' => 'wp360_locks', - 'widgets.php' => 'wp390_widgets', - 'themes.php' => 'wp390_widgets', + // None currently ); // Check if screen related pointer is registered @@ -1926,8 +2038,21 @@ final class WP_Internal_Pointers { $pointers = (array) $registered_pointers[ $hook_suffix ]; + /* + * Specify required capabilities for feature pointers + * + * Format: + * array( + * pointer callback => Array of required capabilities + * ) + * + * Example: + * array( + * 'wp390_widgets' => array( 'edit_theme_options' ) + * ) + */ $caps_required = array( - 'wp390_widgets' => array( 'edit_theme_options' ), + // None currently ); // Get dismissed pointers @@ -1960,6 +2085,8 @@ final class WP_Internal_Pointers { * * @since 3.3.0 * + * @static + * * @param string $pointer_id The pointer ID. * @param string $selector The HTML elements, on which the pointer should be attached. * @param array $args Arguments to be passed to the pointer JS (see wp-pointer.js). @@ -1970,7 +2097,6 @@ final class WP_Internal_Pointers { ?> ' . __( 'Edit Lock' ) . ''; - $content .= '

    ' . __( 'Someone else is editing this. No need to refresh; the lock will disappear when they’re done.' ) . '

    '; - - self::print_js( 'wp360_locks', 'tr.wp-locked .locked-indicator', array( - 'content' => $content, - 'position' => array( 'edge' => 'left', 'align' => 'left' ), - ) ); - } - - public static function pointer_wp390_widgets() { - if ( ! current_theme_supports( 'widgets' ) ) { - return; - } - - $content = '

    ' . __( 'New Feature: Live Widget Previews' ) . '

    '; - $content .= '

    ' . __( 'Add, edit, and play around with your widgets from the Customizer.' ) . ' ' . __( 'Preview your changes in real-time and only save them when you’re ready.' ) . '

    '; - - if ( 'themes' === get_current_screen()->id ) { - $selector = '.theme.active .customize'; - $position = array( 'edge' => is_rtl() ? 'right' : 'left', 'align' => 'center' ); - } else { - $selector = 'a[href^="customize.php"]'; - if ( is_rtl() ) { - $position = array( 'edge' => 'right', 'align' => 'center', 'my' => 'right-5px' ); - } else { - $position = array( 'edge' => 'left', 'align' => 'center', 'my' => 'left-5px' ); - } - } - - self::print_js( 'wp390_widgets', $selector, array( - 'content' => $content, - 'position' => $position, - ) ); - } - - public static function pointer_wp410_dfw() { - // Don't show when editor-scrolling is not used. - if ( empty( $GLOBALS['_wp_editor_expand'] ) ) { - return; - } - - $content = '

    ' . __( 'Distraction-Free Writing' ) . '

    '; - $content .= '

    ' . __( 'Enable distraction-free writing mode, and everything surrounding the editor will fade away when you start typing. Move your mouse out of the editor to reveal everything again.' ) . '

    '; - - if ( is_rtl() ) { - $position = array( 'edge' => 'left', 'align' => 'center', 'my' => 'left+40 top-11', 'at' => 'left top' ); - } else { - $position = array( 'edge' => 'right', 'align' => 'center', 'my' => 'right-40 top-11', 'at' => 'right top' ); - } - - self::print_js( 'wp410_dfw', '#wp-content-wrap', array( - 'content' => $content, - 'position' => $position, - ) ); - } + public static function pointer_wp360_locks() {} + public static function pointer_wp390_widgets() {} + public static function pointer_wp410_dfw() {} /** * Prevents new users from seeing existing 'new feature' pointers. * * @since 3.3.0 + * + * @static + * + * @param int $user_id User ID. */ public static function dismiss_pointers_for_new_users( $user_id ) { - add_user_meta( $user_id, 'dismissed_wp_pointers', 'wp360_locks,wp390_widgets' ); + add_user_meta( $user_id, 'dismissed_wp_pointers', '' ); } } -add_action( 'admin_enqueue_scripts', array( 'WP_Internal_Pointers', 'enqueue_scripts' ) ); -add_action( 'user_register', array( 'WP_Internal_Pointers', 'dismiss_pointers_for_new_users' ) ); - /** * Convert a screen string to a screen object * @@ -2176,3 +2244,13 @@ function wp_star_rating( $args = array() ) { echo str_repeat( '
    ', $empty_stars); echo '
    '; } + +/** + * Output a notice when editing the page for posts (internal use only). + * + * @ignore + * @since 4.2.0 + */ +function _wp_posts_page_notice() { + echo '

    ' . __( 'You are currently editing the page that shows your latest posts.' ) . '

    '; +}
    "; $r .= "\n\t\t
    "; @@ -626,6 +660,8 @@ function _list_meta_row( $entry, &$count ) { * * @since 1.2.0 * + * @global wpdb $wpdb + * * @param WP_Post $post Optional. The post being edited. */ function meta_form( $post = null ) { @@ -641,9 +677,9 @@ function meta_form( $post = null ) { * @param int $limit Number of custom fields to retrieve. Default 30. */ $limit = apply_filters( 'postmeta_form_limit', 30 ); - $sql = "SELECT meta_key + $sql = "SELECT DISTINCT meta_key FROM $wpdb->postmeta - GROUP BY meta_key + WHERE meta_key NOT BETWEEN '_' AND '_z' HAVING meta_key NOT LIKE %s ORDER BY meta_key LIMIT %d"; @@ -707,10 +743,13 @@ function meta_form( $post = null ) { * * @since 0.71 * - * @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. + * @global WP_Locale $wp_locale + * @global object $comment + * + * @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 ) { @@ -742,23 +781,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 '
    '; @@ -809,6 +849,8 @@ function page_template_dropdown( $default = '' ) { * * @since 1.5.0 * + * @global wpdb $wpdb + * * @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. @@ -842,9 +884,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 = ''; @@ -904,6 +946,8 @@ function wp_import_upload_form( $action ) { * * @since 2.5.0 * + * @global array $wp_meta_boxes + * * @param string $id String for use in the 'id' attribute of tags. * @param string $title Title of the meta box. * @param callback $callback Function that fills the box with the desired content. @@ -992,10 +1036,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 ) { @@ -1060,9 +1106,11 @@ function do_meta_boxes( $screen, $context, $object ) { * * @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'). + * @global array $wp_meta_boxes + * + * @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'). */ function remove_meta_box($id, $screen, $context) { global $wp_meta_boxes; @@ -1096,9 +1144,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 ) { @@ -1174,10 +1222,10 @@ 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 $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 $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; @@ -1207,15 +1255,28 @@ 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 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 { + * Optional. Extra arguments used when outputting the field. + * + * @type string $label_for When supplied, the setting title will be wrapped + * in a `
    ' . $field['title'] . ''; call_user_func($field['callback'], $field['args']); echo '