X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/4f9d63e13cd8c6e275797c75b401b074b82937bc..refs/tags/wordpress-4.6-scripts:/wp-includes/category-template.php?ds=sidebyside
diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php
index db55a12c..7063c2d4 100644
--- a/wp-includes/category-template.php
+++ b/wp-includes/category-template.php
@@ -1,41 +1,31 @@
get_category_permastruct();
+function get_category_link( $category ) {
+ if ( ! is_object( $category ) )
+ $category = (int) $category;
- if ( empty( $catlink ) ) {
- $catlink = home_url('?cat=' . $category_id);
- } else {
- $category = &get_category( $category_id );
- if ( is_wp_error( $category ) )
- return $category;
- $category_nicename = $category->slug;
+ $category = get_term_link( $category, 'category' );
- if ( $category->parent == $category_id ) // recursive recursion
- $category->parent = 0;
- elseif ($category->parent != 0 )
- $category_nicename = get_category_parents( $category->parent, false, '/', true ) . $category_nicename;
+ if ( is_wp_error( $category ) )
+ return '';
- $catlink = str_replace( '%category%', $category_nicename, $catlink );
- $catlink = home_url( user_trailingslashit( $catlink, 'category' ) );
- }
- return apply_filters( 'category_link', $catlink, $category_id );
+ return $category;
}
/**
@@ -48,18 +38,18 @@ function get_category_link( $category_id ) {
* @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;
if ( $nicename )
$name = $parent->slug;
else
- $name = $parent->cat_name;
+ $name = $parent->name;
if ( $parent->parent && ( $parent->parent != $parent->term_id ) && !in_array( $parent->parent, $visited ) ) {
$visited[] = $parent->parent;
@@ -67,7 +57,7 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename =
}
if ( $link )
- $chain .= 'cat_name ) ) . '">'.$name.'' . $separator;
+ $chain .= ''.$name.'' . $separator;
else
$chain .= $name.$separator;
return $chain;
@@ -76,35 +66,37 @@ 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 WP_Term objects, one for each category assigned to the post.
*/
function get_the_category( $id = false ) {
- global $post;
-
- $id = (int) $id;
- if ( !$id )
- $id = (int) $post->ID;
-
- $categories = get_object_term_cache( $id, 'category' );
- if ( false === $categories ) {
- $categories = wp_get_object_terms( $id, 'category' );
- wp_cache_add($id, $categories, 'category_relationships');
- }
-
- if ( !empty( $categories ) )
- usort( $categories, '_usort_terms_by_name' );
- else
+ $categories = get_the_terms( $id, 'category' );
+ if ( ! $categories || is_wp_error( $categories ) )
$categories = array();
- foreach ( (array) array_keys( $categories ) as $key ) {
+ $categories = array_values( $categories );
+
+ foreach ( array_keys( $categories ) as $key ) {
_make_cat_compat( $categories[$key] );
}
- return $categories;
+ /**
+ * Filters 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 );
}
/**
@@ -152,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 : '';
}
/**
@@ -167,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.
@@ -174,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 );
+ }
+
+ /**
+ * Filters 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 ) )
+ 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"';
@@ -192,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->cat_name.'';
+ $thelist .= '' . $category->name.'';
}
}
$thelist .= '';
@@ -215,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->cat_name.'';
+ $thelist .= '' . $category->name.'';
break;
case 'single':
- $thelist .= 'name ) ) . '" ' . $rel . '>';
+ $thelist .= '';
if ( $category->parent )
$thelist .= get_category_parents( $category->parent, false, $separator );
- $thelist .= "$category->cat_name";
+ $thelist .= "$category->name";
break;
case '':
default:
- $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.'';
+ $thelist .= '' . $category->name.'';
}
++$i;
}
}
+
+ /**
+ * Filters 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.
*
@@ -248,29 +268,15 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false )
*
* @since 1.2.0
*
- * @uses is_object_in_term()
- *
- * @param int|string|array $category. Category ID, name or slug, or array of said.
- * @param int|post object Optional. Post to check instead of the current post. @since 2.7.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)
* @return bool True if the current post is in any of the given categories.
*/
-function in_category( $category, $_post = null ) {
+function in_category( $category, $post = null ) {
if ( empty( $category ) )
return false;
- if ( $_post ) {
- $_post = get_post( $_post );
- } else {
- $_post =& $GLOBALS['post'];
- }
-
- if ( !$_post )
- return false;
-
- $r = is_object_in_term( $_post->ID, 'category', $category );
- if ( is_wp_error( $r ) )
- return false;
- return $r;
+ return has_category( $category, $post );
}
/**
@@ -301,167 +307,264 @@ 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.
+ * @since 4.6.0 Introduced the `required` 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).
+ * @type bool $required Whether the `