X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fef8173b8c3bad08f495551e43cfdeac1cae6021..888fa4ed68091f3314f711c5f6fe75858bf5410b:/wp-includes/category-template.php
diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php
index 382488de..e627bdc3 100644
--- a/wp-includes/category-template.php
+++ b/wp-includes/category-template.php
@@ -37,11 +37,11 @@ function get_category_link( $category ) {
* @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
+ * @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;
@@ -56,7 +56,7 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename =
}
if ( $link )
- $chain .= 'name ) ) . '">'.$name.'' . $separator;
+ $chain .= 'name ) ) . '">'.$name.'' . $separator;
else
$chain .= $name.$separator;
return $chain;
@@ -73,7 +73,7 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename =
*/
function get_the_category( $id = false ) {
$categories = get_the_terms( $id, 'category' );
- if ( ! $categories )
+ if ( ! $categories || is_wp_error( $categories ) )
$categories = array();
$categories = array_values( $categories );
@@ -82,7 +82,13 @@ function get_the_category( $id = false ) {
_make_cat_compat( $categories[$key] );
}
- // Filter name is plural because we return alot of categories 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 );
}
@@ -131,14 +137,16 @@ function _usort_terms_by_ID( $a, $b ) {
* @since 0.71
*
* @param int $cat_ID Category ID.
- * @return string Category name.
+ * @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 : '';
}
/**
@@ -153,12 +161,16 @@ function get_the_category_by_ID( $cat_ID ) {
*/
function get_the_category_list( $separator = '', $parents='', $post_id = false ) {
global $wp_rewrite;
- $categories = get_the_category( $post_id );
- 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 );
+ }
- if ( empty( $categories ) )
+ $categories = get_the_category( $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"';
@@ -171,17 +183,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 .= 'name ) ) . '" ' . $rel . '>' . $category->name.'';
break;
case 'single':
- $thelist .= 'name ) ) . '" ' . $rel . '>';
+ $thelist .= 'name ) ) . '" ' . $rel . '>';
if ( $category->parent )
$thelist .= get_category_parents( $category->parent, false, $separator );
$thelist .= $category->name.'';
break;
case '':
default:
- $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.'';
+ $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.'';
}
}
$thelist .= '';
@@ -194,25 +206,35 @@ 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 .= 'name ) ) . '" ' . $rel . '>' . $category->name.'';
break;
case 'single':
- $thelist .= 'name ) ) . '" ' . $rel . '>';
+ $thelist .= 'name ) ) . '" ' . $rel . '>';
if ( $category->parent )
$thelist .= get_category_parents( $category->parent, false, $separator );
$thelist .= "$category->name";
break;
case '':
default:
- $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.'';
+ $thelist .= 'name ) ) . '" ' . $rel . '>' . $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 );
}
-
/**
* Check if the current post in within any of the given categories.
*
@@ -226,16 +248,17 @@ 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)
+ * @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_term( $category, 'category', $post );
+ return has_category( $category, $post );
}
/**
@@ -272,7 +295,6 @@ function category_description( $category = 0 ) {
* 'orderby' (string) default is 'ID' - What column to use for ordering the
* categories.
* 'order' (string) default is 'ASC' - What direction to order categories.
- * 'show_last_update' (bool|int) default is 0 - See {@link get_categories()}
* 'show_count' (bool|int) default is 0 - Whether to show how many posts are
* in the category.
* 'hide_empty' (bool|int) default is 1 - Whether to hide categories that
@@ -302,7 +324,7 @@ function wp_dropdown_categories( $args = '' ) {
$defaults = array(
'show_option_all' => '', 'show_option_none' => '',
'orderby' => 'id', 'order' => 'ASC',
- 'show_last_update' => 0, 'show_count' => 0,
+ 'show_count' => 0,
'hide_empty' => 1, 'child_of' => 0,
'exclude' => '', 'echo' => 1,
'selected' => 0, 'hierarchical' => 0,
@@ -326,7 +348,6 @@ function wp_dropdown_categories( $args = '' ) {
$r['pad_counts'] = true;
}
- $r['include_last_update_time'] = $r['show_last_update'];
extract( $r );
$tab_index_attribute = '';
@@ -344,6 +365,21 @@ function wp_dropdown_categories( $args = '' ) {
$output = '';
if ( empty($categories) && ! $r['hide_if_empty'] && !empty($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', $show_option_none );
$output .= "\t\n";
}
@@ -351,12 +387,16 @@ function wp_dropdown_categories( $args = '' ) {
if ( ! empty( $categories ) ) {
if ( $show_option_all ) {
+
+ /** This filter is documented in wp-includes/category-template.php */
$show_option_all = apply_filters( 'list_cats', $show_option_all );
$selected = ( '0' === strval($r['selected']) ) ? " selected='selected'" : '';
$output .= "\t\n";
}
if ( $show_option_none ) {
+
+ /** This filter is documented in wp-includes/category-template.php */
$show_option_none = apply_filters( 'list_cats', $show_option_none );
$selected = ( '-1' === strval($r['selected']) ) ? " selected='selected'" : '';
$output .= "\t\n";
@@ -369,11 +409,19 @@ function wp_dropdown_categories( $args = '' ) {
$output .= walk_category_dropdown_tree( $categories, $depth, $r );
}
+
if ( ! $r['hide_if_empty'] || ! empty($categories) )
$output .= "\n";
-
- $output = apply_filters( 'wp_dropdown_cats', $output );
+ /**
+ * 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 ( $echo )
echo $output;
@@ -389,8 +437,6 @@ function wp_dropdown_categories( $args = '' ) {
* 'orderby' (string) default is 'ID' - What column to use for ordering the
* categories.
* 'order' (string) default is 'ASC' - What direction to order categories.
- * 'show_last_update' (bool|int) default is 0 - See {@link
- * walk_category_dropdown_tree()}
* 'show_count' (bool|int) default is 0 - Whether to show how many posts are
* in the category.
* 'hide_empty' (bool|int) default is 1 - Whether to hide categories that
@@ -418,7 +464,7 @@ function wp_list_categories( $args = '' ) {
$defaults = array(
'show_option_all' => '', 'show_option_none' => __('No categories'),
'orderby' => 'name', 'order' => 'ASC',
- 'show_last_update' => 0, 'style' => 'list',
+ 'style' => 'list',
'show_count' => 0, 'hide_empty' => 1,
'use_desc_for_title' => 1, 'child_of' => 0,
'feed' => '', 'feed_type' => '',
@@ -434,9 +480,6 @@ function wp_list_categories( $args = '' ) {
if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] )
$r['pad_counts'] = true;
- if ( isset( $r['show_date'] ) )
- $r['include_last_update_time'] = $r['show_date'];
-
if ( true == $r['hierarchical'] ) {
$r['exclude_tree'] = $r['exclude'];
$r['exclude'] = '';
@@ -459,20 +502,23 @@ function wp_list_categories( $args = '' ) {
if ( empty( $categories ) ) {
if ( ! empty( $show_option_none ) ) {
if ( 'list' == $style )
- $output .= '' . $show_option_none . '';
+ $output .= '' . $show_option_none . '';
else
$output .= $show_option_none;
}
} else {
- if( !empty( $show_option_all ) )
+ 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 . '';
+ $output .= "$show_option_all";
else
- $output .= '' . $show_option_all . '';
+ $output .= "$show_option_all";
+ }
if ( empty( $r['current_category'] ) && ( is_category() || is_tax() || is_tag() ) ) {
$current_term_object = get_queried_object();
- if ( $r['taxonomy'] == $current_term_object->taxonomy )
+ if ( $current_term_object && $r['taxonomy'] === $current_term_object->taxonomy )
$r['current_category'] = get_queried_object_id();
}
@@ -487,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 )
@@ -511,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
@@ -527,18 +587,18 @@ 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 );
$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_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 ) )
@@ -550,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']) )
@@ -558,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
*
@@ -578,7 +636,6 @@ function default_topic_count_scale( $count ) {
return round(log10($count + 1) * 100);
}
-
/**
* Generates a tag cloud (heatmap) from provided data.
*
@@ -600,54 +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 = '' ) {
- global $wp_rewrite;
$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 )
- 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 ( 'name' === $orderby ) {
+ uasort( $tags, '_wp_object_name_sort_cb' );
+ } else {
+ uasort( $tags, '_wp_object_count_sort_cb' );
+ }
- if ( 'DESC' == $order )
+ if ( 'DESC' === $order ) {
$tags = array_reverse( $tags, true );
+ }
}
}
@@ -678,8 +766,15 @@ 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";
}
@@ -697,29 +792,47 @@ 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;
}
/**
- * Callback for comparing tags based on name
+ * Callback for comparing objects based on name
*
* @since 3.1.0
* @access private
*/
-function _wp_tag_cloud_name_sort_cb( $a, $b ) {
+function _wp_object_name_sort_cb( $a, $b ) {
return strnatcasecmp( $a->name, $b->name );
}
/**
- * Callback for comparing tags based on count
+ * Callback for comparing objects based on count
*
* @since 3.1.0
* @access private
*/
-function _wp_tag_cloud_count_sort_cb( $a, $b ) {
+function _wp_object_count_sort_cb( $a, $b ) {
return ( $a->count > $b->count );
}
@@ -772,6 +885,8 @@ function walk_category_dropdown_tree() {
*/
class Walker_Category extends Walker {
/**
+ * What the class handles.
+ *
* @see Walker::$tree_type
* @since 2.1.0
* @var string
@@ -779,6 +894,8 @@ class Walker_Category extends Walker {
var $tree_type = 'category';
/**
+ * Database fields to use.
+ *
* @see Walker::$db_fields
* @since 2.1.0
* @todo Decouple this
@@ -787,14 +904,18 @@ class Walker_Category extends Walker {
var $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
/**
+ * Starts the list before the elements are added.
+ *
* @see Walker::start_lvl()
+ *
* @since 2.1.0
*
* @param string $output Passed by reference. Used to append additional content.
- * @param int $depth Depth of category. Used for tab indentation.
- * @param array $args Will only append content if style argument value is 'list'.
+ * @param int $depth Depth of category. Used for tab indentation.
+ * @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, $args) {
+ function start_lvl( &$output, $depth = 0, $args = array() ) {
if ( 'list' != $args['style'] )
return;
@@ -803,14 +924,18 @@ class Walker_Category extends Walker {
}
/**
+ * Ends the list of after the elements are added.
+ *
* @see Walker::end_lvl()
+ *
* @since 2.1.0
*
* @param string $output Passed by reference. Used to append additional content.
- * @param int $depth Depth of category. Used for tab indentation.
- * @param array $args Will only append content if style argument value is 'list'.
+ * @param int $depth Depth of category. Used for tab indentation.
+ * @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, $args) {
+ function end_lvl( &$output, $depth = 0, $args = array() ) {
if ( 'list' != $args['style'] )
return;
@@ -819,24 +944,41 @@ class Walker_Category extends Walker {
}
/**
+ * Start the element output.
+ *
* @see Walker::start_el()
+ *
* @since 2.1.0
*
- * @param string $output Passed by reference. Used to append additional content.
+ * @param string $output Passed by reference. Used to append additional content.
* @param object $category Category data object.
- * @param int $depth Depth of category in reference to parents.
- * @param array $args
+ * @param int $depth Depth of category in reference to parents. Default 0.
+ * @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, $args) {
+ function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
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) )
+
+ $link = '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 . '';
@@ -846,7 +988,7 @@ class Walker_Category extends Walker {
if ( empty($feed_image) )
$link .= '(';
- $link .= 'term_id, $category->taxonomy, $feed_type ) ) . '"';
if ( empty($feed) ) {
$alt = ' alt="' . sprintf(__( 'Feed for all posts filed under %s' ), $cat_name ) . '"';
@@ -871,10 +1013,7 @@ class Walker_Category extends Walker {
}
if ( !empty($show_count) )
- $link .= ' (' . intval($category->count) . ')';
-
- if ( !empty($show_date) )
- $link .= ' ' . gmdate('Y-m-d', $category->last_update_timestamp);
+ $link .= ' (' . number_format_i18n( $category->count ) . ')';
if ( 'list' == $args['style'] ) {
$output .= "\t 'parent', 'id' => 'term_id');
/**
+ * Start the element output.
+ *
* @see Walker::start_el()
* @since 2.1.0
*
- * @param string $output Passed by reference. Used to append additional content.
+ * @param string $output Passed by reference. Used to append additional content.
* @param object $category Category data object.
- * @param int $depth Depth of category. Used for padding.
- * @param array $args Uses 'selected', 'show_count', and 'show_last_update' keys, if they exist.
+ * @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, $args) {
+ 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";
}
}
@@ -991,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
+ * @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' ) );
}
@@ -1004,15 +1155,27 @@ 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.
- * @return string
+ * @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.
*/
-function get_the_tag_list( $before = '', $sep = '', $after = '' ) {
- return apply_filters( 'the_tags', get_the_term_list( 0, 'post_tag', $before, $sep, $after ), $before, $sep, $after);
+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 );
}
/**
@@ -1023,7 +1186,6 @@ function get_the_tag_list( $before = '', $sep = '', $after = '' ) {
* @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 )
@@ -1034,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.
@@ -1046,16 +1208,19 @@ 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'.
* @return string Term description, available.
*/
function term_description( $term = 0, $taxonomy = 'post_tag' ) {
- if ( !$term && ( is_tax() || is_tag() || is_category() ) ) {
+ if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) {
$term = get_queried_object();
- $taxonomy = $term->taxonomy;
- $term = $term->term_id;
+ if ( $term ) {
+ $taxonomy = $term->taxonomy;
+ $term = $term->term_id;
+ }
}
$description = get_term_field( 'description', $term, $taxonomy );
return is_wp_error( $description ) ? '' : $description;
@@ -1064,33 +1229,32 @@ function term_description( $term = 0, $taxonomy = 'post_tag' ) {
/**
* 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 int|object $post Post ID or object.
* @param string $taxonomy Taxonomy name.
- * @return array|bool False on failure. Array of term objects on success.
+ * @return array|bool|WP_Error Array of term objects on success, false or WP_Error on failure.
*/
-function get_the_terms( $id = 0, $taxonomy ) {
- global $post;
-
- $id = (int) $id;
-
- if ( !$id ) {
- if ( !$post->ID )
- return false;
- else
- $id = (int) $post->ID;
- }
+function get_the_terms( $post, $taxonomy ) {
+ if ( ! $post = get_post( $post ) )
+ return false;
- $terms = get_object_term_cache( $id, $taxonomy );
+ $terms = get_object_term_cache( $post->ID, $taxonomy );
if ( false === $terms ) {
- $terms = wp_get_object_terms( $id, $taxonomy );
- wp_cache_add($id, $terms, $taxonomy . '_relationships');
+ $terms = wp_get_object_terms( $post->ID, $taxonomy );
+ wp_cache_add($post->ID, $terms, $taxonomy . '_relationships');
}
- $terms = apply_filters( 'get_the_terms', $terms, $id, $taxonomy );
+ /**
+ * 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 ) )
return false;
@@ -1108,9 +1272,9 @@ function get_the_terms( $id = 0, $taxonomy ) {
* @param string $before Optional. Before list.
* @param string $sep Optional. Separate items using this.
* @param string $after Optional. After list.
- * @return string
+ * @return string|bool|WP_Error A list of terms on success, false or WP_Error on failure.
*/
-function get_the_term_list( $id = 0, $taxonomy, $before = '', $sep = '', $after = '' ) {
+function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {
$terms = get_the_terms( $id, $taxonomy );
if ( is_wp_error( $terms ) )
@@ -1123,9 +1287,19 @@ function get_the_term_list( $id = 0, $taxonomy, $before = '', $sep = '', $after
$link = get_term_link( $term, $taxonomy );
if ( is_wp_error( $link ) )
return $link;
- $term_links[] = '' . $term->name . '';
+ $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;
@@ -1143,22 +1317,32 @@ function get_the_term_list( $id = 0, $taxonomy, $before = '', $sep = '', $after
* @param string $after Optional. After list.
* @return null|bool False on WordPress error. Returns null when displaying.
*/
-function the_terms( $id = 0, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
+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;
- 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 );
}
-
/**
* Check if the current post has any of given category.
*
* @since 3.1.0
*
- * @param string|int|array $tag Optional. The category name/term_id/slug or array of them to check for.
+ * @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).
*/
@@ -1213,5 +1397,3 @@ function has_term( $term = '', $taxonomy = '', $post = null ) {
return $r;
}
-
-?>