X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fa11948979fd6a4ea5705dc613b239699a459db3..caeaf8dc94b5e3f75dc98ec92dc7b76049cdddb6:/wp-includes/category-template.php?ds=sidebyside
diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php
index 27b8bf22..0f97068f 100644
--- a/wp-includes/category-template.php
+++ b/wp-includes/category-template.php
@@ -56,7 +56,7 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename =
}
if ( $link )
- $chain .= 'name ) ) . '">'.$name.'' . $separator;
+ $chain .= ''.$name.'' . $separator;
else
$chain .= $name.$separator;
return $chain;
@@ -66,7 +66,6 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename =
* Retrieve post categories.
*
* @since 0.71
- * @uses $post
*
* @param int $id Optional, default to current post ID. The post ID.
* @return array
@@ -82,7 +81,13 @@ function get_the_category( $id = false ) {
_make_cat_compat( $categories[$key] );
}
- // Filter name is plural because we return alot of categories (possibly more than #13237) not just one
+ /**
+ * Filter the array of categories to return for a post.
+ *
+ * @since 3.1.0
+ *
+ * @param array $categories An array of categories to return for the post.
+ */
return apply_filters( 'get_the_categories', $categories );
}
@@ -136,9 +141,11 @@ function _usort_terms_by_ID( $a, $b ) {
function get_the_category_by_ID( $cat_ID ) {
$cat_ID = (int) $cat_ID;
$category = get_term( $cat_ID, 'category' );
+
if ( is_wp_error( $category ) )
return $category;
- return $category->name;
+
+ return ( $category ) ? $category->name : '';
}
/**
@@ -153,12 +160,16 @@ function get_the_category_by_ID( $cat_ID ) {
*/
function get_the_category_list( $separator = '', $parents='', $post_id = false ) {
global $wp_rewrite;
- if ( ! is_object_in_taxonomy( get_post_type( $post_id ), 'category' ) )
+ 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 );
+ }
$categories = get_the_category( $post_id );
- if ( empty( $categories ) )
+ 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"';
@@ -171,17 +182,17 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false )
case 'multiple':
if ( $category->parent )
$thelist .= get_category_parents( $category->parent, true, $separator );
- $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.'';
+ $thelist .= '' . $category->name.'';
break;
case 'single':
- $thelist .= 'name ) ) . '" ' . $rel . '>';
+ $thelist .= '';
if ( $category->parent )
$thelist .= get_category_parents( $category->parent, false, $separator );
$thelist .= $category->name.'';
break;
case '':
default:
- $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.'';
+ $thelist .= '' . $category->name.'';
}
}
$thelist .= '';
@@ -194,21 +205,32 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false )
case 'multiple':
if ( $category->parent )
$thelist .= get_category_parents( $category->parent, true, $separator );
- $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.'';
+ $thelist .= '' . $category->name.'';
break;
case 'single':
- $thelist .= 'name ) ) . '" ' . $rel . '>';
+ $thelist .= '';
if ( $category->parent )
$thelist .= get_category_parents( $category->parent, false, $separator );
$thelist .= "$category->name";
break;
case '':
default:
- $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.'';
+ $thelist .= '' . $category->name.'';
}
++$i;
}
}
+
+ /**
+ * 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 );
}
@@ -225,13 +247,15 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false )
* As of 2.7, the function can be used anywhere if it is provided a post ID or post object.
*
* @since 1.2.0
- * @uses has_category()
*
* @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;
+
return has_category( $category, $post );
}
@@ -266,6 +290,7 @@ function category_description( $category = 0 ) {
* The list of arguments is below:
* 'show_option_all' (string) - Text to display for showing all categories.
* 'show_option_none' (string) - Text to display for showing no categories.
+ * 'option_none_value' (mixed) - Value to use when no category is selected.
* 'orderby' (string) default is 'ID' - What column to use for ordering the
* categories.
* 'order' (string) default is 'ASC' - What direction to order categories.
@@ -305,7 +330,7 @@ function wp_dropdown_categories( $args = '' ) {
'name' => 'cat', 'id' => '',
'class' => 'postform', 'depth' => 0,
'tab_index' => 0, 'taxonomy' => 'category',
- 'hide_if_empty' => false
+ 'hide_if_empty' => false, 'option_none_value' => -1
);
$defaults['selected'] = ( is_category() ) ? get_query_var( 'cat' ) : 0;
@@ -317,62 +342,90 @@ function wp_dropdown_categories( $args = '' ) {
}
$r = wp_parse_args( $args, $defaults );
+ $option_none_value = $r['option_none_value'];
- if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] ) {
+ if ( ! isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] ) {
$r['pad_counts'] = true;
}
- extract( $r );
+ $tab_index = $r['tab_index'];
$tab_index_attribute = '';
- if ( (int) $tab_index > 0 )
+ if ( (int) $tab_index > 0 ) {
$tab_index_attribute = " tabindex=\"$tab_index\"";
+ }
+ $categories = get_terms( $r['taxonomy'], $r );
+ $name = esc_attr( $r['name'] );
+ $class = esc_attr( $r['class'] );
+ $id = $r['id'] ? esc_attr( $r['id'] ) : $name;
- $categories = get_terms( $taxonomy, $r );
- $name = esc_attr( $name );
- $class = esc_attr( $class );
- $id = $id ? esc_attr( $id ) : $name;
-
- if ( ! $r['hide_if_empty'] || ! empty($categories) )
+ if ( ! $r['hide_if_empty'] || ! empty( $categories ) ) {
$output = "\n";
+ }
+ /**
+ * 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 );
- $output = apply_filters( 'wp_dropdown_cats', $output );
-
- if ( $echo )
+ if ( $r['echo'] ) {
echo $output;
-
+ }
return $output;
}
@@ -389,7 +442,7 @@ function wp_dropdown_categories( $args = '' ) {
* 'hide_empty' (bool|int) default is 1 - Whether to hide categories that
* don't have any posts attached to them.
* 'use_desc_for_title' (bool|int) default is 1 - Whether to use the
- * description instead of the category title.
+ * category description as the title attribute.
* 'feed' - See {@link get_categories()}.
* 'feed_type' - See {@link get_categories()}.
* 'feed_image' - See {@link get_categories()}.
@@ -405,7 +458,7 @@ function wp_dropdown_categories( $args = '' ) {
* @since 2.1.0
*
* @param string|array $args Optional. Override default arguments.
- * @return string HTML content only if 'echo' argument is 0.
+ * @return false|null|string HTML content only if 'echo' argument is 0.
*/
function wp_list_categories( $args = '' ) {
$defaults = array(
@@ -432,60 +485,74 @@ function wp_list_categories( $args = '' ) {
$r['exclude'] = '';
}
- if ( !isset( $r['class'] ) )
+ if ( ! isset( $r['class'] ) )
$r['class'] = ( 'category' == $r['taxonomy'] ) ? 'categories' : $r['taxonomy'];
- extract( $r );
-
- if ( !taxonomy_exists($taxonomy) )
+ if ( ! taxonomy_exists( $r['taxonomy'] ) ) {
return false;
+ }
+
+ $show_option_all = $r['show_option_all'];
+ $show_option_none = $r['show_option_none'];
$categories = get_categories( $r );
$output = '';
- if ( $title_li && 'list' == $style )
- $output = '' . $title_li . '';
-
+ if ( $r['title_li'] && 'list' == $r['style'] ) {
+ $output = '- ' . $r['title_li'] . '
';
+ }
if ( empty( $categories ) ) {
if ( ! empty( $show_option_none ) ) {
- if ( 'list' == $style )
- $output .= '- ' . $show_option_none . '
';
- else
+ if ( 'list' == $r['style'] ) {
+ $output .= '- ' . $show_option_none . '
';
+ } else {
$output .= $show_option_none;
+ }
}
} else {
if ( ! empty( $show_option_all ) ) {
$posts_page = ( 'page' == get_option( 'show_on_front' ) && get_option( 'page_for_posts' ) ) ? get_permalink( get_option( 'page_for_posts' ) ) : home_url( '/' );
$posts_page = esc_url( $posts_page );
- if ( 'list' == $style )
- $output .= "- $show_option_all
";
- else
+ if ( 'list' == $r['style'] ) {
+ $output .= "- $show_option_all
";
+ } else {
$output .= "$show_option_all";
+ }
}
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 )
+ if ( $current_term_object && $r['taxonomy'] === $current_term_object->taxonomy ) {
$r['current_category'] = get_queried_object_id();
+ }
}
- if ( $hierarchical )
+ if ( $r['hierarchical'] ) {
$depth = $r['depth'];
- else
+ } else {
$depth = -1; // Flat.
-
+ }
$output .= walk_category_tree( $categories, $depth, $r );
}
- if ( $title_li && 'list' == $style )
+ if ( $r['title_li'] && 'list' == $r['style'] )
$output .= '
';
- $output = apply_filters( 'wp_list_categories', $output, $args );
+ /**
+ * 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 ( $echo )
- echo $output;
- else
- return $output;
+ if ( $r['echo'] ) {
+ echo $html;
+ } else {
+ return $html;
+ }
}
/**
@@ -504,8 +571,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
@@ -513,14 +586,14 @@ function wp_list_categories( $args = '' ) {
*
* @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.
+ * @param array|string|null $args Optional. Override default arguments.
+ * @return null|false 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', '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 +604,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 +616,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 +632,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,71 +663,102 @@ 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 );
- if ( empty( $tags ) )
- return;
+ $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' );
+ }
+
+ /**
+ * 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' === $args['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' === $args['orderby'] ) {
uasort( $tags, '_wp_object_name_sort_cb' );
- else
+ } else {
uasort( $tags, '_wp_object_count_sort_cb' );
+ }
- if ( 'DESC' == $order )
+ if ( 'DESC' === $args['order'] ) {
$tags = array_reverse( $tags, true );
+ }
}
}
- if ( $number > 0 )
- $tags = array_slice($tags, 0, $number);
+ 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 ] = $topic_count_scale_callback($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;
+ $font_spread = $args['largest'] - $args['smallest'];
if ( $font_spread < 0 )
$font_spread = 1;
$font_step = $font_spread / $spread;
@@ -669,27 +771,52 @@ 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";
+
+ if ( $translate_nooped_plural ) {
+ $title_attribute = sprintf( translate_nooped_plural( $translate_nooped_plural, $real_count ), number_format_i18n( $real_count ) );
+ } else {
+ $title_attribute = call_user_func( $args['topic_count_text_callback'], $real_count, $tag, $args );
+ }
+
+ $a[] = "$tag_name";
}
- switch ( $format ) :
- case 'array' :
- $return =& $a;
- break;
- case 'list' :
- $return = "\n\t- ";
- $return .= join( "
\n\t- ", $a );
- $return .= "
\n
\n";
- break;
- default :
- $return = join( $separator, $a );
- break;
- endswitch;
-
- if ( $filter )
+ switch ( $args['format'] ) {
+ case 'array' :
+ $return =& $a;
+ break;
+ case 'list' :
+ $return = "\n\t- ";
+ $return .= join( "
\n\t- ", $a );
+ $return .= "
\n
\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;
}
@@ -769,7 +896,7 @@ class Walker_Category extends Walker {
* @since 2.1.0
* @var string
*/
- var $tree_type = 'category';
+ public $tree_type = 'category';
/**
* Database fields to use.
@@ -779,7 +906,7 @@ class Walker_Category extends Walker {
* @todo Decouple this
* @var array
*/
- var $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
+ public $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
/**
* Starts the list before the elements are added.
@@ -793,7 +920,7 @@ class Walker_Category extends Walker {
* @param array $args An array of arguments. Will only append content if style argument value is 'list'.
* @see wp_list_categories()
*/
- function start_lvl( &$output, $depth = 0, $args = array() ) {
+ public function start_lvl( &$output, $depth = 0, $args = array() ) {
if ( 'list' != $args['style'] )
return;
@@ -813,7 +940,7 @@ class Walker_Category extends Walker {
* @param array $args An array of arguments. Will only append content if style argument value is 'list'.
* @wsee wp_list_categories()
*/
- function end_lvl( &$output, $depth = 0, $args = array() ) {
+ public function end_lvl( &$output, $depth = 0, $args = array() ) {
if ( 'list' != $args['style'] )
return;
@@ -834,61 +961,74 @@ class Walker_Category extends Walker {
* @param array $args An array of arguments. @see wp_list_categories()
* @param int $id ID of the current category.
*/
- function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
- extract($args);
-
- $cat_name = esc_attr( $category->name );
- $cat_name = apply_filters( 'list_cats', $cat_name, $category );
- $link = 'description) )
- $link .= 'title="' . esc_attr( sprintf(__( 'View all posts filed under %s' ), $cat_name) ) . '"';
- else
+ public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
+ /** This filter is documented in wp-includes/category-template.php */
+ $cat_name = apply_filters(
+ 'list_cats',
+ esc_attr( $category->name ),
+ $category
+ );
+
+ $link = 'description ) ) {
+ /**
+ * 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 . '';
- if ( !empty($feed_image) || !empty($feed) ) {
+ if ( ! empty( $args['feed_image'] ) || ! empty( $args['feed'] ) ) {
$link .= ' ';
- if ( empty($feed_image) )
+ if ( empty( $args['feed_image'] ) ) {
$link .= '(';
+ }
- $link .= 'term_id, $category->taxonomy, $args['feed_type'] ) ) . '"';
- if ( empty($feed) ) {
+ if ( empty( $args['feed'] ) ) {
$alt = ' alt="' . sprintf(__( 'Feed for all posts filed under %s' ), $cat_name ) . '"';
} else {
- $title = ' title="' . $feed . '"';
- $alt = ' alt="' . $feed . '"';
- $name = $feed;
- $link .= $title;
+ $alt = ' alt="' . $args['feed'] . '"';
+ $name = $args['feed'];
+ $link .= empty( $args['title'] ) ? '' : $args['title'];
}
$link .= '>';
- if ( empty($feed_image) )
+ if ( empty( $args['feed_image'] ) ) {
$link .= $name;
- else
- $link .= "
';
-
+ } else {
+ $link .= "![](" . $args[)
';
+ }
$link .= '';
- if ( empty($feed_image) )
+ if ( empty( $args['feed_image'] ) ) {
$link .= ')';
+ }
}
- if ( !empty($show_count) )
- $link .= ' (' . intval($category->count) . ')';
-
+ if ( ! empty( $args['show_count'] ) ) {
+ $link .= ' (' . number_format_i18n( $category->count ) . ')';
+ }
if ( 'list' == $args['style'] ) {
$output .= "\tterm_id;
- if ( !empty($current_category) ) {
- $_current_category = get_term( $current_category, $category->taxonomy );
- if ( $category->term_id == $current_category )
+ if ( ! empty( $args['current_category'] ) ) {
+ $_current_category = get_term( $args['current_category'], $category->taxonomy );
+ if ( $category->term_id == $args['current_category'] ) {
$class .= ' current-cat';
- elseif ( $category->term_id == $_current_category->parent )
+ } elseif ( $category->term_id == $_current_category->parent ) {
$class .= ' current-cat-parent';
+ }
}
$output .= ' class="' . $class . '"';
$output .= ">$link\n";
@@ -909,7 +1049,7 @@ class Walker_Category extends Walker {
* @param int $depth Depth of category. Not used.
* @param array $args An array of arguments. Only uses 'list' for whether should append to output. @see wp_list_categories()
*/
- function end_el( &$output, $page, $depth = 0, $args = array() ) {
+ public function end_el( &$output, $page, $depth = 0, $args = array() ) {
if ( 'list' != $args['style'] )
return;
@@ -931,7 +1071,7 @@ class Walker_CategoryDropdown extends Walker {
* @since 2.1.0
* @var string
*/
- var $tree_type = 'category';
+ public $tree_type = 'category';
/**
* @see Walker::$db_fields
@@ -939,7 +1079,7 @@ class Walker_CategoryDropdown extends Walker {
* @todo Decouple this
* @var array
*/
- var $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
+ public $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
/**
* Start the element output.
@@ -952,17 +1092,19 @@ class Walker_CategoryDropdown extends Walker {
* @param int $depth Depth of category. Used for padding.
* @param array $args Uses 'selected' and 'show_count' keys, if they exist. @see wp_dropdown_categories()
*/
- function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
+ public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
$pad = str_repeat(' ', $depth * 3);
- $cat_name = apply_filters('list_cats', $category->name, $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 +1138,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,15 +1160,26 @@ 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.
* @param string $after Optional. After tags.
* @param int $id Optional. Post ID. Defaults to the current post.
- * @return string|bool|WP_Error A list of tags on success, false or WP_Error on failure.
+ * @return string|bool|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 );
}
@@ -1039,7 +1201,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 +1213,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'.
@@ -1076,7 +1238,8 @@ function term_description( $term = 0, $taxonomy = 'post_tag' ) {
*
* @param int|object $post Post ID or object.
* @param string $taxonomy Taxonomy name.
- * @return array|bool|WP_Error Array of term objects on success, false or WP_Error on failure.
+ * @return array|bool|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 ) )
@@ -1088,6 +1251,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|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 ) )
@@ -1106,7 +1278,7 @@ function get_the_terms( $post, $taxonomy ) {
* @param string $before Optional. Before list.
* @param string $sep Optional. Separate items using this.
* @param string $after Optional. After list.
- * @return string|bool|WP_Error A list of terms on success, false or WP_Error on failure.
+ * @return string|bool|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 );
@@ -1124,6 +1296,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;
@@ -1139,7 +1321,7 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = ''
* @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.
+ * @return false|null 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 );
@@ -1147,7 +1329,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 );
}
/**