X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/f9001779751f83dc8a10e478bfecb4d8dd5f964c..refs/tags/wordpress-4.5:/wp-includes/category-template.php
diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php
index 382488de..35d6c82e 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,15 +66,19 @@ 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' );
- if ( ! $categories )
+ if ( ! $categories || is_wp_error( $categories ) )
$categories = array();
$categories = array_values( $categories );
@@ -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 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 );
}
/**
@@ -131,14 +144,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 : '';
}
/**
@@ -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;
- $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 ) )
+ /**
+ * 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 );
+
+ 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,25 +225,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 .= '' . $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 );
}
-
/**
* Check if the current post in within any of the given categories.
*
@@ -228,14 +269,14 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false )
* @since 1.2.0
*
* @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 );
}
/**
@@ -266,167 +307,247 @@ 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_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
- * 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|array $taxonomy Name of the category or categories 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 = '' ) {
$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,
'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;
}
- $r['include_last_update_time'] = $r['show_last_update'];
- 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";
-
- $output = apply_filters( 'wp_dropdown_cats', $output );
+ 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 );
- 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_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
- * 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 `