<?php
/**
- * WordPress Category API
+ * Taxonomy API: Core category-specific functionality
*
* @package WordPress
+ * @subpackage Taxonomy
*/
-/**
- * Retrieves all category IDs.
- *
- * @since 2.0.0
- * @link http://codex.wordpress.org/Function_Reference/get_all_category_ids
- *
- * @return object List of all of the category IDs.
- */
-function get_all_category_ids() {
- if ( ! $cat_ids = wp_cache_get( 'all_category_ids', 'category' ) ) {
- $cat_ids = get_terms( 'category', 'fields=ids&get=all' );
- wp_cache_add( 'all_category_ids', $cat_ids, 'category' );
- }
-
- return $cat_ids;
-}
-
/**
* Retrieve list of category objects.
*
*
* @since 2.1.0
* @see get_terms() Type of arguments that can be changed.
- * @link http://codex.wordpress.org/Function_Reference/get_categories
+ * @link https://codex.wordpress.org/Function_Reference/get_categories
*
* @param string|array $args Optional. Change the defaults retrieving categories.
* @return array List of categories.
*/
-function &get_categories( $args = '' ) {
- $defaults = array( 'type' => 'category' );
+function get_categories( $args = '' ) {
+ $defaults = array( 'taxonomy' => 'category' );
$args = wp_parse_args( $args, $defaults );
- $taxonomy = apply_filters( 'get_categories_taxonomy', 'category', $args );
- if ( 'link' == $args['type'] )
- $taxonomy = 'link_category';
+ $taxonomy = $args['taxonomy'];
+
+ /**
+ * Filter the taxonomy used to retrieve terms when calling {@see get_categories()}.
+ *
+ * @since 2.7.0
+ *
+ * @param string $taxonomy Taxonomy to retrieve terms from.
+ * @param array $args An array of arguments. See {@see get_terms()}.
+ */
+ $taxonomy = apply_filters( 'get_categories_taxonomy', $taxonomy, $args );
+
+ // Back compat
+ if ( isset($args['type']) && 'link' == $args['type'] ) {
+ /* translators: 1: "type => link", 2: "taxonomy => link_category" alternative */
+ _deprecated_argument( __FUNCTION__, '3.0',
+ sprintf( __( '%1$s is deprecated. Use %2$s instead.' ),
+ '<code>type => link</code>',
+ '<code>taxonomy => link_category</code>'
+ )
+ );
+ $taxonomy = $args['taxonomy'] = 'link_category';
+ }
+
$categories = (array) get_terms( $taxonomy, $args );
foreach ( array_keys( $categories ) as $k )
* The category will converted to maintain backwards compatibility.
*
* @since 1.5.1
- * @uses get_term() Used to get the category data from the taxonomy.
*
* @param int|object $category Category ID or Category row object
* @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
* @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
- * @return mixed Category data in type defined by $output parameter.
+ * @return object|array|WP_Error|null Category data in type defined by $output parameter.
+ * WP_Error if $category is empty, null if it does not exist.
*/
-function &get_category( $category, $output = OBJECT, $filter = 'raw' ) {
+function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
$category = get_term( $category, 'category', $output, $filter );
+
if ( is_wp_error( $category ) )
return $category;
* @since 2.1.0
*
* @param string $category_path URL containing category slugs.
- * @param bool $full_match Optional. Whether should match full path or not.
+ * @param bool $full_match Optional. Whether full path should be matched.
* @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
- * @return null|object|array Null on failure. Type is based on $output value.
+ * @return object|array|WP_Error|void Type is based on $output value.
*/
function get_category_by_path( $category_path, $full_match = true, $output = OBJECT ) {
$category_path = rawurlencode( urldecode( $category_path ) );
$leaf_path = sanitize_title( basename( $category_paths ) );
$category_paths = explode( '/', $category_paths );
$full_path = '';
- foreach ( (array) $category_paths as $pathdir )
+ foreach ( (array) $category_paths as $pathdir ) {
$full_path .= ( $pathdir != '' ? '/' : '' ) . sanitize_title( $pathdir );
+ }
+ $categories = get_terms( 'category', array('get' => 'all', 'slug' => $leaf_path) );
- $categories = get_terms( 'category', "get=all&slug=$leaf_path" );
-
- if ( empty( $categories ) )
- return null;
+ if ( empty( $categories ) ) {
+ return;
+ }
foreach ( $categories as $category ) {
$path = '/' . $leaf_path;
$curcategory = $category;
while ( ( $curcategory->parent != 0 ) && ( $curcategory->parent != $curcategory->term_id ) ) {
$curcategory = get_term( $curcategory->parent, 'category' );
- if ( is_wp_error( $curcategory ) )
+ if ( is_wp_error( $curcategory ) ) {
return $curcategory;
+ }
$path = '/' . $curcategory->slug . $path;
}
- if ( $path == $full_path )
- return get_category( $category->term_id, $output );
+ if ( $path == $full_path ) {
+ $category = get_term( $category->term_id, 'category', $output );
+ _make_cat_compat( $category );
+ return $category;
+ }
}
// If full matching is not required, return the first cat that matches the leaf.
- if ( ! $full_match )
- return get_category( $categories[0]->term_id, $output );
-
- return null;
+ if ( ! $full_match ) {
+ $category = get_term( reset( $categories )->term_id, 'category', $output );
+ _make_cat_compat( $category );
+ return $category;
+ }
}
/**
return $category;
}
-
/**
* Retrieve the ID of a category from its name.
*
* @since 1.0.0
*
- * @param string $cat_name Optional. Default is 'General' and can be any category name.
+ * @param string $cat_name Category name.
* @return int 0, if failure and ID of category on success.
*/
-function get_cat_ID( $cat_name='General' ) {
+function get_cat_ID( $cat_name ) {
$cat = get_term_by( 'name', $cat_name, 'category' );
if ( $cat )
return $cat->term_id;
return 0;
}
-
/**
* Retrieve the name of a category from its ID.
*
* @since 1.0.0
*
* @param int $cat_id Category ID
- * @return string Category name
+ * @return string Category name, or an empty string if category doesn't exist.
*/
function get_cat_name( $cat_id ) {
$cat_id = (int) $cat_id;
- $category = &get_category( $cat_id );
+ $category = get_term( $cat_id, 'category' );
+ if ( ! $category || is_wp_error( $category ) )
+ return '';
return $category->name;
}
-
/**
* Check if a category is an ancestor of another category.
*
* @return bool Whether $cat2 is child of $cat1
*/
function cat_is_ancestor_of( $cat1, $cat2 ) {
- if ( ! isset($cat1->term_id) )
- $cat1 = &get_category( $cat1 );
- if ( ! isset($cat2->parent) )
- $cat2 = &get_category( $cat2 );
-
- if ( empty($cat1->term_id) || empty($cat2->parent) )
- return false;
- if ( $cat2->parent == $cat1->term_id )
- return true;
-
- return cat_is_ancestor_of( $cat1, get_category( $cat2->parent ) );
+ return term_is_ancestor_of( $cat1, $cat2, 'category' );
}
-
/**
* Sanitizes category data based on context.
*
* @since 2.3.0
- * @uses sanitize_term() See this function for what context are supported.
*
* @param object|array $category Category data
* @param string $context Optional. Default is 'display'.
return sanitize_term( $category, 'category', $context );
}
-
/**
* Sanitizes data in single category key field.
*
* @since 2.3.0
- * @uses sanitize_term_field() See function for more details.
*
* @param string $field Category key to sanitize
* @param mixed $value Category value to sanitize
/* Tags */
-
/**
* Retrieves all post tags.
*
* @since 2.3.0
* @see get_terms() For list of arguments to pass.
- * @uses apply_filters() Calls 'get_tags' hook on array of tags and with $args.
*
* @param string|array $args Tag arguments to use when retrieving tags.
* @return array List of tags.
*/
-function &get_tags( $args = '' ) {
+function get_tags( $args = '' ) {
$tags = get_terms( 'post_tag', $args );
if ( empty( $tags ) ) {
return $return;
}
+ /**
+ * Filter the array of term objects returned for the 'post_tag' taxonomy.
+ *
+ * @since 2.3.0
+ *
+ * @param array $tags Array of 'post_tag' term objects.
+ * @param array $args An array of arguments. @see get_terms()
+ */
$tags = apply_filters( 'get_tags', $tags, $args );
return $tags;
}
-
/**
* Retrieve post tag by tag ID or tag object.
*
* @param int|object $tag
* @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
* @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
- * @return object|array Return type based on $output value.
+ * @return object|array|WP_Error|null Tag data in type defined by $output parameter. WP_Error if $tag is empty, null if it does not exist.
*/
-function &get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
+function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
return get_term( $tag, 'post_tag', $output, $filter );
}
-
/* Cache */
-
-/**
- * Update the categories cache.
- *
- * This function does not appear to be used anymore or does not appear to be
- * needed. It might be a legacy function left over from when there was a need
- * for updating the category cache.
- *
- * @since 1.5.0
- *
- * @return bool Always return True
- */
-function update_category_cache() {
- return true;
-}
-
-
/**
* Remove the category cache data based on ID.
*
* @since 2.1.0
- * @uses clean_term_cache() Clears the cache for the category based on ID
*
* @param int $id Category ID
*/
clean_term_cache( $id, 'category' );
}
-
/**
* Update category structure to old pre 2.3 from new taxonomy structure.
*
* pass to it. This is one of the features with using pass by reference in PHP.
*
* @since 2.3.0
+ * @since 4.4.0 The `$category` parameter now also accepts a WP_Term object.
* @access private
*
- * @param array|object $category Category Row object or array
+ * @param array|object|WP_Term $category Category Row object or array
*/
function _make_cat_compat( &$category ) {
- if ( is_object( $category ) ) {
- $category->cat_ID = &$category->term_id;
- $category->category_count = &$category->count;
- $category->category_description = &$category->description;
- $category->cat_name = &$category->name;
- $category->category_nicename = &$category->slug;
- $category->category_parent = &$category->parent;
+ if ( is_object( $category ) && ! is_wp_error( $category ) ) {
+ $category->cat_ID = $category->term_id;
+ $category->category_count = $category->count;
+ $category->category_description = $category->description;
+ $category->cat_name = $category->name;
+ $category->category_nicename = $category->slug;
+ $category->category_parent = $category->parent;
} elseif ( is_array( $category ) && isset( $category['term_id'] ) ) {
$category['cat_ID'] = &$category['term_id'];
$category['category_count'] = &$category['count'];
$category['category_parent'] = &$category['parent'];
}
}
-
-
-?>
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff