* @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' );
}
/**
- * 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.
return apply_filters( 'get_the_categories', $categories, $id );
}
-/**
- * Sort categories by name.
- *
- * Used by usort() as a callback, should not be used directly. Can actually be
- * used to sort any term object.
- *
- * @since 2.3.0
- * @access private
- *
- * @param object $a
- * @param object $b
- * @return int
- */
-function _usort_terms_by_name( $a, $b ) {
- return strcmp( $a->name, $b->name );
-}
-
-/**
- * Sort categories by ID.
- *
- * Used by usort() as a callback, should not be used directly. Can actually be
- * used to sort any term object.
- *
- * @since 2.3.0
- * @access private
- *
- * @param object $a
- * @param object $b
- * @return int
- */
-function _usort_terms_by_ID( $a, $b ) {
- if ( $a->term_id > $b->term_id )
- return 1;
- elseif ( $a->term_id < $b->term_id )
- return -1;
- else
- return 0;
-}
-
/**
* Retrieve category name based on category ID.
*
}
/**
- * Filter the categories before building the category list.
+ * Filters the categories before building the category list.
*
* @since 4.4.0
*
}
/**
- * Filter the category or list of categories.
+ * Filters the category or list of categories.
*
* @since 1.2.0
*
}
/**
- * Check if the current post in within any of the given categories.
+ * Check if the current post is within any of the given categories.
*
* The given categories are checked against the post's categories' term_ids, names and slugs.
* Categories given as integers will only be checked against the post's categories' term_ids.
*
* @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.
* 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 `<select>` 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'] ) {
/* translators: 1: "type => link", 2: "taxonomy => link_category" alternative */
- _deprecated_argument( __FUNCTION__, '3.0',
+ _deprecated_argument( __FUNCTION__, '3.0.0',
sprintf( __( '%1$s is deprecated. Use %2$s instead.' ),
'<code>type => link</code>',
'<code>taxonomy => link_category</code>'
$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 = "<select name='$name' id='$id' class='$class' $tab_index_attribute>\n";
+ $output = "<select $required name='$name' id='$id' class='$class' $tab_index_attribute>\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
$output .= "</select>\n";
}
/**
- * Filter the taxonomy drop-down output.
+ * Filters the taxonomy drop-down output.
*
* @since 2.1.0
*
* @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 `<li>` 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 '<br />'.
+ * @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 `<br>` tags. Default 'list'.
* @type string $taxonomy Taxonomy name. Default 'category'.
+ * @type string $title_li Text to use for the list title `<li>` 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' => '<br />',
- 'taxonomy' => 'category'
+ 'hierarchical' => true,
+ 'order' => 'ASC',
+ 'orderby' => 'name',
+ 'separator' => '<br />',
+ '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 );
$output .= walk_category_tree( $categories, $depth, $r );
}
- if ( $r['title_li'] && 'list' == $r['style'] )
+ if ( $r['title_li'] && 'list' == $r['style'] && ( ! empty( $categories ) || ! $r['hide_title_if_empty'] ) ) {
$output .= '</ul></li>';
+ }
/**
- * Filter the HTML output of a taxonomy list.
+ * Filters the HTML output of a taxonomy list.
*
* @since 2.1.0
*
* 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
*
$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
*
/**
* 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 = '' ) {
}
/**
- * Filter how the items in a tag cloud are sorted.
+ * Filters how the items in a tag cloud are sorted.
*
* @since 2.8.0
*
$tags_data[] = array(
'id' => $tag_id,
'url' => '#' != $tag->link ? $tag->link : '#',
+ 'role' => '#' != $tag->link ? '' : ' role="button"',
'name' => $tag->name,
'title' => $title,
'slug' => $tag->slug,
}
/**
- * Filter the data used to generate the tag cloud.
+ * Filters the data used to generate the tag cloud.
*
* @since 4.3.0
*
// generate the output links array
foreach ( $tags_data as $key => $tag_data ) {
- $a[] = "<a href='" . esc_url( $tag_data['url'] ) . "' class='" . esc_attr( $tag_data['class'] ) . "' title='" . esc_attr( $tag_data['title'] ) . "' style='font-size: " . esc_attr( str_replace( ',', '.', $tag_data['font_size'] ) . $args['unit'] ) . ";'>" . esc_html( $tag_data['name'] ) . "</a>";
+ $class = $tag_data['class'] . ' tag-link-position-' . ( $key + 1 );
+ $a[] = "<a href='" . esc_url( $tag_data['url'] ) . "'" . $tag_data['role'] . " class='" . esc_attr( $class ) . "' title='" . esc_attr( $tag_data['title'] ) . "' style='font-size: " . esc_attr( str_replace( ',', '.', $tag_data['font_size'] ) . $args['unit'] ) . ";'>" . esc_html( $tag_data['name'] ) . "</a>";
}
switch ( $args['format'] ) {
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().
}
/**
- * 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 );
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
*
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
*
function the_tags( $before = null, $sep = ', ', $after = '' ) {
if ( null === $before )
$before = __('Tags: ');
- echo get_the_tag_list($before, $sep, $after);
+
+ $the_tags = get_the_tag_list( $before, $sep, $after );
+
+ if ( ! is_wp_error( $the_tags ) ) {
+ echo $the_tags;
+ }
}
/**
*
* @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 ) {
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
*
}
/**
- * 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.
*
* @param array $links An array of term links.
*/
- $term_links = apply_filters( "term_links-$taxonomy", $links );
+ $term_links = apply_filters( "term_links-{$taxonomy}", $links );
return $before . join( $sep, $term_links ) . $after;
}
return false;
/**
- * Filter the list of terms to display.
+ * Filters the list of terms to display.
*
* @since 2.9.0
*