';
- $output = apply_filters('wp_list_categories', $output);
+ $output = apply_filters( 'wp_list_categories', $output, $args );
if ( $echo )
echo $output;
@@ -331,91 +529,192 @@ function wp_list_categories($args = '') {
return $output;
}
+/**
+ * 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_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 '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 $args Optional. Override default arguments.
+ * @return array Generated tag cloud, only if no failures and 'array' is set for the 'format' argument.
+ */
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', '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 ) )
return;
- $return = wp_generate_tag_cloud( $tags, $args ); // Here's where those top tags get sorted according to $args
+ foreach ( $tags as $key => $tag ) {
+ if ( 'edit' == $args['link'] )
+ $link = get_edit_tag_link( $tag->term_id, $args['taxonomy'] );
+ else
+ $link = get_term_link( intval($tag->term_id), $args['taxonomy'] );
+ if ( is_wp_error( $link ) )
+ return false;
- if ( is_wp_error( $return ) )
- return false;
+ $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
$return = apply_filters( 'wp_tag_cloud', $return, $args );
- if ( 'array' == $args['format'] )
+ 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 text for tooltip for tag links
+ *
+ * @param integer $count number of posts with that tag
+ * @return string text for the tooltip of a tag link.
+ */
+function default_topic_count_text( $count ) {
+ return sprintf( _n('%s topic', '%s topics', $count), number_format_i18n( $count ) );
+}
+
+/**
+ * Default topic count scaling for tag links
+ *
+ * @param integer $count number of posts with that tag
+ * @return integer 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_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
+ */
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_callback' => 'default_topic_count_text',
+ 'topic_count_scale_callback' => 'default_topic_count_scale', 'filter' => 1,
);
+
+ if ( !isset( $args['topic_count_text_callback'] ) && isset( $args['single_text'] ) && isset( $args['multiple_text'] ) ) {
+ $body = 'return sprintf (
+ _n(' . var_export($args['single_text'], true) . ', ' . var_export($args['multiple_text'], true) . ', $count),
+ number_format_i18n( $count ));';
+ $args['topic_count_text_callback'] = create_function('$count', $body);
+ }
+
$args = wp_parse_args( $args, $defaults );
- extract($args);
+ extract( $args );
- if ( !$tags )
+ if ( empty( $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;
+
+ $tags_sorted = apply_filters( 'tag_cloud_sort', $tags, $args );
+ if ( $tags_sorted != $tags ) { // the tags have been sorted by a plugin
+ $tags = $tags_sorted;
+ unset($tags_sorted);
+ } else {
+ if ( 'RAND' == $order ) {
+ shuffle($tags);
+ } else {
+ // SQL cannot save you; this is a second (potentially different) sort on a subset of data.
+ if ( 'name' == $orderby )
+ uasort( $tags, create_function('$a, $b', 'return strnatcasecmp($a->name, $b->name);') );
+ else
+ uasort( $tags, create_function('$a, $b', 'return ($a->count > $b->count);') );
+
+ if ( 'DESC' == $order )
+ $tags = array_reverse( $tags, true );
+ }
}
- $min_count = min($counts);
- $spread = max($counts) - $min_count;
+ if ( $number > 0 )
+ $tags = array_slice($tags, 0, $number);
+
+ $counts = array();
+ $real_counts = array(); // For the alt tag
+ foreach ( (array) $tags as $key => $tag ) {
+ $real_counts[ $key ] = $tag->count;
+ $counts[ $key ] = $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 )
+ 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);
-
- if ( 'DESC' == $order )
- $counts = array_reverse( $counts, true );
- elseif ( 'RAND' == $order ) {
- $keys = array_rand( $counts, count($counts) );
- foreach ( $keys as $key )
- $temp[$key] = $counts[$key];
- $counts = $temp;
- unset($temp);
- }
-
$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[] = "link ? esc_url( $tag->link ) : '#';
+ $tag_id = isset($tags[ $key ]->id) ? $tags[ $key ]->id : $key;
+ $tag_name = $tags[ $key ]->name;
+ $a[] = "$tag";
+ . "$unit;'>$tag_name";
}
switch ( $format ) :
@@ -424,82 +723,193 @@ function wp_generate_tag_cloud( $tags, $args = '' ) {
break;
case 'list' :
$return = "
\n\t
";
- $return .= join("
\n\t
", $a);
+ $return .= join( "
\n\t
", $a );
$return .= "
\n
\n";
break;
default :
- $return = join("\n", $a);
+ $return = join( $separator, $a );
break;
endswitch;
- return apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );
+ if ( $filter )
+ return apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );
+ else
+ return $return;
}
//
// 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.
+ */
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']) || !is_a($args[2]['walker'], '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.
+ */
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']) || !is_a($args[2]['walker'], 'Walker') )
+ $walker = new Walker_CategoryDropdown;
+ else
+ $walker = $args[2]['walker'];
+
+ return call_user_func_array(array( &$walker, 'walk' ), $args );
}
//
// Tags
//
+/**
+ * Retrieve the link to the tag.
+ *
+ * @since 2.3.0
+ * @uses apply_filters() Calls 'tag_link' with tag link and tag ID as parameters.
+ *
+ * @param int $tag_id Tag (term) ID.
+ * @return string
+ */
function get_tag_link( $tag_id ) {
global $wp_rewrite;
$taglink = $wp_rewrite->get_tag_permastruct();
- $tag = &get_term($tag_id, 'post_tag');
+ $tag = &get_term( $tag_id, 'post_tag' );
if ( is_wp_error( $tag ) )
return $tag;
$slug = $tag->slug;
- if ( empty($taglink) ) {
- $file = get_option('home') . '/';
+ 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');
+ $taglink = str_replace( '%tag%', $slug, $taglink );
+ $taglink = get_option( 'home' ) . user_trailingslashit( $taglink, 'category' );
}
- return apply_filters('tag_link', $taglink, $tag_id);
+ return apply_filters( 'tag_link', $taglink, $tag_id );
}
+/**
+ * Retrieve the tags for a post.
+ *
+ * @since 2.3.0
+ * @uses apply_filters() Calls 'get_the_tags' filter on the list of post tags.
+ *
+ * @param int $id Post ID.
+ * @return array
+ */
function get_the_tags( $id = 0 ) {
- return apply_filters( 'get_the_tags', get_the_terms($id, 'post_tag') );
+ return apply_filters( 'get_the_tags', get_the_terms( $id, 'post_tag' ) );
}
+/**
+ * Retrieve the tags for a post formatted as a string.
+ *
+ * @since 2.3.0
+ * @uses apply_filters() Calls 'the_tags' filter on string list of tags.
+ *
+ * @param string $before Optional. Before tags.
+ * @param string $sep Optional. Between tags.
+ * @param string $after Optional. After tags.
+ * @return string
+ */
function get_the_tag_list( $before = '', $sep = '', $after = '' ) {
- return apply_filters( 'the_tags', get_the_term_list(0, 'post_tag', $before, $sep, $after) );
+ return apply_filters( 'the_tags', get_the_term_list( 0, 'post_tag', $before, $sep, $after ), $before, $sep, $after);
+}
+
+/**
+ * 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.
+ * @return string
+ */
+function the_tags( $before = null, $sep = ', ', $after = '' ) {
+ if ( null === $before )
+ $before = __('Tags: ');
+ echo get_the_tag_list($before, $sep, $after);
+}
+
+/**
+ * Retrieve tag description.
+ *
+ * @since 2.8
+ *
+ * @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 );
}
-function the_tags( $before = 'Tags: ', $sep = ', ', $after = '' ) {
- return the_terms( 0, 'post_tag', $before, $sep, $after );
+/**
+ * Retrieve term description.
+ *
+ * @since 2.8
+ *
+ * @param int $term Optional. Term ID. Will use global term ID by default.
+ * @return string Term description, available.
+ */
+function term_description( $term = 0, $taxonomy = 'post_tag' ) {
+ if ( !$term && ( is_tax() || is_tag() || is_category() ) ) {
+ global $wp_query;
+ $term = $wp_query->get_queried_object();
+ $taxonomy = $term->taxonomy;
+ $term = $term->term_id;
+ }
+ $description = get_term_field( 'description', $term, $taxonomy );
+ return is_wp_error( $description ) ? '' : $description;
}
+/**
+ * Retrieve the terms of the taxonomy that are attached to the post.
+ *
+ * This function can only be used within the loop.
+ *
+ * @since 2.5.0
+ *
+ * @param int $id Post ID. Is not optional.
+ * @param string $taxonomy Taxonomy name.
+ * @return array|bool False on failure. Array of term objects on success.
+ */
function get_the_terms( $id = 0, $taxonomy ) {
global $post;
$id = (int) $id;
- if ( ! $id && ! in_the_loop() )
- return false; // in-the-loop function
-
- if ( !$id )
- $id = (int) $post->ID;
+ if ( !$id ) {
+ if ( !$post->ID )
+ return false;
+ else
+ $id = (int) $post->ID;
+ }
- $terms = get_object_term_cache($id, $taxonomy);
+ $terms = get_object_term_cache( $id, $taxonomy );
if ( false === $terms )
- $terms = wp_get_object_terms($id, $taxonomy);
+ $terms = wp_get_object_terms( $id, $taxonomy );
if ( empty( $terms ) )
return false;
@@ -507,17 +917,29 @@ function get_the_terms( $id = 0, $taxonomy ) {
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
+ */
function get_the_term_list( $id = 0, $taxonomy, $before = '', $sep = '', $after = '' ) {
- $terms = get_the_terms($id, $taxonomy);
+ $terms = get_the_terms( $id, $taxonomy );
- if ( is_wp_error($terms) )
+ if ( is_wp_error( $terms ) )
return $terms;
if ( empty( $terms ) )
return false;
foreach ( $terms as $term ) {
- $link = get_term_link($term, $taxonomy);
+ $link = get_term_link( $term, $taxonomy );
if ( is_wp_error( $link ) )
return $link;
$term_links[] = '' . $term->name . '';
@@ -525,15 +947,63 @@ function get_the_term_list( $id = 0, $taxonomy, $before = '', $sep = '', $after
$term_links = apply_filters( "term_links-$taxonomy", $term_links );
- return $before . join($sep, $term_links) . $after;
+ return $before . join( $sep, $term_links ) . $after;
}
-function the_terms( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {
- $return = get_the_term_list($id, $taxonomy, $before, $sep, $after);
- if ( is_wp_error( $return ) )
+/**
+ * Display the terms in a list.
+ *
+ * @since 2.5.0
+ *
+ * @param int $id Term 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 null|bool False on WordPress error. Returns null when displaying.
+ */
+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;
- else
- echo $return;
+
+ echo apply_filters('the_terms', $term_list, $taxonomy, $before, $sep, $after);
+}
+
+/**
+ * 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
+ *
+ * @uses is_object_in_term()
+ *
+ * @param string|int|array $tag Optional. The tag name/term_id/slug or array of them to check for.
+ * @param int|post object Optional. Post to check instead of the current post. @since 2.7.0
+ * @return bool True if the current post has any of the the given tags (or any tag, if no tag specified).
+ */
+function has_tag( $tag = '', $_post = null ) {
+ if ( $_post ) {
+ $_post = get_post( $_post );
+ } else {
+ $_post =& $GLOBALS['post'];
+ }
+
+ if ( !$_post )
+ return false;
+
+ $r = is_object_in_term( $_post->ID, 'post_tag', $tag );
+ if ( is_wp_error( $r ) )
+ return false;
+ return $r;
}
-?>
+?>
\ No newline at end of file