X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/53a5df18dd17a11c18781e78349feb3e139096b4..refs/tags/wordpress-4.4:/wp-includes/category-template.php
diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php
index 57f7cb9a..9b685edb 100644
--- a/wp-includes/category-template.php
+++ b/wp-includes/category-template.php
@@ -1,9 +1,10 @@
term_id ) ) . '" title="' . esc_attr( sprintf( __( "View all posts in %s" ), $parent->name ) ) . '">'.$name.'' . $separator;
+ $chain .= ''.$name.'' . $separator;
else
$chain .= $name.$separator;
return $chain;
@@ -65,11 +66,15 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename =
/**
* Retrieve post categories.
*
+ * This tag may be used outside The Loop by passing a post id as the parameter.
+ *
+ * Note: This function only returns results from the default "category" taxonomy.
+ * For custom taxonomies use get_the_terms().
+ *
* @since 0.71
- * @uses $post
*
* @param int $id Optional, default to current post ID. The post ID.
- * @return array
+ * @return array Array of objects, one for each category assigned to the post.
*/
function get_the_category( $id = false ) {
$categories = get_the_terms( $id, 'category' );
@@ -82,8 +87,16 @@ 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
- return apply_filters( 'get_the_categories', $categories );
+ /**
+ * Filter the array of categories to return for a post.
+ *
+ * @since 3.1.0
+ * @since 4.4.0 Added `$id` parameter.
+ *
+ * @param array $categories An array of categories to return for the post.
+ * @param int $id ID of the post.
+ */
+ return apply_filters( 'get_the_categories', $categories, $id );
}
/**
@@ -136,9 +149,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 : '';
}
/**
@@ -146,6 +161,8 @@ function get_the_category_by_ID( $cat_ID ) {
*
* @since 1.5.1
*
+ * @global WP_Rewrite $wp_rewrite
+ *
* @param string $separator Optional, default is empty string. Separator for between the categories.
* @param string $parents Optional. How to display the parents.
* @param int $post_id Optional. Post ID to retrieve categories.
@@ -153,12 +170,26 @@ 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 );
+ }
+
+ /**
+ * Filter the categories before building the category list.
+ *
+ * @since 4.4.0
+ *
+ * @param array $categories An array of the post's categories.
+ * @param int|bool $post_id ID of the post we're retrieving categories for. When `false`, we assume the
+ * current post in the loop.
+ */
+ $categories = apply_filters( 'the_category_list', get_the_category( $post_id ), $post_id );
- $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 +202,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 +225,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,7 +267,6 @@ 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)
@@ -266,35 +307,51 @@ function category_description( $category = 0 ) {
/**
* Display or retrieve the HTML dropdown list of categories.
*
- * 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.
- * 'orderby' (string) default is 'ID' - What column to use for ordering the
- * categories.
- * 'order' (string) default is 'ASC' - What direction to order 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
- * don't have any posts attached to them.
- * 'child_of' (int) default is 0 - See {@link get_categories()}.
- * 'exclude' (string) - See {@link get_categories()}.
- * 'echo' (bool|int) default is 1 - Whether to display or retrieve content.
- * 'depth' (int) - The max depth.
- * 'tab_index' (int) - Tab index for select element.
- * 'name' (string) - The name attribute value for select element.
- * 'id' (string) - The ID attribute value for select element. Defaults to name if omitted.
- * 'class' (string) - The class attribute value for select element.
- * 'selected' (int) - Which category ID is selected.
- * 'taxonomy' (string) - The name of the taxonomy to retrieve. Defaults to category.
- *
* The 'hierarchical' argument, which is disabled by default, will override the
* depth argument, unless it is true. When the argument is false, it will
* display all of the categories. When it is enabled it will use the value in
* the 'depth' argument.
*
* @since 2.1.0
- *
- * @param string|array $args Optional. Override default arguments.
+ * @since 4.2.0 Introduced the `value_field` argument.
+ *
+ * @param string|array $args {
+ * Optional. Array or string of arguments to generate a categories drop-down element.
+ *
+ * @type string $show_option_all Text to display for showing all categories. Default empty.
+ * @type string $show_option_none Text to display for showing no categories. Default empty.
+ * @type string $option_none_value Value to use when no category is selected. Default empty.
+ * @type string $orderby Which column to use for ordering categories. See get_terms() for a list
+ * of accepted values. Default 'id' (term_id).
+ * @type string $order Whether to order terms in ascending or descending order. Accepts 'ASC'
+ * or 'DESC'. Default 'ASC'.
+ * @type bool $pad_counts See get_terms() for an argument description. Default false.
+ * @type bool|int $show_count Whether to include post counts. Accepts 0, 1, or their bool equivalents.
+ * Default 0.
+ * @type bool|int $hide_empty Whether to hide categories that don't have any posts. Accepts 0, 1, or
+ * their bool equivalents. Default 1.
+ * @type int $child_of Term ID to retrieve child terms of. See get_terms(). Default 0.
+ * @type array|string $exclude Array or comma/space-separated string of term ids to exclude.
+ * If `$include` is non-empty, `$exclude` is ignored. Default empty array.
+ * @type bool|int $echo Whether to echo or return the generated markup. Accepts 0, 1, or their
+ * bool equivalents. Default 1.
+ * @type bool|int $hierarchical Whether to traverse the taxonomy hierarchy. Accepts 0, 1, or their bool
+ * equivalents. Default 0.
+ * @type int $depth Maximum depth. Default 0.
+ * @type int $tab_index Tab index for the select element. Default 0 (no tabindex).
+ * @type string $name Value for the 'name' attribute of the select element. Default 'cat'.
+ * @type string $id Value for the 'id' attribute of the select element. Defaults to the value
+ * of `$name`.
+ * @type string $class Value for the 'class' attribute of the select element. Default 'postform'.
+ * @type int|string $selected Value of the option that should be selected. Default 0.
+ * @type string $value_field Term field that should be used to populate the 'value' attribute
+ * of the option elements. Accepts any valid term field: 'term_id', 'name',
+ * 'slug', 'term_group', 'term_taxonomy_id', 'taxonomy', 'description',
+ * 'parent', 'count'. Default 'term_id'.
+ * @type string $taxonomy Name of the category to retrieve. Default 'category'.
+ * @type bool $hide_if_empty True to skip generating markup if no categories are found.
+ * Default false (create select element even if no categories are found).
+ * }
* @return string HTML content only if 'echo' argument is 0.
*/
function wp_dropdown_categories( $args = '' ) {
@@ -308,107 +365,163 @@ 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,
+ 'value_field' => 'term_id',
);
$defaults['selected'] = ( is_category() ) ? get_query_var( 'cat' ) : 0;
// Back compat.
if ( isset( $args['type'] ) && 'link' == $args['type'] ) {
- _deprecated_argument( __FUNCTION__, '3.0', '' );
+ /* translators: 1: "type => link", 2: "taxonomy => link_category" alternative */
+ _deprecated_argument( __FUNCTION__, '3.0',
+ sprintf( __( '%1$s is deprecated. Use %2$s instead.' ),
+ 'type => link',
+ 'taxonomy => link_category'
+ )
+ );
$args['taxonomy'] = 'link_category';
}
$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( $taxonomy, $r );
- $name = esc_attr( $name );
- $class = esc_attr( $class );
- $id = $id ? esc_attr( $id ) : $name;
+ // Avoid clashes with the 'name' param of get_terms().
+ $get_terms_args = $r;
+ unset( $get_terms_args['name'] );
+ $categories = get_terms( $r['taxonomy'], $get_terms_args );
- if ( ! $r['hide_if_empty'] || ! empty($categories) )
+ $name = esc_attr( $r['name'] );
+ $class = esc_attr( $r['class'] );
+ $id = $r['id'] ? esc_attr( $r['id'] ) : $name;
+
+ if ( ! $r['hide_if_empty'] || ! empty( $categories ) ) {
$output = "\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;
}
/**
* Display or retrieve the HTML list of categories.
*
- * The list of arguments is below:
- * 'show_option_all' (string) - Text to display for showing all categories.
- * 'orderby' (string) default is 'ID' - What column to use for ordering the
- * categories.
- * 'order' (string) default is 'ASC' - What direction to order 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
- * 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.
- * 'feed' - See {@link get_categories()}.
- * 'feed_type' - See {@link get_categories()}.
- * 'feed_image' - See {@link get_categories()}.
- * 'child_of' (int) default is 0 - See {@link get_categories()}.
- * 'exclude' (string) - See {@link get_categories()}.
- * 'exclude_tree' (string) - See {@link get_categories()}.
- * 'echo' (bool|int) default is 1 - Whether to display or retrieve content.
- * 'current_category' (int) - See {@link get_categories()}.
- * 'hierarchical' (bool) - See {@link get_categories()}.
- * 'title_li' (string) - See {@link get_categories()}.
- * 'depth' (int) - The max depth.
- *
* @since 2.1.0
- *
- * @param string|array $args Optional. Override default arguments.
- * @return string HTML content only if 'echo' argument is 0.
+ * @since 4.4.0 Introduced the `hide_title_if_empty` and `separator` arguments. The `current_category` argument was modified to
+ * optionally accept an array of values.
+ *
+ * @param string|array $args {
+ * Array of optional arguments.
+ *
+ * @type string $show_option_all Text to display for showing all categories. Default empty string.
+ * @type string $show_option_none Text to display for the 'no categories' option.
+ * Default 'No categories'.
+ * @type string $orderby The column to use for ordering categories. Default 'ID'.
+ * @type string $order Which direction to order categories. Accepts 'ASC' or 'DESC'.
+ * Default 'ASC'.
+ * @type bool|int $show_count Whether to show how many posts are in the category. Default 0.
+ * @type bool|int $hide_empty Whether to hide categories that don't have any posts attached to them.
+ * Default 1.
+ * @type bool|int $use_desc_for_title Whether to use the category description as the title attribute.
+ * Default 1.
+ * @type string $feed Text to use for the feed link. Default 'Feed for all posts filed
+ * under [cat name]'.
+ * @type string $feed_type Feed type. Used to build feed link. See {@link get_term_feed_link()}.
+ * Default empty string (default feed).
+ * @type string $feed_image URL of an image to use for the feed link. Default empty string.
+ * @type int $child_of Term ID to retrieve child terms of. See {@link get_terms()}. Default 0.
+ * @type array|string $exclude Array or comma/space-separated string of term IDs to exclude.
+ * If `$hierarchical` is true, descendants of `$exclude` terms will also
+ * be excluded; see `$exclude_tree`. See {@link get_terms()}.
+ * Default empty string.
+ * @type array|string $exclude_tree Array or comma/space-separated string of term IDs to exclude, along
+ * with their descendants. See {@link get_terms()}. Default empty string.
+ * @type bool|int $echo True to echo markup, false to return it. Default 1.
+ * @type int|array $current_category ID of category, or array of IDs of categories, that should get the
+ * 'current-cat' class. Default 0.
+ * @type bool $hierarchical Whether to include terms that have non-empty descendants.
+ * See {@link get_terms()}. Default true.
+ * @type string $title_li Text to use for the list title `
` element. Pass an empty string
+ * to disable. Default 'Categories'.
+ * @type bool $hide_title_if_empty Whether to hide the `$title_li` element if there are no terms in
+ * the list. Default false (title will always be shown).
+ * @type int $depth Category depth. Used for tab indentation. Default 0.
+ * @type string $taxonomy Taxonomy name. Default 'category'.
+ * }
+ * @return false|string HTML content only if 'echo' argument is 0.
*/
function wp_list_categories( $args = '' ) {
$defaults = array(
@@ -421,7 +534,9 @@ function wp_list_categories( $args = '' ) {
'feed_image' => '', 'exclude' => '',
'exclude_tree' => '', 'current_category' => 0,
'hierarchical' => true, 'title_li' => __( 'Categories' ),
+ 'hide_title_if_empty' => false,
'echo' => 1, 'depth' => 0,
+ 'separator' => ' ',
'taxonomy' => 'category'
);
@@ -430,65 +545,115 @@ function wp_list_categories( $args = '' ) {
if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] )
$r['pad_counts'] = true;
+ // Descendants of exclusions should be excluded too.
if ( true == $r['hierarchical'] ) {
- $r['exclude_tree'] = $r['exclude'];
+ $exclude_tree = array();
+
+ if ( $r['exclude_tree'] ) {
+ $exclude_tree = array_merge( $exclude_tree, (array) $r['exclude_tree'] );
+ }
+
+ if ( $r['exclude'] ) {
+ $exclude_tree = array_merge( $exclude_tree, (array) $r['exclude'] );
+ }
+
+ $r['exclude_tree'] = $exclude_tree;
$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 = '
\n";
- break;
- default :
- $return = join( $separator, $a );
- break;
- endswitch;
-
- if ( $filter )
+ 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;
}
@@ -702,6 +950,7 @@ function wp_generate_tag_cloud( $tags, $args = '' ) {
*
* @since 3.1.0
* @access private
+ * @return int
*/
function _wp_object_name_sort_cb( $a, $b ) {
return strnatcasecmp( $a->name, $b->name );
@@ -712,6 +961,7 @@ function _wp_object_name_sort_cb( $a, $b ) {
*
* @since 3.1.0
* @access private
+ * @return bool
*/
function _wp_object_count_sort_cb( $a, $b ) {
return ( $a->count > $b->count );
@@ -727,16 +977,17 @@ function _wp_object_count_sort_cb( $a, $b ) {
* @uses Walker_Category to create HTML list content.
* @since 2.1.0
* @see Walker_Category::walk() for parameters and return description.
+ * @return string
*/
function walk_category_tree() {
$args = func_get_args();
// the user's options are the third parameter
- if ( empty($args[2]['walker']) || !is_a($args[2]['walker'], 'Walker') )
+ if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) {
$walker = new Walker_Category;
- else
+ } else {
$walker = $args[2]['walker'];
-
- return call_user_func_array(array( &$walker, 'walk' ), $args );
+ }
+ return call_user_func_array( array( $walker, 'walk' ), $args );
}
/**
@@ -745,229 +996,17 @@ function walk_category_tree() {
* @uses Walker_CategoryDropdown to create HTML dropdown content.
* @since 2.1.0
* @see Walker_CategoryDropdown::walk() for parameters and return description.
+ * @return string
*/
function walk_category_dropdown_tree() {
$args = func_get_args();
// the user's options are the third parameter
- if ( empty($args[2]['walker']) || !is_a($args[2]['walker'], 'Walker') )
+ if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) {
$walker = new Walker_CategoryDropdown;
- else
+ } else {
$walker = $args[2]['walker'];
-
- return call_user_func_array(array( &$walker, 'walk' ), $args );
-}
-
-/**
- * Create HTML list of categories.
- *
- * @package WordPress
- * @since 2.1.0
- * @uses Walker
- */
-class Walker_Category extends Walker {
- /**
- * What the class handles.
- *
- * @see Walker::$tree_type
- * @since 2.1.0
- * @var string
- */
- var $tree_type = 'category';
-
- /**
- * Database fields to use.
- *
- * @see Walker::$db_fields
- * @since 2.1.0
- * @todo Decouple this
- * @var array
- */
- 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 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() ) {
- if ( 'list' != $args['style'] )
- return;
-
- $indent = str_repeat("\t", $depth);
- $output .= "$indent
\n";
- }
-
- /**
- * 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 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() ) {
- if ( 'list' != $args['style'] )
- return;
-
- $indent = str_repeat("\t", $depth);
- $output .= "$indent
\n";
- }
-
- /**
- * Start the element output.
- *
- * @see Walker::start_el()
- *
- * @since 2.1.0
- *
- * @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. 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 = 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
- $link .= 'title="' . esc_attr( strip_tags( apply_filters( 'category_description', $category->description, $category ) ) ) . '"';
- $link .= '>';
- $link .= $cat_name . '';
-
- if ( !empty($feed_image) || !empty($feed) ) {
- $link .= ' ';
-
- if ( empty($feed_image) )
- $link .= '(';
-
- $link .= '';
-
- $link .= '';
-
- if ( empty($feed_image) )
- $link .= ')';
- }
-
- if ( !empty($show_count) )
- $link .= ' (' . intval($category->count) . ')';
-
- if ( 'list' == $args['style'] ) {
- $output .= "\t
term_id;
- if ( !empty($current_category) ) {
- $_current_category = get_term( $current_category, $category->taxonomy );
- if ( $category->term_id == $current_category )
- $class .= ' current-cat';
- elseif ( $category->term_id == $_current_category->parent )
- $class .= ' current-cat-parent';
- }
- $output .= ' class="' . $class . '"';
- $output .= ">$link\n";
- } else {
- $output .= "\t$link \n";
- }
- }
-
- /**
- * Ends the element output, if needed.
- *
- * @see Walker::end_el()
- *
- * @since 2.1.0
- *
- * @param string $output Passed by reference. Used to append additional content.
- * @param object $page Not used.
- * @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() ) {
- if ( 'list' != $args['style'] )
- return;
-
- $output .= "
\n";
- }
-
-}
-
-/**
- * Create HTML dropdown list of Categories.
- *
- * @package WordPress
- * @since 2.1.0
- * @uses Walker
- */
-class Walker_CategoryDropdown extends Walker {
- /**
- * @see Walker::$tree_type
- * @since 2.1.0
- * @var string
- */
- var $tree_type = 'category';
-
- /**
- * @see Walker::$db_fields
- * @since 2.1.0
- * @todo Decouple this
- * @var array
- */
- var $db_fields = array ('parent' => '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 object $category Category data object.
- * @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 ) {
- $pad = str_repeat(' ', $depth * 3);
-
- $cat_name = apply_filters('list_cats', $category->name, $category);
- $output .= "\t\n";
}
+ return call_user_func_array( array( $walker, 'walk' ), $args );
}
//
@@ -999,12 +1038,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.
+ * @return array|false|WP_Error 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' ) );
}
@@ -1012,15 +1060,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|false|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.
*/
function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {
+
+ /**
+ * Filter the tags list for a given post.
+ *
+ * @since 2.3.0
+ *
+ * @param string $tag_list List of tags.
+ * @param string $before String to use before tags.
+ * @param string $sep String to use between the tags.
+ * @param string $after String to use after tags.
+ * @param int $id Post ID.
+ */
return apply_filters( 'the_tags', get_the_term_list( $id, 'post_tag', $before, $sep, $after ), $before, $sep, $after, $id );
}
@@ -1042,7 +1101,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.
@@ -1054,7 +1113,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'.
@@ -1079,7 +1138,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|false|WP_Error Array of term objects on success, false if there are no terms
+ * or the post does not exist, WP_Error on failure.
*/
function get_the_terms( $post, $taxonomy ) {
if ( ! $post = get_post( $post ) )
@@ -1088,9 +1148,24 @@ function get_the_terms( $post, $taxonomy ) {
$terms = get_object_term_cache( $post->ID, $taxonomy );
if ( false === $terms ) {
$terms = wp_get_object_terms( $post->ID, $taxonomy );
- wp_cache_add($post->ID, $terms, $taxonomy . '_relationships');
+ $to_cache = array();
+ foreach ( $terms as $key => $term ) {
+ $to_cache[ $key ] = $term->data;
+ }
+ wp_cache_add( $post->ID, $to_cache, $taxonomy . '_relationships' );
}
+ $terms = array_map( 'get_term', $terms );
+
+ /**
+ * 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 ) )
@@ -1109,7 +1184,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|false|WP_Error A list of terms on success, false if there are no terms, WP_Error on failure.
*/
function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {
$terms = get_the_terms( $id, $taxonomy );
@@ -1120,14 +1195,27 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = ''
if ( empty( $terms ) )
return false;
+ $links = array();
+
foreach ( $terms as $term ) {
$link = get_term_link( $term, $taxonomy );
- if ( is_wp_error( $link ) )
+ if ( is_wp_error( $link ) ) {
return $link;
- $term_links[] = '' . $term->name . '';
+ }
+ $links[] = '' . $term->name . '';
}
- $term_links = apply_filters( "term_links-$taxonomy", $term_links );
+ /**
+ * Filter the term links for a given taxonomy.
+ *
+ * The dynamic portion of the filter name, `$taxonomy`, refers
+ * to the taxonomy slug.
+ *
+ * @since 2.5.0
+ *
+ * @param array $links An array of term links.
+ */
+ $term_links = apply_filters( "term_links-$taxonomy", $links );
return $before . join( $sep, $term_links ) . $after;
}
@@ -1142,7 +1230,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|void False on WordPress error.
*/
function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' ) {
$term_list = get_the_term_list( $id, $taxonomy, $before, $sep, $after );
@@ -1150,7 +1238,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 );
}
/**