X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..7f1521bf193b382565eb753043c161f4cb3fcda7:/wp-admin/includes/template.php diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index 30dcf0fc..03ff4e7d 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -13,12 +13,13 @@ // /** - * Walker to output an unordered list of category checkbox elements. + * Walker to output an unordered list of category checkbox input elements. + * + * @since 2.5.1 * * @see Walker * @see wp_category_checklist() * @see wp_terms_checklist() - * @since 2.5.1 */ class Walker_Category_Checklist extends Walker { public $tree_type = 'category'; @@ -81,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
  • " . + ''; + } } /** @@ -112,18 +129,23 @@ class Walker_Category_Checklist extends Walker { } /** - * Output an unordered list of checkbox elements labelled - * with category names. + * Output an unordered list of checkbox input elements labeled with category names. * - * @see wp_terms_checklist() * @since 2.5.1 * - * @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. + * @see wp_terms_checklist() + * + * @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( @@ -137,13 +159,27 @@ function wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $select } /** - * Output an unordered list of checkbox elements labelled - * with term names. Taxonomy independent version of wp_category_checklist(). + * Output an unordered list of checkbox input elements labelled with term names. + * + * Taxonomy-independent version of wp_category_checklist(). * * @since 3.0.0 * - * @param int $post_id - * @param array $args + * @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( @@ -169,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']; @@ -183,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 ) { @@ -236,14 +274,14 @@ function wp_terms_checklist( $post_id = 0, $args = array() ) { * Retrieve a list of the most popular terms from the specified taxonomy. * * If the $echo argument is true then the elements for a list of checkbox - * elements labelled with the names of the selected terms is output. + * `` elements labelled with the names of the selected terms is output. * If the $post_ID global isn't empty then the terms associated with that * post will be marked as checked. * * @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. @@ -289,16 +327,19 @@ function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $ech * * @since 2.5.1 * - * @param unknown_type $link_id + * @param int $link_id */ 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; } @@ -318,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 unknown_type $post + * @param WP_Post $post Post object. */ function get_inline_data($post) { $post_type_object = get_post_type_object($post->post_type); @@ -396,12 +436,13 @@ function get_inline_data($post) { * * @since 2.7.0 * - * @param unknown_type $position - * @param unknown_type $checkbox - * @param unknown_type $mode + * @param int $position + * @param bool $checkbox + * @param string $mode + * @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. @@ -424,14 +465,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; @@ -1272,7 +1322,7 @@ function do_settings_sections( $page ) { * @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. + * @param string $section Slug title of the settings section who's fields you want to show. */ function do_settings_fields($page, $section) { global $wp_settings_fields; @@ -1281,11 +1331,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 ''; @@ -1311,9 +1370,11 @@ function do_settings_fields($page, $section) { * @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'. + * @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 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; @@ -1383,20 +1444,24 @@ function get_settings_errors( $setting = '', $sanitize = false ) { } /** - * Display settings errors registered by add_settings_error() + * Display settings errors registered by {@see add_settings_error()}. * - * Part of the Settings API. Outputs a

    for each error retrieved by get_settings_errors(). + * Part of the Settings API. Outputs a div for each error retrieved by + * {@see 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 register_setting() + * 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()} * - * The $sanitize option is passed into get_settings_errors() and will re-run the setting sanitization + * The $sanitize option is passed into {@see get_settings_errors()} and will + * re-run the setting sanitization * on its current value. * - * The $hide_on_update option will cause errors to only show when the settings page is first loaded. - * if the user has already saved new values it will be hidden to avoid repeating messages already - * shown in the default error reporting after submission. This is useful to show general errors like missing - * settings when the user arrives at the settings page. + * The $hide_on_update option will cause errors to only show when the settings + * page is first loaded. if the user has already saved new values it will be + * hidden to avoid repeating messages already shown in the default error + * reporting after submission. This is useful to show general errors like + * missing settings when the user arrives at the settings page. * * @since 3.0.0 * @@ -1417,7 +1482,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"; @@ -1430,7 +1495,7 @@ function settings_errors( $setting = '', $sanitize = false, $hide_on_update = fa * * @since 2.7.0 * - * @param unknown_type $found_action + * @param string $found_action */ function find_posts_div($found_action = '') { ?> @@ -1468,7 +1533,6 @@ function find_posts_div($found_action = '') { * The password is passed through {@link esc_attr()} to ensure that it * is safe for placing in an html attribute. * - * @uses attr * @since 2.7.0 */ function the_post_password() { @@ -1492,7 +1556,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 ); } /** @@ -1501,9 +1565,7 @@ function _draft_or_post_title( $post = 0 ) { * A simple wrapper to display the "s" parameter in a GET URI. This function * should only be used when {@link the_search_query()} cannot. * - * @uses attr * @since 2.7.0 - * */ function _admin_search_query() { echo isset($_REQUEST['s']) ? esc_attr( wp_unslash( $_REQUEST['s'] ) ) : ''; @@ -1513,13 +1575,13 @@ 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). * + * @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(); @@ -1532,7 +1594,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 "> @@ -1634,13 +1694,20 @@ function _post_states($post) { if ( is_sticky($post->ID) ) $post_states['sticky'] = __('Sticky'); + 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 ); @@ -1709,7 +1776,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 ); @@ -1834,11 +1903,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 ) { @@ -1856,19 +1929,23 @@ function _wp_admin_html_begin() { if ( $is_IE ) @header('X-UA-Compatible: IE=edge'); -/** - * Fires inside the HTML tag in the admin header. - * - * @since 2.2.0 - */ ?> - - > + > @@ -1886,6 +1963,8 @@ 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' ) ); + * + * @param string $hook_suffix The current admin page. */ public static function enqueue_scripts( $hook_suffix ) { /* @@ -1894,8 +1973,8 @@ final class WP_Internal_Pointers { */ $registered_pointers = array( - 'post-new.php' => 'wp350_media', - 'post.php' => array( 'wp350_media', 'wp360_revisions' ), + 'post-new.php' => 'wp410_dfw', + 'post.php' => 'wp410_dfw', 'edit.php' => 'wp360_locks', 'widgets.php' => 'wp390_widgets', 'themes.php' => 'wp390_widgets', @@ -1908,7 +1987,6 @@ final class WP_Internal_Pointers { $pointers = (array) $registered_pointers[ $hook_suffix ]; $caps_required = array( - 'wp350_media' => array( 'upload_files' ), 'wp390_widgets' => array( 'edit_theme_options' ), ); @@ -1938,7 +2016,7 @@ final class WP_Internal_Pointers { } /** - * Print the pointer javascript data. + * Print the pointer JavaScript data. * * @since 3.3.0 * @@ -1952,9 +2030,8 @@ final class WP_Internal_Pointers { ?> ' . __( 'New Media Manager' ) . ''; - $content .= '

    ' . __( 'Uploading files and creating image galleries has a whole new look. Check it out!' ) . '

    '; - - self::print_js( 'wp350_media', '.insert-media', array( - 'content' => $content, - 'position' => array( 'edge' => is_rtl() ? 'right' : 'left', 'align' => 'center' ), - ) ); - } - - public static function pointer_wp360_revisions() { - $content = '

    ' . __( 'Compare Revisions' ) . '

    '; - $content .= '

    ' . __( 'View, compare, and restore other versions of this content on the improved revisions screen.' ) . '

    '; - - self::print_js( 'wp360_revisions', '.misc-pub-section.misc-pub-revisions', array( - 'content' => $content, - 'position' => array( 'edge' => is_rtl() ? 'left' : 'right', 'align' => 'center' ), - ) ); - } + public static function pointer_wp350_media() {} + public static function pointer_wp360_revisions() {} public static function pointer_wp360_locks() { if ( ! is_multi_author() ) { @@ -2029,13 +2087,13 @@ final class WP_Internal_Pointers { } $content = '

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

    '; - $content .= '

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

    '; + $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"]'; + $selector = 'a[href^="customize.php"]'; if ( is_rtl() ) { $position = array( 'edge' => 'right', 'align' => 'center', 'my' => 'right-5px' ); } else { @@ -2049,13 +2107,36 @@ final class WP_Internal_Pointers { ) ); } + 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, + ) ); + } + /** * Prevents new users from seeing existing 'new feature' pointers. * * @since 3.3.0 + * + * @param int $user_id User ID. */ public static function dismiss_pointers_for_new_users( $user_id ) { - add_user_meta( $user_id, 'dismissed_wp_pointers', 'wp350_media,wp360_revisions,wp360_locks,wp390_widgets' ); + add_user_meta( $user_id, 'dismissed_wp_pointers', 'wp360_locks,wp390_widgets' ); } } @@ -2087,7 +2168,7 @@ function convert_to_screen( $hook_name ) { */ function _local_storage_notice() { ?> -
    "; $r .= "\n\t\t
    "; @@ -701,7 +739,7 @@ function meta_form( $post = null ) { * * @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|bool $tab_index The tabindex attribute to add. Default 0. + * @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. */ @@ -781,7 +819,7 @@ function touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 ) { } /** - * Print out
    @@ -1200,15 +1237,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 '