<?php
+/**
+ * Taxonomy API: Core category-specific template tags
+ *
+ * @package WordPress
+ * @subpackage Template
+ * @since 1.2.0
+ */
+
+/**
+ * Retrieve category link URL.
+ *
+ * @since 1.0.0
+ * @see get_term_link()
+ *
+ * @param int|object $category Category ID or object.
+ * @return string Link on success, empty string if category does not exist.
+ */
+function get_category_link( $category ) {
+ if ( ! is_object( $category ) )
+ $category = (int) $category;
+
+ $category = get_term_link( $category, 'category' );
-function get_category_children($id, $before = '/', $after = '') {
- if ( 0 == $id )
+ if ( is_wp_error( $category ) )
return '';
- $chain = '';
- // TODO: consult hierarchy
- $cat_ids = get_all_category_ids();
- foreach ( $cat_ids as $cat_id ) {
- if ( $cat_id == $id )
- continue;
-
- $category = get_category($cat_id);
- if ( is_wp_error( $category ) )
- return $category;
- if ( $category->parent == $id ) {
- $chain .= $before.$category->term_id.$after;
- $chain .= get_category_children($category->term_id, $before, $after);
- }
- }
- return $chain;
-}
-
-function get_category_link($category_id) {
- global $wp_rewrite;
- $catlink = $wp_rewrite->get_category_permastruct();
-
- if ( empty($catlink) ) {
- $file = get_option('home') . '/';
- $catlink = $file . '?cat=' . $category_id;
- } else {
- $category = &get_category($category_id);
- if ( is_wp_error( $category ) )
- return $category;
- $category_nicename = $category->slug;
-
- if ( $parent = $category->parent )
- $category_nicename = get_category_parents($parent, false, '/', true) . $category_nicename;
-
- $catlink = str_replace('%category%', $category_nicename, $catlink);
- $catlink = get_option('home') . user_trailingslashit($catlink, 'category');
- }
- return apply_filters('category_link', $catlink, $category_id);
+ return $category;
}
-function get_category_parents($id, $link = FALSE, $separator = '/', $nicename = FALSE){
+/**
+ * Retrieve category parents with separator.
+ *
+ * @since 1.2.0
+ *
+ * @param int $id Category ID.
+ * @param bool $link Optional, default is false. Whether to format with link.
+ * @param string $separator Optional, default is '/'. How to separate categories.
+ * @param bool $nicename Optional, default is false. Whether to use nice name for display.
+ * @param array $visited Optional. Already linked to categories to prevent duplicates.
+ * @return string|WP_Error A list of category parents on success, WP_Error on failure.
+ */
+function get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $visited = array() ) {
$chain = '';
- $parent = &get_category($id);
+ $parent = get_term( $id, 'category' );
if ( is_wp_error( $parent ) )
return $parent;
if ( $nicename )
$name = $parent->slug;
else
- $name = $parent->cat_name;
+ $name = $parent->name;
- if ( $parent->parent && ($parent->parent != $parent->term_id) )
- $chain .= get_category_parents($parent->parent, $link, $separator, $nicename);
+ if ( $parent->parent && ( $parent->parent != $parent->term_id ) && !in_array( $parent->parent, $visited ) ) {
+ $visited[] = $parent->parent;
+ $chain .= get_category_parents( $parent->parent, $link, $separator, $nicename, $visited );
+ }
if ( $link )
- $chain .= '<a href="' . get_category_link($parent->term_id) . '" title="' . sprintf(__("View all posts in %s"), $parent->cat_name) . '">'.$name.'</a>' . $separator;
+ $chain .= '<a href="' . esc_url( get_category_link( $parent->term_id ) ) . '">'.$name.'</a>' . $separator;
else
$chain .= $name.$separator;
return $chain;
}
-function get_the_category($id = false) {
- global $post, $term_cache, $blog_id;
-
- $id = (int) $id;
- if ( !$id )
- $id = (int) $post->ID;
-
- $categories = get_object_term_cache($id, 'category');
- if ( false === $categories )
- $categories = wp_get_object_terms($id, 'category');
-
- if ( !empty($categories) )
- usort($categories, '_usort_terms_by_name');
- else
+/**
+ * Retrieve post categories.
+ *
+ * This tag may be used outside The Loop by passing a post id as the parameter.
+ *
+ * Note: This function only returns results from the default "category" taxonomy.
+ * For custom taxonomies use get_the_terms().
+ *
+ * @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.
+ */
+function get_the_category( $id = false ) {
+ $categories = get_the_terms( $id, 'category' );
+ if ( ! $categories || is_wp_error( $categories ) )
$categories = array();
- foreach(array_keys($categories) as $key) {
- _make_cat_compat($categories[$key]);
+ $categories = array_values( $categories );
+
+ foreach ( array_keys( $categories ) as $key ) {
+ _make_cat_compat( $categories[$key] );
}
- return $categories;
+ /**
+ * Filter the array of categories to return for a post.
+ *
+ * @since 3.1.0
+ * @since 4.4.0 Added `$id` parameter.
+ *
+ * @param array $categories An array of categories to return for the post.
+ * @param int $id ID of the post.
+ */
+ return apply_filters( 'get_the_categories', $categories, $id );
}
-function _usort_terms_by_name($a, $b) {
- return strcmp($a->name, $b->name);
+/**
+ * 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 );
}
-function _usort_terms_by_ID($a, $b) {
+/**
+ * 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 0;
}
-function get_the_category_by_ID($cat_ID) {
+/**
+ * Retrieve category name based on category ID.
+ *
+ * @since 0.71
+ *
+ * @param int $cat_ID Category ID.
+ * @return string|WP_Error Category name on success, WP_Error on failure.
+ */
+function get_the_category_by_ID( $cat_ID ) {
$cat_ID = (int) $cat_ID;
- $category = &get_category($cat_ID);
+ $category = get_term( $cat_ID, 'category' );
+
if ( is_wp_error( $category ) )
return $category;
- return $category->name;
+
+ return ( $category ) ? $category->name : '';
}
-function get_the_category_list($separator = '', $parents='') {
+/**
+ * Retrieve category list in either HTML list or custom format.
+ *
+ * @since 1.5.1
+ *
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param string $separator Optional, default is empty string. Separator for between the categories.
+ * @param string $parents Optional. How to display the parents.
+ * @param int $post_id Optional. Post ID to retrieve categories.
+ * @return string
+ */
+function get_the_category_list( $separator = '', $parents='', $post_id = false ) {
global $wp_rewrite;
- $categories = get_the_category();
- if (empty($categories))
- return apply_filters('the_category', __('Uncategorized'), $separator, $parents);
+ if ( ! is_object_in_taxonomy( get_post_type( $post_id ), 'category' ) ) {
+ /** This filter is documented in wp-includes/category-template.php */
+ return apply_filters( 'the_category', '', $separator, $parents );
+ }
- $rel = ( is_object($wp_rewrite) && $wp_rewrite->using_permalinks() ) ? 'rel="category tag"' : 'rel="category"';
+ /**
+ * Filter the categories before building the category list.
+ *
+ * @since 4.4.0
+ *
+ * @param array $categories An array of the post's categories.
+ * @param int|bool $post_id ID of the post we're retrieving categories for. When `false`, we assume the
+ * current post in the loop.
+ */
+ $categories = apply_filters( 'the_category_list', get_the_category( $post_id ), $post_id );
+
+ if ( empty( $categories ) ) {
+ /** This filter is documented in wp-includes/category-template.php */
+ return apply_filters( 'the_category', __( 'Uncategorized' ), $separator, $parents );
+ }
+
+ $rel = ( is_object( $wp_rewrite ) && $wp_rewrite->using_permalinks() ) ? 'rel="category tag"' : 'rel="category"';
$thelist = '';
if ( '' == $separator ) {
$thelist .= '<ul class="post-categories">';
foreach ( $categories as $category ) {
$thelist .= "\n\t<li>";
- switch ( strtolower($parents) ) {
+ switch ( strtolower( $parents ) ) {
case 'multiple':
- if ($category->parent)
- $thelist .= get_category_parents($category->parent, TRUE);
- $thelist .= '<a href="' . get_category_link($category->term_id) . '" title="' . sprintf(__("View all posts in %s"), $category->name) . '" ' . $rel . '>' . $category->name.'</a></li>';
+ if ( $category->parent )
+ $thelist .= get_category_parents( $category->parent, true, $separator );
+ $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '" ' . $rel . '>' . $category->name.'</a></li>';
break;
case 'single':
- $thelist .= '<a href="' . get_category_link($category->term_id) . '" title="' . sprintf(__("View all posts in %s"), $category->name) . '" ' . $rel . '>';
- if ($category->parent)
- $thelist .= get_category_parents($category->parent, FALSE);
+ $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '" ' . $rel . '>';
+ if ( $category->parent )
+ $thelist .= get_category_parents( $category->parent, false, $separator );
$thelist .= $category->name.'</a></li>';
break;
case '':
default:
- $thelist .= '<a href="' . get_category_link($category->term_id) . '" title="' . sprintf(__("View all posts in %s"), $category->name) . '" ' . $rel . '>' . $category->cat_name.'</a></li>';
+ $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '" ' . $rel . '>' . $category->name.'</a></li>';
}
}
$thelist .= '</ul>';
$i = 0;
foreach ( $categories as $category ) {
if ( 0 < $i )
- $thelist .= $separator . ' ';
- switch ( strtolower($parents) ) {
+ $thelist .= $separator;
+ switch ( strtolower( $parents ) ) {
case 'multiple':
if ( $category->parent )
- $thelist .= get_category_parents($category->parent, TRUE);
- $thelist .= '<a href="' . get_category_link($category->term_id) . '" title="' . sprintf(__("View all posts in %s"), $category->name) . '" ' . $rel . '>' . $category->cat_name.'</a>';
+ $thelist .= get_category_parents( $category->parent, true, $separator );
+ $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '" ' . $rel . '>' . $category->name.'</a>';
break;
case 'single':
- $thelist .= '<a href="' . get_category_link($category->term_id) . '" title="' . sprintf(__("View all posts in %s"), $category->name) . '" ' . $rel . '>';
+ $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '" ' . $rel . '>';
if ( $category->parent )
- $thelist .= get_category_parents($category->parent, FALSE);
- $thelist .= "$category->cat_name</a>";
+ $thelist .= get_category_parents( $category->parent, false, $separator );
+ $thelist .= "$category->name</a>";
break;
case '':
default:
- $thelist .= '<a href="' . get_category_link($category->term_id) . '" title="' . sprintf(__("View all posts in %s"), $category->name) . '" ' . $rel . '>' . $category->name.'</a>';
+ $thelist .= '<a href="' . esc_url( get_category_link( $category->term_id ) ) . '" ' . $rel . '>' . $category->name.'</a>';
}
++$i;
}
}
- return apply_filters('the_category', $thelist, $separator, $parents);
-}
-function in_category( $category ) { // Check if the current post is in the given category
- global $post, $blog_id;
+ /**
+ * Filter the category or list of categories.
+ *
+ * @since 1.2.0
+ *
+ * @param array $thelist List of categories for the current post.
+ * @param string $separator Separator used between the categories.
+ * @param string $parents How to display the category parents. Accepts 'multiple',
+ * 'single', or empty.
+ */
+ return apply_filters( 'the_category', $thelist, $separator, $parents );
+}
- $categories = get_object_term_cache($post->ID, 'category');
- if ( false === $categories )
- $categories = wp_get_object_terms($post->ID, 'category');
- if(array_key_exists($category, $categories))
- return true;
- else
+/**
+ * Check if the current post in 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.
+ *
+ * Prior to v2.5 of WordPress, category names were not supported.
+ * Prior to v2.7, category slugs were not supported.
+ * Prior to v2.7, only one category could be compared: in_category( $single_category ).
+ * Prior to v2.7, this function could only be used in the WordPress Loop.
+ * As of 2.7, the function can be used anywhere if it is provided a post ID or post object.
+ *
+ * @since 1.2.0
+ *
+ * @param int|string|array $category Category ID, name or slug, or array of said.
+ * @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0)
+ * @return bool True if the current post is in any of the given categories.
+ */
+function in_category( $category, $post = null ) {
+ if ( empty( $category ) )
return false;
-}
-function the_category($separator = '', $parents='') {
- echo get_the_category_list($separator, $parents);
+ return has_category( $category, $post );
}
-function category_description($category = 0) {
- global $cat;
- if ( !$category )
- $category = $cat;
+/**
+ * Display the category list for the post.
+ *
+ * @since 0.71
+ *
+ * @param string $separator Optional, default is empty string. Separator for between the categories.
+ * @param string $parents Optional. How to display the parents.
+ * @param int $post_id Optional. Post ID to retrieve categories.
+ */
+function the_category( $separator = '', $parents='', $post_id = false ) {
+ echo get_the_category_list( $separator, $parents, $post_id );
+}
- return get_term_field('description', $category, 'category');
+/**
+ * Retrieve category description.
+ *
+ * @since 1.0.0
+ *
+ * @param int $category Optional. Category ID. Will use global category ID by default.
+ * @return string Category description, available.
+ */
+function category_description( $category = 0 ) {
+ return term_description( $category, 'category' );
}
-function wp_dropdown_categories($args = '') {
+/**
+ * Display or retrieve the HTML dropdown list of categories.
+ *
+ * The 'hierarchical' argument, which is disabled by default, will override the
+ * depth argument, unless it is true. When the argument is false, it will
+ * display all of the categories. When it is enabled it will use the value in
+ * the 'depth' argument.
+ *
+ * @since 2.1.0
+ * @since 4.2.0 Introduced the `value_field` argument.
+ *
+ * @param string|array $args {
+ * Optional. Array or string of arguments to generate a categories drop-down element.
+ *
+ * @type string $show_option_all Text to display for showing all categories. Default empty.
+ * @type string $show_option_none Text to display for showing no categories. Default empty.
+ * @type string $option_none_value Value to use when no category is selected. Default empty.
+ * @type string $orderby Which column to use for ordering categories. See get_terms() for a list
+ * of accepted values. Default 'id' (term_id).
+ * @type string $order Whether to order terms in ascending or descending order. Accepts 'ASC'
+ * or 'DESC'. Default 'ASC'.
+ * @type bool $pad_counts See get_terms() for an argument description. Default false.
+ * @type bool|int $show_count Whether to include post counts. Accepts 0, 1, or their bool equivalents.
+ * Default 0.
+ * @type bool|int $hide_empty Whether to hide categories that don't have any posts. Accepts 0, 1, or
+ * their bool equivalents. Default 1.
+ * @type int $child_of Term ID to retrieve child terms of. See get_terms(). Default 0.
+ * @type array|string $exclude Array or comma/space-separated string of term ids to exclude.
+ * If `$include` is non-empty, `$exclude` is ignored. Default empty array.
+ * @type bool|int $echo Whether to echo or return the generated markup. Accepts 0, 1, or their
+ * bool equivalents. Default 1.
+ * @type bool|int $hierarchical Whether to traverse the taxonomy hierarchy. Accepts 0, 1, or their bool
+ * equivalents. Default 0.
+ * @type int $depth Maximum depth. Default 0.
+ * @type int $tab_index Tab index for the select element. Default 0 (no tabindex).
+ * @type string $name Value for the 'name' attribute of the select element. Default 'cat'.
+ * @type string $id Value for the 'id' attribute of the select element. Defaults to the value
+ * of `$name`.
+ * @type string $class Value for the 'class' attribute of the select element. Default 'postform'.
+ * @type int|string $selected Value of the option that should be selected. Default 0.
+ * @type string $value_field Term field that should be used to populate the 'value' attribute
+ * 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 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).
+ * }
+ * @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_last_update' => 0, 'show_count' => 0,
+ 'orderby' => 'id', 'order' => 'ASC',
+ 'show_count' => 0,
'hide_empty' => 1, 'child_of' => 0,
'exclude' => '', 'echo' => 1,
'selected' => 0, 'hierarchical' => 0,
- 'name' => 'cat', 'class' => 'postform'
+ 'name' => 'cat', 'id' => '',
+ 'class' => 'postform', 'depth' => 0,
+ 'tab_index' => 0, 'taxonomy' => 'category',
+ 'hide_if_empty' => false, 'option_none_value' => -1,
+ 'value_field' => 'term_id',
);
- $defaults['selected'] = ( is_category() ) ? get_query_var('cat') : 0;
+ $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',
+ sprintf( __( '%1$s is deprecated. Use %2$s instead.' ),
+ '<code>type => link</code>',
+ '<code>taxonomy => link_category</code>'
+ )
+ );
+ $args['taxonomy'] = 'link_category';
+ }
$r = wp_parse_args( $args, $defaults );
- $r['include_last_update_time'] = $r['show_last_update'];
- extract( $r );
+ $option_none_value = $r['option_none_value'];
- $categories = get_categories($r);
+ if ( ! isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] ) {
+ $r['pad_counts'] = true;
+ }
- $output = '';
- if ( ! empty($categories) ) {
- $output = "<select name='$name' id='$name' class='$class'>\n";
+ $tab_index = $r['tab_index'];
+
+ $tab_index_attribute = '';
+ if ( (int) $tab_index > 0 ) {
+ $tab_index_attribute = " tabindex=\"$tab_index\"";
+ }
+
+ // Avoid clashes with the 'name' param of get_terms().
+ $get_terms_args = $r;
+ unset( $get_terms_args['name'] );
+ $categories = get_terms( $r['taxonomy'], $get_terms_args );
+
+ $name = esc_attr( $r['name'] );
+ $class = esc_attr( $r['class'] );
+ $id = $r['id'] ? esc_attr( $r['id'] ) : $name;
+
+ if ( ! $r['hide_if_empty'] || ! empty( $categories ) ) {
+ $output = "<select 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.
+ *
+ * A variety of taxonomy drop-down display elements can be modified
+ * just prior to display via this filter. Filterable arguments include
+ * 'show_option_none', 'show_option_all', and various forms of the
+ * term name.
+ *
+ * @since 1.2.0
+ *
+ * @see wp_dropdown_categories()
+ *
+ * @param string $element Taxonomy element to list.
+ */
+ $show_option_none = apply_filters( 'list_cats', $r['show_option_none'] );
+ $output .= "\t<option value='" . esc_attr( $option_none_value ) . "' selected='selected'>$show_option_none</option>\n";
+ }
- if ( $show_option_all ) {
- $show_option_all = apply_filters('list_cats', $show_option_all);
- $output .= "\t<option value='0'>$show_option_all</option>\n";
+ if ( ! empty( $categories ) ) {
+
+ if ( $r['show_option_all'] ) {
+
+ /** This filter is documented in wp-includes/category-template.php */
+ $show_option_all = apply_filters( 'list_cats', $r['show_option_all'] );
+ $selected = ( '0' === strval($r['selected']) ) ? " selected='selected'" : '';
+ $output .= "\t<option value='0'$selected>$show_option_all</option>\n";
}
- if ( $show_option_none) {
- $show_option_none = apply_filters('list_cats', $show_option_none);
- $output .= "\t<option value='-1'>$show_option_none</option>\n";
+ if ( $r['show_option_none'] ) {
+
+ /** This filter is documented in wp-includes/category-template.php */
+ $show_option_none = apply_filters( 'list_cats', $r['show_option_none'] );
+ $selected = selected( $option_none_value, $r['selected'], false );
+ $output .= "\t<option value='" . esc_attr( $option_none_value ) . "'$selected>$show_option_none</option>\n";
}
- if ( $hierarchical )
- $depth = 0; // Walk the full depth.
- else
+ if ( $r['hierarchical'] ) {
+ $depth = $r['depth']; // Walk the full depth.
+ } else {
$depth = -1; // Flat.
+ }
+ $output .= walk_category_dropdown_tree( $categories, $depth, $r );
+ }
- $output .= walk_category_dropdown_tree($categories, $depth, $r);
+ if ( ! $r['hide_if_empty'] || ! empty( $categories ) ) {
$output .= "</select>\n";
}
-
- $output = apply_filters('wp_dropdown_cats', $output);
-
- if ( $echo )
+ /**
+ * Filter the taxonomy drop-down output.
+ *
+ * @since 2.1.0
+ *
+ * @param string $output HTML output.
+ * @param array $r Arguments used to build the drop-down.
+ */
+ $output = apply_filters( 'wp_dropdown_cats', $output, $r );
+
+ if ( $r['echo'] ) {
echo $output;
-
+ }
return $output;
}
-function wp_list_categories($args = '') {
+/**
+ * Display or retrieve the HTML list of categories.
+ *
+ * @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 {
+ * 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 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()}.
+ * 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'.
+ * @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 string $taxonomy Taxonomy name. Default 'category'.
+ * }
+ * @return false|string HTML content only if 'echo' argument is 0.
+ */
+function wp_list_categories( $args = '' ) {
$defaults = array(
- 'show_option_all' => '', 'orderby' => 'name',
- 'order' => 'ASC', 'show_last_update' => 0,
- 'style' => 'list', 'show_count' => 0,
- 'hide_empty' => 1, 'use_desc_for_title' => 1,
- 'child_of' => 0, 'feed' => '',
+ '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' => '',
- 'hierarchical' => true, 'title_li' => __('Categories'),
- 'echo' => 1
+ 'exclude_tree' => '', 'current_category' => 0,
+ 'hierarchical' => true, 'title_li' => __( 'Categories' ),
+ 'hide_title_if_empty' => false,
+ 'echo' => 1, 'depth' => 0,
+ 'separator' => '<br />',
+ 'taxonomy' => 'category'
);
$r = wp_parse_args( $args, $defaults );
- if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] ) {
+ 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'] ) {
+ $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'] = '';
}
- if ( isset( $r['show_date'] ) ) {
- $r['include_last_update_time'] = $r['show_date'];
+ if ( ! isset( $r['class'] ) )
+ $r['class'] = ( 'category' == $r['taxonomy'] ) ? 'categories' : $r['taxonomy'];
+
+ if ( ! taxonomy_exists( $r['taxonomy'] ) ) {
+ return false;
}
- extract( $r );
+ $show_option_all = $r['show_option_all'];
+ $show_option_none = $r['show_option_none'];
- $categories = get_categories($r);
+ $categories = get_categories( $r );
$output = '';
- if ( $title_li && 'list' == $style )
- $output = '<li class="categories">' . $r['title_li'] . '<ul>';
-
- if ( empty($categories) ) {
- if ( 'list' == $style )
- $output .= '<li>' . __("No categories") . '</li>';
- else
- $output .= __("No categories");
+ if ( $r['title_li'] && 'list' == $r['style'] && ( ! empty( $categories ) || ! $r['hide_title_if_empty'] ) ) {
+ $output = '<li class="' . esc_attr( $r['class'] ) . '">' . $r['title_li'] . '<ul>';
+ }
+ if ( empty( $categories ) ) {
+ if ( ! empty( $show_option_none ) ) {
+ if ( 'list' == $r['style'] ) {
+ $output .= '<li class="cat-item-none">' . $show_option_none . '</li>';
+ } else {
+ $output .= $show_option_none;
+ }
+ }
} else {
- global $wp_query;
+ if ( ! empty( $show_option_all ) ) {
+
+ $posts_page = '';
+
+ // For taxonomies that belong only to custom post types, point to a valid archive.
+ $taxonomy_object = get_taxonomy( $r['taxonomy'] );
+ if ( ! in_array( 'post', $taxonomy_object->object_type ) && ! in_array( 'page', $taxonomy_object->object_type ) ) {
+ foreach ( $taxonomy_object->object_type as $object_type ) {
+ $_object_type = get_post_type_object( $object_type );
+
+ // Grab the first one.
+ if ( ! empty( $_object_type->has_archive ) ) {
+ $posts_page = get_post_type_archive_link( $object_type );
+ break;
+ }
+ }
+ }
- if( !empty($show_option_all) )
- if ('list' == $style )
- $output .= '<li><a href="' . get_bloginfo('url') . '">' . $show_option_all . '</a></li>';
- else
- $output .= '<a href="' . get_bloginfo('url') . '">' . $show_option_all . '</a>';
+ // Fallback for the 'All' link is the posts page.
+ if ( ! $posts_page ) {
+ if ( 'page' == get_option( 'show_on_front' ) && get_option( 'page_for_posts' ) ) {
+ $posts_page = get_permalink( get_option( 'page_for_posts' ) );
+ } else {
+ $posts_page = home_url( '/' );
+ }
+ }
- if ( is_category() )
- $r['current_category'] = $wp_query->get_queried_object_id();
+ $posts_page = esc_url( $posts_page );
+ if ( 'list' == $r['style'] ) {
+ $output .= "<li class='cat-item-all'><a href='$posts_page'>$show_option_all</a></li>";
+ } else {
+ $output .= "<a href='$posts_page'>$show_option_all</a>";
+ }
+ }
- if ( $hierarchical )
- $depth = 0; // Walk the full depth.
- else
- $depth = -1; // Flat.
+ if ( empty( $r['current_category'] ) && ( is_category() || is_tax() || is_tag() ) ) {
+ $current_term_object = get_queried_object();
+ if ( $current_term_object && $r['taxonomy'] === $current_term_object->taxonomy ) {
+ $r['current_category'] = get_queried_object_id();
+ }
+ }
- $output .= walk_category_tree($categories, $depth, $r);
+ if ( $r['hierarchical'] ) {
+ $depth = $r['depth'];
+ } else {
+ $depth = -1; // Flat.
+ }
+ $output .= walk_category_tree( $categories, $depth, $r );
}
- if ( $title_li && 'list' == $style )
+ if ( $r['title_li'] && 'list' == $r['style'] )
$output .= '</ul></li>';
- $output = apply_filters('wp_list_categories', $output);
-
- if ( $echo )
- echo $output;
- else
- return $output;
+ /**
+ * Filter the HTML output of a taxonomy list.
+ *
+ * @since 2.1.0
+ *
+ * @param string $output HTML output.
+ * @param array $args An array of taxonomy-listing arguments.
+ */
+ $html = apply_filters( 'wp_list_categories', $output, $args );
+
+ if ( $r['echo'] ) {
+ echo $html;
+ } else {
+ return $html;
+ }
}
+/**
+ * Display tag cloud.
+ *
+ * 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 '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'.
+ *
+ * The 'number' argument is how many tags to return. By default, the limit will
+ * be to return the top 45 tags in the 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.
+ *
+ * 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.
+ *
+ * @since 2.3.0
+ *
+ * @param array|string|null $args Optional. Override default arguments.
+ * @return void|array Generated tag cloud, only if no failures and 'array' is set for the 'format' argument.
+ * Otherwise, this function outputs the tag cloud.
+ */
function wp_tag_cloud( $args = '' ) {
$defaults = array(
'smallest' => 8, 'largest' => 22, 'unit' => 'pt', 'number' => 45,
- 'format' => 'flat', 'orderby' => 'name', 'order' => 'ASC',
- 'exclude' => '', 'include' => ''
+ 'format' => 'flat', 'separator' => "\n", 'orderby' => 'name', 'order' => 'ASC',
+ 'exclude' => '', 'include' => '', 'link' => 'view', 'taxonomy' => 'post_tag', 'post_type' => '', 'echo' => true
);
$args = wp_parse_args( $args, $defaults );
- $tags = get_tags( array_merge($args, array('orderby' => 'count', 'order' => 'DESC')) ); // Always query top tags
+ $tags = get_terms( $args['taxonomy'], array_merge( $args, array( 'orderby' => 'count', 'order' => 'DESC' ) ) ); // Always query top tags
- if ( empty($tags) )
+ if ( empty( $tags ) || is_wp_error( $tags ) )
return;
+ foreach ( $tags as $key => $tag ) {
+ if ( 'edit' == $args['link'] )
+ $link = get_edit_term_link( $tag->term_id, $tag->taxonomy, $args['post_type'] );
+ else
+ $link = get_term_link( intval($tag->term_id), $tag->taxonomy );
+ if ( is_wp_error( $link ) )
+ return;
+
+ $tags[ $key ]->link = $link;
+ $tags[ $key ]->id = $tag->term_id;
+ }
+
$return = wp_generate_tag_cloud( $tags, $args ); // Here's where those top tags get sorted according to $args
- if ( is_wp_error( $return ) )
- return false;
- else
- echo apply_filters( 'wp_tag_cloud', $return, $args );
+
+ /**
+ * Filter the tag cloud output.
+ *
+ * @since 2.3.0
+ *
+ * @param string $return HTML output of the tag cloud.
+ * @param array $args An array of tag cloud arguments.
+ */
+ $return = apply_filters( 'wp_tag_cloud', $return, $args );
+
+ if ( 'array' == $args['format'] || empty($args['echo']) )
+ return $return;
+
+ echo $return;
}
-// $tags = prefetched tag array ( get_tags() )
-// $args['format'] = 'flat' => whitespace separated, 'list' => UL, 'array' => array()
-// $args['orderby'] = 'name', 'count'
+/**
+ * Default topic count scaling for tag links
+ *
+ * @param int $count number of posts with that tag
+ * @return int scaled count
+ */
+function default_topic_count_scale( $count ) {
+ return round(log10($count + 1) * 100);
+}
+
+/**
+ * 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.
+ * @return string|array Tag cloud as a string or an array, depending on 'format' argument.
+ */
function wp_generate_tag_cloud( $tags, $args = '' ) {
- global $wp_rewrite;
$defaults = array(
- 'smallest' => 8, 'largest' => 22, 'unit' => 'pt', 'number' => 45,
- 'format' => 'flat', 'orderby' => 'name', 'order' => 'ASC'
+ 'smallest' => 8, 'largest' => 22, 'unit' => 'pt', 'number' => 0,
+ 'format' => 'flat', 'separator' => "\n", 'orderby' => 'name', 'order' => 'ASC',
+ 'topic_count_text' => null, 'topic_count_text_callback' => null,
+ 'topic_count_scale_callback' => 'default_topic_count_scale', 'filter' => 1,
);
+
$args = wp_parse_args( $args, $defaults );
- extract($args);
- if ( !$tags )
- return;
- $counts = $tag_links = array();
- foreach ( (array) $tags as $tag ) {
- $counts[$tag->name] = $tag->count;
- $tag_links[$tag->name] = get_tag_link( $tag->term_id );
- if ( is_wp_error( $tag_links[$tag->name] ) )
- return $tag_links[$tag->name];
- $tag_ids[$tag->name] = $tag->term_id;
+ $return = ( 'array' === $args['format'] ) ? array() : '';
+
+ if ( empty( $tags ) ) {
+ return $return;
+ }
+
+ // Juggle topic count tooltips:
+ if ( isset( $args['topic_count_text'] ) ) {
+ // First look for nooped plural support via topic_count_text.
+ $translate_nooped_plural = $args['topic_count_text'];
+ } elseif ( ! empty( $args['topic_count_text_callback'] ) ) {
+ // Look for the alternative callback style. Ignore the previous default.
+ if ( $args['topic_count_text_callback'] === 'default_topic_count_text' ) {
+ $translate_nooped_plural = _n_noop( '%s topic', '%s topics' );
+ } else {
+ $translate_nooped_plural = false;
+ }
+ } elseif ( isset( $args['single_text'] ) && isset( $args['multiple_text'] ) ) {
+ // If no callback exists, look for the old-style single_text and multiple_text arguments.
+ $translate_nooped_plural = _n_noop( $args['single_text'], $args['multiple_text'] );
+ } else {
+ // This is the default for when no callback, plural, or argument is passed in.
+ $translate_nooped_plural = _n_noop( '%s topic', '%s topics' );
}
- $min_count = min($counts);
- $spread = max($counts) - $min_count;
+ /**
+ * Filter how the items in a tag cloud are sorted.
+ *
+ * @since 2.8.0
+ *
+ * @param array $tags Ordered array of terms.
+ * @param array $args An array of tag cloud arguments.
+ */
+ $tags_sorted = apply_filters( 'tag_cloud_sort', $tags, $args );
+ if ( empty( $tags_sorted ) ) {
+ return $return;
+ }
+
+ if ( $tags_sorted !== $tags ) {
+ $tags = $tags_sorted;
+ unset( $tags_sorted );
+ } else {
+ if ( 'RAND' === $args['order'] ) {
+ shuffle( $tags );
+ } else {
+ // SQL cannot save you; this is a second (potentially different) sort on a subset of data.
+ if ( 'name' === $args['orderby'] ) {
+ uasort( $tags, '_wp_object_name_sort_cb' );
+ } else {
+ uasort( $tags, '_wp_object_count_sort_cb' );
+ }
+
+ if ( 'DESC' === $args['order'] ) {
+ $tags = array_reverse( $tags, true );
+ }
+ }
+ }
+
+ if ( $args['number'] > 0 )
+ $tags = array_slice( $tags, 0, $args['number'] );
+
+ $counts = array();
+ $real_counts = array(); // For the alt tag
+ foreach ( (array) $tags as $key => $tag ) {
+ $real_counts[ $key ] = $tag->count;
+ $counts[ $key ] = call_user_func( $args['topic_count_scale_callback'], $tag->count );
+ }
+
+ $min_count = min( $counts );
+ $spread = max( $counts ) - $min_count;
if ( $spread <= 0 )
$spread = 1;
- $font_spread = $largest - $smallest;
- if ( $font_spread <= 0 )
+ $font_spread = $args['largest'] - $args['smallest'];
+ if ( $font_spread < 0 )
$font_spread = 1;
$font_step = $font_spread / $spread;
- // SQL cannot save you; this is a second (potentially different) sort on a subset of data.
- if ( 'name' == $orderby )
- uksort($counts, 'strnatcasecmp');
- else
- asort($counts);
+ // Assemble the data that will be used to generate the tag cloud markup.
+ $tags_data = array();
+ foreach ( $tags as $key => $tag ) {
+ $tag_id = isset( $tag->id ) ? $tag->id : $key;
+
+ $count = $counts[ $key ];
+ $real_count = $real_counts[ $key ];
- if ( 'DESC' == $order )
- $counts = array_reverse( $counts, true );
+ if ( $translate_nooped_plural ) {
+ $title = sprintf( translate_nooped_plural( $translate_nooped_plural, $real_count ), number_format_i18n( $real_count ) );
+ } else {
+ $title = call_user_func( $args['topic_count_text_callback'], $real_count, $tag, $args );
+ }
+
+ $tags_data[] = array(
+ 'id' => $tag_id,
+ 'url' => '#' != $tag->link ? $tag->link : '#',
+ 'name' => $tag->name,
+ 'title' => $title,
+ 'slug' => $tag->slug,
+ 'real_count' => $real_count,
+ 'class' => 'tag-link-' . $tag_id,
+ 'font_size' => $args['smallest'] + ( $count - $min_count ) * $font_step,
+ );
+ }
+
+ /**
+ * Filter the data used to generate the tag cloud.
+ *
+ * @since 4.3.0
+ *
+ * @param array $tags_data An array of term data for term used to generate the tag cloud.
+ */
+ $tags_data = apply_filters( 'wp_generate_tag_cloud_data', $tags_data );
$a = array();
- $rel = ( is_object($wp_rewrite) && $wp_rewrite->using_permalinks() ) ? ' rel="tag"' : '';
-
- foreach ( $counts as $tag => $count ) {
- $tag_id = $tag_ids[$tag];
- $tag_link = clean_url($tag_links[$tag]);
- $tag = str_replace(' ', ' ', wp_specialchars( $tag ));
- $a[] = "<a href='$tag_link' class='tag-link-$tag_id' title='" . attribute_escape( sprintf( __('%d topics'), $count ) ) . "'$rel style='font-size: " .
- ( $smallest + ( ( $count - $min_count ) * $font_step ) )
- . "$unit;'>$tag</a>";
- }
-
- switch ( $format ) :
- case 'array' :
- $return =& $a;
- break;
- case 'list' :
- $return = "<ul class='wp-tag-cloud'>\n\t<li>";
- $return .= join("</li>\n\t<li>", $a);
- $return .= "</li>\n</ul>\n";
- break;
- default :
- $return = join("\n", $a);
- break;
- endswitch;
-
- return apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );
+ // 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>";
+ }
+
+ switch ( $args['format'] ) {
+ case 'array' :
+ $return =& $a;
+ break;
+ case 'list' :
+ $return = "<ul class='wp-tag-cloud'>\n\t<li>";
+ $return .= join( "</li>\n\t<li>", $a );
+ $return .= "</li>\n</ul>\n";
+ break;
+ default :
+ $return = join( $args['separator'], $a );
+ break;
+ }
+
+ if ( $args['filter'] ) {
+ /**
+ * Filter 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().
+ *
+ * @since 2.3.0
+ *
+ * @see wp_generate_tag_cloud()
+ *
+ * @param array|string $return String containing the generated HTML tag cloud output
+ * or an array of tag links if the 'format' argument
+ * equals 'array'.
+ * @param array $tags An array of terms used in the tag cloud.
+ * @param array $args An array of wp_generate_tag_cloud() arguments.
+ */
+ return apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );
+ }
+
+ else
+ return $return;
+}
+
+/**
+ * Callback for comparing objects based on name
+ *
+ * @since 3.1.0
+ * @access private
+ * @return int
+ */
+function _wp_object_name_sort_cb( $a, $b ) {
+ return strnatcasecmp( $a->name, $b->name );
+}
+
+/**
+ * Callback for comparing objects based on count
+ *
+ * @since 3.1.0
+ * @access private
+ * @return bool
+ */
+function _wp_object_count_sort_cb( $a, $b ) {
+ return ( $a->count > $b->count );
}
//
// Helper functions
//
+/**
+ * Retrieve HTML list content for category list.
+ *
+ * @uses Walker_Category to create HTML list content.
+ * @since 2.1.0
+ * @see Walker_Category::walk() for parameters and return description.
+ * @return string
+ */
function walk_category_tree() {
- $walker = new Walker_Category;
$args = func_get_args();
- return call_user_func_array(array(&$walker, 'walk'), $args);
+ // the user's options are the third parameter
+ if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) {
+ $walker = new Walker_Category;
+ } else {
+ $walker = $args[2]['walker'];
+ }
+ return call_user_func_array( array( $walker, 'walk' ), $args );
}
+/**
+ * Retrieve HTML dropdown (select) content for category list.
+ *
+ * @uses Walker_CategoryDropdown to create HTML dropdown content.
+ * @since 2.1.0
+ * @see Walker_CategoryDropdown::walk() for parameters and return description.
+ * @return string
+ */
function walk_category_dropdown_tree() {
- $walker = new Walker_CategoryDropdown;
$args = func_get_args();
- return call_user_func_array(array(&$walker, 'walk'), $args);
+ // the user's options are the third parameter
+ if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) {
+ $walker = new Walker_CategoryDropdown;
+ } else {
+ $walker = $args[2]['walker'];
+ }
+ return call_user_func_array( array( $walker, 'walk' ), $args );
}
//
// Tags
//
-function get_tag_link( $tag_id ) {
- global $wp_rewrite;
- $taglink = $wp_rewrite->get_tag_permastruct();
+/**
+ * Retrieve the link to the tag.
+ *
+ * @since 2.3.0
+ * @see get_term_link()
+ *
+ * @param int|object $tag Tag ID or object.
+ * @return string Link on success, empty string if tag does not exist.
+ */
+function get_tag_link( $tag ) {
+ if ( ! is_object( $tag ) )
+ $tag = (int) $tag;
+
+ $tag = get_term_link( $tag, 'post_tag' );
- $tag = &get_term($tag_id, 'post_tag');
if ( is_wp_error( $tag ) )
- return $tag;
- $slug = $tag->slug;
+ return '';
- if ( empty($taglink) ) {
- $file = get_option('home') . '/';
- $taglink = $file . '?tag=' . $slug;
- } else {
- $taglink = str_replace('%tag%', $slug, $taglink);
- $taglink = get_option('home') . user_trailingslashit($taglink, 'category');
- }
- return apply_filters('tag_link', $taglink, $tag_id);
+ return $tag;
}
+/**
+ * Retrieve the tags for a post.
+ *
+ * @since 2.3.0
+ *
+ * @param int $id Post ID.
+ * @return array|false|WP_Error Array of tag objects on success, false on failure.
+ */
function get_the_tags( $id = 0 ) {
- global $post;
- $id = (int) $id;
+ /**
+ * Filter the array of tags for the given post.
+ *
+ * @since 2.3.0
+ *
+ * @see get_the_terms()
+ *
+ * @param array $terms An array of tags for the given post.
+ */
+ return apply_filters( 'get_the_tags', get_the_terms( $id, 'post_tag' ) );
+}
- if ( ! $id && ! in_the_loop() )
- return false; // in-the-loop function
+/**
+ * Retrieve the tags for a post formatted as a string.
+ *
+ * @since 2.3.0
+ *
+ * @param string $before Optional. Before tags.
+ * @param string $sep Optional. Between tags.
+ * @param string $after Optional. After tags.
+ * @param int $id Optional. Post ID. Defaults to the current post.
+ * @return string|false|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.
+ */
+function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {
+
+ /**
+ * Filter the tags list for a given post.
+ *
+ * @since 2.3.0
+ *
+ * @param string $tag_list List of tags.
+ * @param string $before String to use before tags.
+ * @param string $sep String to use between the tags.
+ * @param string $after String to use after tags.
+ * @param int $id Post ID.
+ */
+ return apply_filters( 'the_tags', get_the_term_list( $id, 'post_tag', $before, $sep, $after ), $before, $sep, $after, $id );
+}
- if ( !$id )
- $id = (int) $post->ID;
+/**
+ * Retrieve the tags for a post.
+ *
+ * @since 2.3.0
+ *
+ * @param string $before Optional. Before list.
+ * @param string $sep Optional. Separate items using this.
+ * @param string $after Optional. After list.
+ */
+function the_tags( $before = null, $sep = ', ', $after = '' ) {
+ if ( null === $before )
+ $before = __('Tags: ');
+ echo get_the_tag_list($before, $sep, $after);
+}
- $tags = get_object_term_cache($id, 'post_tag');
- if ( false === $tags )
- $tags = wp_get_object_terms($id, 'post_tag');
+/**
+ * Retrieve tag description.
+ *
+ * @since 2.8.0
+ *
+ * @param int $tag Optional. Tag ID. Will use global tag ID by default.
+ * @return string Tag description, available.
+ */
+function tag_description( $tag = 0 ) {
+ return term_description( $tag );
+}
- $tags = apply_filters( 'get_the_tags', $tags );
- if ( empty( $tags ) )
- return false;
- return $tags;
+/**
+ * Retrieve term description.
+ *
+ * @since 2.8.0
+ *
+ * @param int $term Optional. Term ID. Will use global term ID by default.
+ * @param string $taxonomy Optional taxonomy name. Defaults to 'post_tag'.
+ * @return string Term description, available.
+ */
+function term_description( $term = 0, $taxonomy = 'post_tag' ) {
+ if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) {
+ $term = get_queried_object();
+ if ( $term ) {
+ $taxonomy = $term->taxonomy;
+ $term = $term->term_id;
+ }
+ }
+ $description = get_term_field( 'description', $term, $taxonomy );
+ return is_wp_error( $description ) ? '' : $description;
}
-function get_the_tag_list( $before = '', $sep = '', $after = '' ) {
- $tags = get_the_tags();
+/**
+ * Retrieve the terms of the taxonomy that are attached to the post.
+ *
+ * @since 2.5.0
+ *
+ * @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
+ * or the post does not exist, WP_Error on failure.
+ */
+function get_the_terms( $post, $taxonomy ) {
+ if ( ! $post = get_post( $post ) )
+ return false;
+
+ $terms = get_object_term_cache( $post->ID, $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' );
+ }
+ }
+
+ if ( ! is_wp_error( $terms ) ) {
+ $terms = array_map( 'get_term', $terms );
+ }
- if ( empty( $tags ) )
+ /**
+ * Filter the list of terms attached to the given post.
+ *
+ * @since 3.1.0
+ *
+ * @param array|WP_Error $terms List of attached terms, or WP_Error on failure.
+ * @param int $post_id Post ID.
+ * @param string $taxonomy Name of the taxonomy.
+ */
+ $terms = apply_filters( 'get_the_terms', $terms, $post->ID, $taxonomy );
+
+ if ( empty( $terms ) )
return false;
- $tag_list = $before;
- foreach ( $tags as $tag ) {
- $link = get_tag_link($tag->term_id);
- if ( is_wp_error( $link ) )
+ return $terms;
+}
+
+/**
+ * Retrieve a post's terms as a list with specified format.
+ *
+ * @since 2.5.0
+ *
+ * @param int $id Post ID.
+ * @param string $taxonomy Taxonomy name.
+ * @param string $before Optional. Before list.
+ * @param string $sep Optional. Separate items using this.
+ * @param string $after Optional. After list.
+ * @return string|false|WP_Error A list of terms on success, false if there are no terms, WP_Error on failure.
+ */
+function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {
+ $terms = get_the_terms( $id, $taxonomy );
+
+ if ( is_wp_error( $terms ) )
+ return $terms;
+
+ if ( empty( $terms ) )
+ return false;
+
+ $links = array();
+
+ foreach ( $terms as $term ) {
+ $link = get_term_link( $term, $taxonomy );
+ if ( is_wp_error( $link ) ) {
return $link;
- $tag_links[] = '<a href="' . $link . '" rel="tag">' . $tag->name . '</a>';
+ }
+ $links[] = '<a href="' . esc_url( $link ) . '" rel="tag">' . $term->name . '</a>';
}
- $tag_links = join( $sep, $tag_links );
- $tag_links = apply_filters( 'the_tags', $tag_links );
- $tag_list .= $tag_links;
+ /**
+ * Filter the term links for a given taxonomy.
+ *
+ * The dynamic portion of the filter name, `$taxonomy`, refers
+ * to the taxonomy slug.
+ *
+ * @since 2.5.0
+ *
+ * @param array $links An array of term links.
+ */
+ $term_links = apply_filters( "term_links-$taxonomy", $links );
+
+ return $before . join( $sep, $term_links ) . $after;
+}
- $tag_list .= $after;
+/**
+ * Display the terms in a list.
+ *
+ * @since 2.5.0
+ *
+ * @param int $id Post ID.
+ * @param string $taxonomy Taxonomy name.
+ * @param string $before Optional. Before list.
+ * @param string $sep Optional. Separate items using this.
+ * @param string $after Optional. After list.
+ * @return false|void False on WordPress error.
+ */
+function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
+ $term_list = get_the_term_list( $id, $taxonomy, $before, $sep, $after );
+
+ if ( is_wp_error( $term_list ) )
+ return false;
- return $tag_list;
+ /**
+ * Filter the list of terms to display.
+ *
+ * @since 2.9.0
+ *
+ * @param array $term_list List of terms to display.
+ * @param string $taxonomy The taxonomy name.
+ * @param string $before String to use before the terms.
+ * @param string $sep String to use between the terms.
+ * @param string $after String to use after the terms.
+ */
+ echo apply_filters( 'the_terms', $term_list, $taxonomy, $before, $sep, $after );
}
-function the_tags( $before = 'Tags: ', $sep = ', ', $after = '' ) {
- $return = get_the_tag_list($before, $sep, $after);
- if ( is_wp_error( $return ) )
- return false;
- else
- echo $return;
+/**
+ * Check if the current post has any of given category.
+ *
+ * @since 3.1.0
+ *
+ * @param string|int|array $category Optional. The category name/term_id/slug or array of them to check for.
+ * @param int|object $post Optional. Post to check instead of the current post.
+ * @return bool True if the current post has any of the given categories (or any category, if no category specified).
+ */
+function has_category( $category = '', $post = null ) {
+ return has_term( $category, 'category', $post );
+}
+
+/**
+ * Check if the current post has any of given tags.
+ *
+ * The given tags are checked against the post's tags' term_ids, names and slugs.
+ * Tags given as integers will only be checked against the post's tags' term_ids.
+ * If no tags are given, determines if post has any tags.
+ *
+ * Prior to v2.7 of WordPress, tags given as integers would also be checked against the post's tags' names and slugs (in addition to term_ids)
+ * Prior to v2.7, this function could only be used in the WordPress Loop.
+ * As of 2.7, the function can be used anywhere if it is provided a post ID or post object.
+ *
+ * @since 2.6.0
+ *
+ * @param string|int|array $tag Optional. The tag name/term_id/slug or array of them to check for.
+ * @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0)
+ * @return bool True if the current post has any of the given tags (or any tag, if no tag specified).
+ */
+function has_tag( $tag = '', $post = null ) {
+ return has_term( $tag, 'post_tag', $post );
}
-?>
+/**
+ * Check if the current post has any of given terms.
+ *
+ * The given terms are checked against the post's terms' term_ids, names and slugs.
+ * Terms given as integers will only be checked against the post's terms' term_ids.
+ * If no terms are given, determines if post has any terms.
+ *
+ * @since 3.1.0
+ *
+ * @param string|int|array $term Optional. The term name/term_id/slug or array of them to check for.
+ * @param string $taxonomy Taxonomy name
+ * @param int|object $post Optional. Post to check instead of the current post.
+ * @return bool True if the current post has any of the given tags (or any tag, if no tag specified).
+ */
+function has_term( $term = '', $taxonomy = '', $post = null ) {
+ $post = get_post($post);
+
+ if ( !$post )
+ return false;
+
+ $r = is_object_in_term( $post->ID, $taxonomy, $term );
+ if ( is_wp_error( $r ) )
+ return false;
+
+ return $r;
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff