";
else
$output .= "$show_option_all";
}
@@ -480,6 +533,14 @@ function wp_list_categories( $args = '' ) {
if ( $title_li && 'list' == $style )
$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.
+ */
$output = apply_filters( 'wp_list_categories', $output, $args );
if ( $echo )
@@ -504,8 +565,14 @@ function wp_list_categories( $args = '' ) {
* 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 '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
@@ -520,7 +587,7 @@ function wp_tag_cloud( $args = '' ) {
$defaults = array(
'smallest' => 8, 'largest' => 22, 'unit' => 'pt', 'number' => 45,
'format' => 'flat', 'separator' => "\n", 'orderby' => 'name', 'order' => 'ASC',
- 'exclude' => '', 'include' => '', 'link' => 'view', 'taxonomy' => 'post_tag', 'echo' => true
+ 'exclude' => '', 'include' => '', 'link' => 'view', 'taxonomy' => 'post_tag', 'post_type' => '', 'echo' => true
);
$args = wp_parse_args( $args, $defaults );
@@ -531,7 +598,7 @@ function wp_tag_cloud( $args = '' ) {
foreach ( $tags as $key => $tag ) {
if ( 'edit' == $args['link'] )
- $link = get_edit_tag_link( $tag->term_id, $tag->taxonomy );
+ $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 ) )
@@ -543,6 +610,14 @@ function wp_tag_cloud( $args = '' ) {
$return = wp_generate_tag_cloud( $tags, $args ); // Here's where those top tags get sorted according to $args
+ /**
+ * Filter the tag cloud output.
+ *
+ * @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']) )
@@ -551,16 +626,6 @@ function wp_tag_cloud( $args = '' ) {
echo $return;
}
-/**
- * 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
*
@@ -592,53 +657,85 @@ function default_topic_count_scale( $count ) {
* 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.
+ * 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
+ * @return string|array Tag cloud as a string or an array, depending on 'format' argument.
*/
function wp_generate_tag_cloud( $tags, $args = '' ) {
$defaults = array(
'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_text' => null, 'topic_count_text_callback' => null,
'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, EXTR_SKIP );
- if ( empty( $tags ) )
- return;
+ $return = ( 'array' === $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' );
+ }
+
+ /**
+ * 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 ( $tags_sorted != $tags ) { // the tags have been sorted by a plugin
+ if ( empty( $tags_sorted ) ) {
+ return $return;
+ }
+
+ if ( $tags_sorted !== $tags ) {
$tags = $tags_sorted;
- unset($tags_sorted);
+ unset( $tags_sorted );
} else {
- if ( 'RAND' == $order ) {
- shuffle($tags);
+ 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 )
+ if ( 'name' === $orderby ) {
uasort( $tags, '_wp_object_name_sort_cb' );
- else
+ } else {
uasort( $tags, '_wp_object_count_sort_cb' );
+ }
- if ( 'DESC' == $order )
+ if ( 'DESC' === $order ) {
$tags = array_reverse( $tags, true );
+ }
}
}
@@ -669,7 +766,14 @@ function wp_generate_tag_cloud( $tags, $args = '' ) {
$tag_link = '#' != $tag->link ? esc_url( $tag->link ) : '#';
$tag_id = isset($tags[ $key ]->id) ? $tags[ $key ]->id : $key;
$tag_name = $tags[ $key ]->name;
- $a[] = "$tag_name";
}
@@ -688,8 +792,26 @@ function wp_generate_tag_cloud( $tags, $args = '' ) {
break;
endswitch;
- if ( $filter )
+ if ( $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;
}
@@ -838,12 +960,25 @@ class Walker_Category extends Walker {
extract($args);
$cat_name = esc_attr( $category->name );
+
+ /** This filter is documented in wp-includes/category-template.php */
$cat_name = apply_filters( 'list_cats', $cat_name, $category );
+
$link = 'description) )
+ if ( $use_desc_for_title == 0 || empty($category->description) ) {
$link .= 'title="' . esc_attr( sprintf(__( 'View all posts filed under %s' ), $cat_name) ) . '"';
- else
+ } else {
+ /**
+ * Filter the category description for display.
+ *
+ * @since 1.2.0
+ *
+ * @param string $description Category description.
+ * @param object $category Category object.
+ */
$link .= 'title="' . esc_attr( strip_tags( apply_filters( 'category_description', $category->description, $category ) ) ) . '"';
+ }
+
$link .= '>';
$link .= $cat_name . '';
@@ -878,7 +1013,7 @@ class Walker_Category extends Walker {
}
if ( !empty($show_count) )
- $link .= ' (' . intval($category->count) . ')';
+ $link .= ' (' . number_format_i18n( $category->count ) . ')';
if ( 'list' == $args['style'] ) {
$output .= "\tname, $category);
+ /** This filter is documented in wp-includes/category-template.php */
+ $cat_name = apply_filters( 'list_cats', $category->name, $category );
+
$output .= "\t\n";
}
}
@@ -996,12 +1133,21 @@ function get_tag_link( $tag ) {
* 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|bool Array of tag objects on success, false on failure.
*/
function get_the_tags( $id = 0 ) {
+
+ /**
+ * 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' ) );
}
@@ -1009,7 +1155,6 @@ function get_the_tags( $id = 0 ) {
* 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.
@@ -1018,6 +1163,18 @@ function get_the_tags( $id = 0 ) {
* @return string|bool|WP_Error A list of tags on success, false or 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 );
}
@@ -1039,7 +1196,7 @@ function the_tags( $before = null, $sep = ', ', $after = '' ) {
/**
* Retrieve tag description.
*
- * @since 2.8
+ * @since 2.8.0
*
* @param int $tag Optional. Tag ID. Will use global tag ID by default.
* @return string Tag description, available.
@@ -1051,7 +1208,7 @@ function tag_description( $tag = 0 ) {
/**
* Retrieve term description.
*
- * @since 2.8
+ * @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'.
@@ -1088,6 +1245,15 @@ function get_the_terms( $post, $taxonomy ) {
wp_cache_add($post->ID, $terms, $taxonomy . '_relationships');
}
+ /**
+ * Filter the list of terms attached to the given post.
+ *
+ * @since 3.1.0
+ *
+ * @param array $terms List of attached terms.
+ * @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 ) )
@@ -1124,6 +1290,16 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = ''
$term_links[] = '' . $term->name . '';
}
+ /**
+ * 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 $term_links An array of term links.
+ */
$term_links = apply_filters( "term_links-$taxonomy", $term_links );
return $before . join( $sep, $term_links ) . $after;
@@ -1147,7 +1323,18 @@ function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
if ( is_wp_error( $term_list ) )
return false;
- echo apply_filters('the_terms', $term_list, $taxonomy, $before, $sep, $after);
+ /**
+ * 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 );
}
/**