X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/f34e3c5e1f96e4214461c0b72b651ad48ccffe50..refs/tags/wordpress-4.6-scripts:/wp-includes/category-template.php diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php index 6bac6c11..7063c2d4 100644 --- a/wp-includes/category-template.php +++ b/wp-includes/category-template.php @@ -1,9 +1,10 @@ ` element should have the HTML5 'required' attribute. + * Default false. * } * @return string HTML content only if 'echo' argument is 0. */ function wp_dropdown_categories( $args = '' ) { $defaults = array( - 'show_option_all' => '', 'show_option_none' => '', - 'orderby' => 'id', 'order' => 'ASC', - 'show_count' => 0, - 'hide_empty' => 1, 'child_of' => 0, - 'exclude' => '', 'echo' => 1, - 'selected' => 0, 'hierarchical' => 0, - 'name' => 'cat', 'id' => '', - 'class' => 'postform', 'depth' => 0, - 'tab_index' => 0, 'taxonomy' => 'category', - 'hide_if_empty' => false, 'option_none_value' => -1, - 'value_field' => 'term_id', + 'show_option_all' => '', + 'show_option_none' => '', + 'orderby' => 'id', + 'order' => 'ASC', + 'show_count' => 0, + 'hide_empty' => 1, + 'child_of' => 0, + 'exclude' => '', + 'echo' => 1, + 'selected' => 0, + 'hierarchical' => 0, + 'name' => 'cat', + 'id' => '', + 'class' => 'postform', + 'depth' => 0, + 'tab_index' => 0, + 'taxonomy' => 'category', + 'hide_if_empty' => false, + 'option_none_value' => -1, + 'value_field' => 'term_id', + 'required' => false, ); $defaults['selected'] = ( is_category() ) ? get_query_var( 'cat' ) : 0; // Back compat. if ( isset( $args['type'] ) && 'link' == $args['type'] ) { - _deprecated_argument( __FUNCTION__, '3.0', '' ); + /* translators: 1: "type => link", 2: "taxonomy => link_category" alternative */ + _deprecated_argument( __FUNCTION__, '3.0.0', + sprintf( __( '%1$s is deprecated. Use %2$s instead.' ), + 'type => link', + 'taxonomy => link_category' + ) + ); $args['taxonomy'] = 'link_category'; } @@ -386,16 +418,17 @@ function wp_dropdown_categories( $args = '' ) { $name = esc_attr( $r['name'] ); $class = esc_attr( $r['class'] ); $id = $r['id'] ? esc_attr( $r['id'] ) : $name; + $required = $r['required'] ? 'required' : ''; if ( ! $r['hide_if_empty'] || ! empty( $categories ) ) { - $output = "\n"; } else { $output = ''; } if ( empty( $categories ) && ! $r['hide_if_empty'] && ! empty( $r['show_option_none'] ) ) { /** - * Filter a taxonomy drop-down display element. + * Filters a taxonomy drop-down display element. * * A variety of taxonomy drop-down display elements can be modified * just prior to display via this filter. Filterable arguments include @@ -442,7 +475,7 @@ function wp_dropdown_categories( $args = '' ) { $output .= "\n"; } /** - * Filter the taxonomy drop-down output. + * Filters the taxonomy drop-down output. * * @since 2.1.0 * @@ -460,47 +493,78 @@ function wp_dropdown_categories( $args = '' ) { /** * Display or retrieve the HTML list of categories. * - * The list of arguments is below: - * 'show_option_all' (string) - Text to display for showing all categories. - * 'orderby' (string) default is 'ID' - What column to use for ordering the - * categories. - * 'order' (string) default is 'ASC' - What direction to order categories. - * 'show_count' (bool|int) default is 0 - Whether to show how many posts are - * in the category. - * 'hide_empty' (bool|int) default is 1 - Whether to hide categories that - * don't have any posts attached to them. - * 'use_desc_for_title' (bool|int) default is 1 - Whether to use the - * category description as the title attribute. - * 'feed' - See {@link get_categories()}. - * 'feed_type' - See {@link get_categories()}. - * 'feed_image' - See {@link get_categories()}. - * 'child_of' (int) default is 0 - See {@link get_categories()}. - * 'exclude' (string) - See {@link get_categories()}. - * 'exclude_tree' (string) - See {@link get_categories()}. - * 'echo' (bool|int) default is 1 - Whether to display or retrieve content. - * 'current_category' (int) - See {@link get_categories()}. - * 'hierarchical' (bool) - See {@link get_categories()}. - * 'title_li' (string) - See {@link get_categories()}. - * 'depth' (int) - The max depth. - * * @since 2.1.0 + * @since 4.4.0 Introduced the `hide_title_if_empty` and `separator` arguments. The `current_category` argument was modified to + * optionally accept an array of values. * - * @param string|array $args Optional. Override default arguments. + * @param string|array $args { + * Array of optional arguments. + * + * @type int $child_of Term ID to retrieve child terms of. See get_terms(). Default 0. + * @type int|array $current_category ID of category, or array of IDs of categories, that should get the + * 'current-cat' class. Default 0. + * @type int $depth Category depth. Used for tab indentation. Default 0. + * @type bool|int $echo True to echo markup, false to return it. Default 1. + * @type array|string $exclude Array or comma/space-separated string of term IDs to exclude. + * If `$hierarchical` is true, descendants of `$exclude` terms will also + * be excluded; see `$exclude_tree`. See get_terms(). + * Default empty string. + * @type array|string $exclude_tree Array or comma/space-separated string of term IDs to exclude, along + * with their descendants. See get_terms(). Default empty string. + * @type string $feed Text to use for the feed link. Default 'Feed for all posts filed + * under [cat name]'. + * @type string $feed_image URL of an image to use for the feed link. Default empty string. + * @type string $feed_type Feed type. Used to build feed link. See get_term_feed_link(). + * Default empty string (default feed). + * @type bool|int $hide_empty Whether to hide categories that don't have any posts attached to them. + * Default 1. + * @type bool $hide_title_if_empty Whether to hide the `$title_li` element if there are no terms in + * the list. Default false (title will always be shown). + * @type bool $hierarchical Whether to include terms that have non-empty descendants. + * See get_terms(). Default true. + * @type string $order Which direction to order categories. Accepts 'ASC' or 'DESC'. + * Default 'ASC'. + * @type string $orderby The column to use for ordering categories. Default 'ID'. + * @type string $separator Separator between links. Default '
'. + * @type bool|int $show_count Whether to show how many posts are in the category. Default 0. + * @type string $show_option_all Text to display for showing all categories. Default empty string. + * @type string $show_option_none Text to display for the 'no categories' option. + * Default 'No categories'. + * @type string $style The style used to display the categories list. If 'list', categories + * will be output as an unordered list. If left empty or another value, + * categories will be output separated by `
` tags. Default 'list'. + * @type string $taxonomy Taxonomy name. Default 'category'. + * @type string $title_li Text to use for the list title `
  • ` element. Pass an empty string + * to disable. Default 'Categories'. + * @type bool|int $use_desc_for_title Whether to use the category description as the title attribute. + * Default 1. + * } * @return false|string HTML content only if 'echo' argument is 0. */ function wp_list_categories( $args = '' ) { $defaults = array( - 'show_option_all' => '', 'show_option_none' => __('No categories'), - 'orderby' => 'name', 'order' => 'ASC', - 'style' => 'list', - 'show_count' => 0, 'hide_empty' => 1, - 'use_desc_for_title' => 1, 'child_of' => 0, - 'feed' => '', 'feed_type' => '', - 'feed_image' => '', 'exclude' => '', - 'exclude_tree' => '', 'current_category' => 0, - 'hierarchical' => true, 'title_li' => __( 'Categories' ), - 'echo' => 1, 'depth' => 0, - 'taxonomy' => 'category' + 'child_of' => 0, + 'current_category' => 0, + 'depth' => 0, + 'echo' => 1, + 'exclude' => '', + 'exclude_tree' => '', + 'feed' => '', + 'feed_image' => '', + 'feed_type' => '', + 'hide_empty' => 1, + 'hide_title_if_empty' => false, + 'hierarchical' => true, + 'order' => 'ASC', + 'orderby' => 'name', + 'separator' => '
    ', + 'show_count' => 0, + 'show_option_all' => '', + 'show_option_none' => __( 'No categories' ), + 'style' => 'list', + 'taxonomy' => 'category', + 'title_li' => __( 'Categories' ), + 'use_desc_for_title' => 1, ); $r = wp_parse_args( $args, $defaults ); @@ -508,8 +572,19 @@ function wp_list_categories( $args = '' ) { if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] ) $r['pad_counts'] = true; + // Descendants of exclusions should be excluded too. if ( true == $r['hierarchical'] ) { - $r['exclude_tree'] = $r['exclude']; + $exclude_tree = array(); + + if ( $r['exclude_tree'] ) { + $exclude_tree = array_merge( $exclude_tree, wp_parse_id_list( $r['exclude_tree'] ) ); + } + + if ( $r['exclude'] ) { + $exclude_tree = array_merge( $exclude_tree, wp_parse_id_list( $r['exclude'] ) ); + } + + $r['exclude_tree'] = $exclude_tree; $r['exclude'] = ''; } @@ -526,7 +601,7 @@ function wp_list_categories( $args = '' ) { $categories = get_categories( $r ); $output = ''; - if ( $r['title_li'] && 'list' == $r['style'] ) { + if ( $r['title_li'] && 'list' == $r['style'] && ( ! empty( $categories ) || ! $r['hide_title_if_empty'] ) ) { $output = '
  • ' . $r['title_li'] . '
    • '; /** - * Filter the HTML output of a taxonomy list. + * Filters the HTML output of a taxonomy list. * * @since 2.1.0 * @@ -629,9 +708,8 @@ function wp_list_categories( $args = '' ) { * The 'post_type' argument is used only when 'link' is set to 'edit'. It determines the post_type * passed to edit.php for the popular tags edit links. * - * The 'exclude' and 'include' arguments are used for the {@link get_tags()} - * function. Only one should be used, because only one will be used and the - * other ignored, if they are both set. + * The 'exclude' and 'include' arguments are used for the get_tags() function. Only one + * should be used, because only one will be used and the other ignored, if they are both set. * * @since 2.3.0 * @@ -667,7 +745,7 @@ function wp_tag_cloud( $args = '' ) { $return = wp_generate_tag_cloud( $tags, $args ); // Here's where those top tags get sorted according to $args /** - * Filter the tag cloud output. + * Filters the tag cloud output. * * @since 2.3.0 * @@ -695,35 +773,44 @@ function default_topic_count_scale( $count ) { /** * Generates a tag cloud (heatmap) from provided data. * - * The text size is set by the 'smallest' and 'largest' arguments, which will - * use the 'unit' argument value for the CSS text size unit. The 'format' - * argument can be 'flat' (default), 'list', or 'array'. The flat value for the - * 'format' argument will separate tags with spaces. The list value for the - * 'format' argument will format the tags in a UL HTML list. The array value for - * the 'format' argument will return in PHP array type format. - * - * The 'tag_cloud_sort' filter allows you to override the sorting. - * Passed to the filter: $tags array and $args array, has to return the $tags array - * after sorting it. - * - * The 'orderby' argument will accept 'name' or 'count' and defaults to 'name'. - * The 'order' is the direction to sort, defaults to 'ASC' and can be 'DESC' or - * 'RAND'. - * - * The 'number' argument is how many tags to return. By default, the limit will - * be to return the entire tag cloud list. - * - * The 'topic_count_text' argument is a nooped plural from _n_noop() to generate the - * text for the tooltip of the tag link. - * - * The 'topic_count_text_callback' argument is a function, which given the count - * of the posts with that tag returns a text for the tooltip of the tag link. - * * @todo Complete functionality. * @since 2.3.0 * * @param array $tags List of tags. - * @param string|array $args Optional, override default arguments. + * @param string|array $args { + * Optional. Array of string of arguments for generating a tag cloud. + * + * @type int $smallest Smallest font size used to display tags. Paired + * with the value of `$unit`, to determine CSS text + * size unit. Default 8 (pt). + * @type int $largest Largest font size used to display tags. Paired + * with the value of `$unit`, to determine CSS text + * size unit. Default 22 (pt). + * @type string $unit CSS text size unit to use with the `$smallest` + * and `$largest` values. Accepts any valid CSS text + * size unit. Default 'pt'. + * @type int $number The number of tags to return. Accepts any + * positive integer or zero to return all. + * Default 0. + * @type string $format Format to display the tag cloud in. Accepts 'flat' + * (tags separated with spaces), 'list' (tags displayed + * in an unordered list), or 'array' (returns an array). + * Default 'flat'. + * @type string $separator HTML or text to separate the tags. Default "\n" (newline). + * @type string $orderby Value to order tags by. Accepts 'name' or 'count'. + * Default 'name'. The {@see 'tag_cloud_sort'} filter + * can also affect how tags are sorted. + * @type string $order How to order the tags. Accepts 'ASC' (ascending), + * 'DESC' (descending), or 'RAND' (random). Default 'ASC'. + * @type int|bool $filter Whether to enable filtering of the final output + * via {@see 'wp_generate_tag_cloud'}. Default 1|true. + * @type string $topic_count_text Nooped plural text from _n_noop() to supply to + * tag tooltips. Default null. + * @type callable $topic_count_text_callback Callback used to generate nooped plural text for + * tag tooltips based on the count. Default null. + * @type callable $topic_count_scale_callback Callback used to determine the tag count scaling + * value. Default default_topic_count_scale(). + * } * @return string|array Tag cloud as a string or an array, depending on 'format' argument. */ function wp_generate_tag_cloud( $tags, $args = '' ) { @@ -762,7 +849,7 @@ function wp_generate_tag_cloud( $tags, $args = '' ) { } /** - * Filter how the items in a tag cloud are sorted. + * Filters how the items in a tag cloud are sorted. * * @since 2.8.0 * @@ -840,7 +927,7 @@ function wp_generate_tag_cloud( $tags, $args = '' ) { } /** - * Filter the data used to generate the tag cloud. + * Filters the data used to generate the tag cloud. * * @since 4.3.0 * @@ -852,7 +939,8 @@ function wp_generate_tag_cloud( $tags, $args = '' ) { // generate the output links array foreach ( $tags_data as $key => $tag_data ) { - $a[] = "" . esc_html( $tag_data['name'] ) . ""; + $class = $tag_data['class'] . ' tag-link-position-' . ( $key + 1 ); + $a[] = "" . esc_html( $tag_data['name'] ) . ""; } switch ( $args['format'] ) { @@ -871,7 +959,7 @@ function wp_generate_tag_cloud( $tags, $args = '' ) { if ( $args['filter'] ) { /** - * Filter the generated output of a tag cloud. + * Filters the generated output of a tag cloud. * * The filter is only evaluated if a true value is passed * to the $filter argument in wp_generate_tag_cloud(). @@ -894,22 +982,33 @@ function wp_generate_tag_cloud( $tags, $args = '' ) { } /** - * Callback for comparing objects based on name + * Serves as a callback for comparing objects based on name. + * + * Used with `uasort()`. * * @since 3.1.0 * @access private - * @return int + * + * @param object $a The first object to compare. + * @param object $b The second object to compare. + * @return int Negative number if `$a->name` is less than `$b->name`, zero if they are equal, + * or greater than zero if `$a->name` is greater than `$b->name`. */ function _wp_object_name_sort_cb( $a, $b ) { return strnatcasecmp( $a->name, $b->name ); } /** - * Callback for comparing objects based on count + * Serves as a callback for comparing objects based on count. + * + * Used with `uasort()`. * * @since 3.1.0 * @access private - * @return bool + * + * @param object $a The first object to compare. + * @param object $b The second object to compare. + * @return bool Whether the count value for `$a` is greater than the count value for `$b`. */ function _wp_object_count_sort_cb( $a, $b ) { return ( $a->count > $b->count ); @@ -957,267 +1056,6 @@ function walk_category_dropdown_tree() { return call_user_func_array( array( $walker, 'walk' ), $args ); } -/** - * Create HTML list of categories. - * - * @package WordPress - * @since 2.1.0 - * @uses Walker - */ -class Walker_Category extends Walker { - /** - * What the class handles. - * - * @see Walker::$tree_type - * @since 2.1.0 - * @var string - */ - public $tree_type = 'category'; - - /** - * Database fields to use. - * - * @see Walker::$db_fields - * @since 2.1.0 - * @todo Decouple this - * @var array - */ - public $db_fields = array ('parent' => 'parent', 'id' => 'term_id'); - - /** - * Starts the list before the elements are added. - * - * @see Walker::start_lvl() - * - * @since 2.1.0 - * - * @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. Will only append content if style argument value is 'list'. - * @see wp_list_categories() - */ - public function start_lvl( &$output, $depth = 0, $args = array() ) { - if ( 'list' != $args['style'] ) - return; - - $indent = str_repeat("\t", $depth); - $output .= "$indent\n"; - } - - /** - * Start the element output. - * - * @see Walker::start_el() - * - * @since 2.1.0 - * - * @param string $output Passed by reference. Used to append additional content. - * @param object $category Category data object. - * @param int $depth Depth of category in reference to parents. Default 0. - * @param array $args An array of arguments. @see wp_list_categories() - * @param int $id ID of the current category. - */ - public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) { - /** This filter is documented in wp-includes/category-template.php */ - $cat_name = apply_filters( - 'list_cats', - esc_attr( $category->name ), - $category - ); - - // Don't generate an element if the category name is empty. - if ( ! $cat_name ) { - return; - } - - $link = 'description ) ) { - /** - * Filter the category description for display. - * - * @since 1.2.0 - * - * @param string $description Category description. - * @param object $category Category object. - */ - $link .= 'title="' . esc_attr( strip_tags( apply_filters( 'category_description', $category->description, $category ) ) ) . '"'; - } - - $link .= '>'; - $link .= $cat_name . ''; - - if ( ! empty( $args['feed_image'] ) || ! empty( $args['feed'] ) ) { - $link .= ' '; - - if ( empty( $args['feed_image'] ) ) { - $link .= '('; - } - - $link .= ''; - } - $link .= ''; - - if ( empty( $args['feed_image'] ) ) { - $link .= ')'; - } - } - - if ( ! empty( $args['show_count'] ) ) { - $link .= ' (' . number_format_i18n( $category->count ) . ')'; - } - if ( 'list' == $args['style'] ) { - $output .= "\tterm_id, - ); - - if ( ! empty( $args['current_category'] ) ) { - $_current_category = get_term( $args['current_category'], $category->taxonomy ); - if ( $category->term_id == $args['current_category'] ) { - $css_classes[] = 'current-cat'; - } elseif ( $category->term_id == $_current_category->parent ) { - $css_classes[] = 'current-cat-parent'; - } - } - - /** - * Filter the list of CSS classes to include with each category in the list. - * - * @since 4.2.0 - * - * @see wp_list_categories() - * - * @param array $css_classes An array of CSS classes to be applied to each list item. - * @param object $category Category data object. - * @param int $depth Depth of page, used for padding. - * @param array $args An array of wp_list_categories() arguments. - */ - $css_classes = implode( ' ', apply_filters( 'category_css_class', $css_classes, $category, $depth, $args ) ); - - $output .= ' class="' . $css_classes . '"'; - $output .= ">$link\n"; - } else { - $output .= "\t$link
    \n"; - } - } - - /** - * Ends the element output, if needed. - * - * @see Walker::end_el() - * - * @since 2.1.0 - * - * @param string $output Passed by reference. Used to append additional content. - * @param object $page Not used. - * @param int $depth Depth of category. Not used. - * @param array $args An array of arguments. Only uses 'list' for whether should append to output. @see wp_list_categories() - */ - public function end_el( &$output, $page, $depth = 0, $args = array() ) { - if ( 'list' != $args['style'] ) - return; - - $output .= "\n"; - } - -} - -/** - * Create HTML dropdown list of Categories. - * - * @package WordPress - * @since 2.1.0 - * @uses Walker - */ -class Walker_CategoryDropdown extends Walker { - /** - * @see Walker::$tree_type - * @since 2.1.0 - * @var string - */ - public $tree_type = 'category'; - - /** - * @see Walker::$db_fields - * @since 2.1.0 - * @todo Decouple this - * @var array - */ - public $db_fields = array ('parent' => 'parent', 'id' => 'term_id'); - - /** - * Start the element output. - * - * @see Walker::start_el() - * @since 2.1.0 - * - * @param string $output Passed by reference. Used to append additional content. - * @param object $category Category data object. - * @param int $depth Depth of category. Used for padding. - * @param array $args Uses 'selected', 'show_count', and 'value_field' keys, if they exist. - * See {@see wp_dropdown_categories()}. - */ - public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) { - $pad = str_repeat(' ', $depth * 3); - - /** This filter is documented in wp-includes/category-template.php */ - $cat_name = apply_filters( 'list_cats', $category->name, $category ); - - if ( isset( $args['value_field'] ) && isset( $category->{$args['value_field']} ) ) { - $value_field = $args['value_field']; - } else { - $value_field = 'term_id'; - } - - $output .= "\t\n"; - } -} - // // Tags // @@ -1254,7 +1092,7 @@ function get_tag_link( $tag ) { function get_the_tags( $id = 0 ) { /** - * Filter the array of tags for the given post. + * Filters the array of tags for the given post. * * @since 2.3.0 * @@ -1279,7 +1117,7 @@ function get_the_tags( $id = 0 ) { function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) { /** - * Filter the tags list for a given post. + * Filters the tags list for a given post. * * @since 2.3.0 * @@ -1347,7 +1185,7 @@ function term_description( $term = 0, $taxonomy = 'post_tag' ) { * * @param int|object $post Post ID or object. * @param string $taxonomy Taxonomy name. - * @return array|false|WP_Error Array of term objects on success, false if there are no terms + * @return array|false|WP_Error Array of WP_Term objects on success, false if there are no terms * or the post does not exist, WP_Error on failure. */ function get_the_terms( $post, $taxonomy ) { @@ -1357,11 +1195,14 @@ function get_the_terms( $post, $taxonomy ) { $terms = get_object_term_cache( $post->ID, $taxonomy ); if ( false === $terms ) { $terms = wp_get_object_terms( $post->ID, $taxonomy ); - wp_cache_add($post->ID, $terms, $taxonomy . '_relationships'); + if ( ! is_wp_error( $terms ) ) { + $term_ids = wp_list_pluck( $terms, 'term_id' ); + wp_cache_add( $post->ID, $term_ids, $taxonomy . '_relationships' ); + } } /** - * Filter the list of terms attached to the given post. + * Filters the list of terms attached to the given post. * * @since 3.1.0 * @@ -1409,7 +1250,7 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' } /** - * Filter the term links for a given taxonomy. + * Filters the term links for a given taxonomy. * * The dynamic portion of the filter name, `$taxonomy`, refers * to the taxonomy slug. @@ -1442,7 +1283,7 @@ function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' ) { return false; /** - * Filter the list of terms to display. + * Filters the list of terms to display. * * @since 2.9.0 *