X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9441756a895fb4fdc4bcf20e0d228cef622663ca..8d3bb1a5dcfdea9857d3c88c3751f09593e34dc8:/wp-includes/category-template.php diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php index a8d7941f..7063c2d4 100644 --- a/wp-includes/category-template.php +++ b/wp-includes/category-template.php @@ -74,7 +74,7 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename = * @since 0.71 * * @param int $id Optional, default to current post ID. The post ID. - * @return array Array of objects, one for each category assigned to the post. + * @return array Array of WP_Term objects, one for each category assigned to the post. */ function get_the_category( $id = false ) { $categories = get_the_terms( $id, 'category' ); @@ -88,7 +88,7 @@ function get_the_category( $id = false ) { } /** - * Filter the array of categories to return for a post. + * Filters the array of categories to return for a post. * * @since 3.1.0 * @since 4.4.0 Added `$id` parameter. @@ -176,7 +176,7 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false ) } /** - * Filter the categories before building the category list. + * Filters the categories before building the category list. * * @since 4.4.0 * @@ -242,7 +242,7 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false ) } /** - * Filter the category or list of categories. + * Filters the category or list of categories. * * @since 1.2.0 * @@ -314,6 +314,7 @@ function category_description( $category = 0 ) { * * @since 2.1.0 * @since 4.2.0 Introduced the `value_field` argument. + * @since 4.6.0 Introduced the `required` argument. * * @param string|array $args { * Optional. Array or string of arguments to generate a categories drop-down element. @@ -348,25 +349,37 @@ function category_description( $category = 0 ) { * of the option elements. Accepts any valid term field: 'term_id', 'name', * 'slug', 'term_group', 'term_taxonomy_id', 'taxonomy', 'description', * 'parent', 'count'. Default 'term_id'. - * @type string $taxonomy Name of the category to retrieve. Default 'category'. + * @type string|array $taxonomy Name of the category or categories to retrieve. Default 'category'. * @type bool $hide_if_empty True to skip generating markup if no categories are found. * Default false (create select element even if no categories are found). + * @type bool $required Whether the `\n"; + $output = "\n"; } /** - * Filter the taxonomy drop-down output. + * Filters the taxonomy drop-down output. * * @since 2.1.0 * @@ -486,58 +500,71 @@ function wp_dropdown_categories( $args = '' ) { * @param string|array $args { * Array of optional arguments. * - * @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 $orderby The column to use for ordering categories. Default 'ID'. - * @type string $order Which direction to order categories. Accepts 'ASC' or 'DESC'. - * Default 'ASC'. - * @type bool|int $show_count Whether to show how many posts are in the category. Default 0. - * @type bool|int $hide_empty Whether to hide categories that don't have any posts attached to them. - * Default 1. - * @type bool|int $use_desc_for_title Whether to use the category description as the title attribute. - * Default 1. - * @type string $feed Text to use for the feed link. Default 'Feed for all posts filed - * under [cat name]'. - * @type string $feed_type Feed type. Used to build feed link. See {@link get_term_feed_link()}. - * Default empty string (default feed). - * @type string $feed_image URL of an image to use for the feed link. Default empty string. - * @type int $child_of Term ID to retrieve child terms of. See {@link get_terms()}. Default 0. + * @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 {@link get_terms()}. + * 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 {@link get_terms()}. Default empty string. - * @type bool|int $echo True to echo markup, false to return it. Default 1. - * @type int|array $current_category ID of category, or array of IDs of categories, that should get the - * 'current-cat' class. Default 0. - * @type bool $hierarchical Whether to include terms that have non-empty descendants. - * See {@link get_terms()}. Default true. - * @type string $title_li Text to use for the list title `
  • ` element. Pass an empty string - * to disable. Default 'Categories'. + * 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 int $depth Category depth. Used for tab indentation. Default 0. + * @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' ), + '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, - 'echo' => 1, 'depth' => 0, - 'separator' => '
    ', - 'taxonomy' => 'category' + '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 ); @@ -640,7 +667,7 @@ function wp_list_categories( $args = '' ) { $output .= '
    • '; /** - * Filter the HTML output of a taxonomy list. + * Filters the HTML output of a taxonomy list. * * @since 2.1.0 * @@ -681,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 * @@ -719,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 * @@ -747,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 = '' ) { @@ -814,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 * @@ -892,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 * @@ -904,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'] ) { @@ -923,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(). @@ -946,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 ); @@ -1045,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 * @@ -1070,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 * @@ -1138,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 ) { @@ -1149,20 +1196,13 @@ function get_the_terms( $post, $taxonomy ) { if ( false === $terms ) { $terms = wp_get_object_terms( $post->ID, $taxonomy ); if ( ! is_wp_error( $terms ) ) { - $to_cache = array(); - foreach ( $terms as $key => $term ) { - $to_cache[ $key ] = $term->data; - } - wp_cache_add( $post->ID, $to_cache, $taxonomy . '_relationships' ); + $term_ids = wp_list_pluck( $terms, 'term_id' ); + wp_cache_add( $post->ID, $term_ids, $taxonomy . '_relationships' ); } } - if ( ! is_wp_error( $terms ) ) { - $terms = array_map( 'get_term', $terms ); - } - /** - * Filter the list of terms attached to the given post. + * Filters the list of terms attached to the given post. * * @since 3.1.0 * @@ -1210,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. @@ -1243,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 *