3 * Taxonomy API: Core category-specific functionality
10 * Retrieve list of category objects.
12 * If you change the type to 'link' in the arguments, then the link categories
13 * will be returned instead. Also all categories will be updated to be backwards
14 * compatible with pre-2.3 plugins and themes.
17 * @see get_terms() Type of arguments that can be changed.
19 * @param string|array $args {
20 * Optional. Arguments to retrieve categories. See {@see get_terms()} for additional options.
22 * @type string $taxonomy Taxonomy to retrieve terms for. In this case, default 'category'.
24 * @return array List of categories.
26 function get_categories( $args = '' ) {
27 $defaults = array( 'taxonomy' => 'category' );
28 $args = wp_parse_args( $args, $defaults );
30 $taxonomy = $args['taxonomy'];
33 * Filter the taxonomy used to retrieve terms when calling {@see get_categories()}.
37 * @param string $taxonomy Taxonomy to retrieve terms from.
38 * @param array $args An array of arguments. See {@see get_terms()}.
40 $taxonomy = apply_filters( 'get_categories_taxonomy', $taxonomy, $args );
43 if ( isset($args['type']) && 'link' == $args['type'] ) {
44 /* translators: 1: "type => link", 2: "taxonomy => link_category" alternative */
45 _deprecated_argument( __FUNCTION__, '3.0',
46 sprintf( __( '%1$s is deprecated. Use %2$s instead.' ),
47 '<code>type => link</code>',
48 '<code>taxonomy => link_category</code>'
51 $taxonomy = $args['taxonomy'] = 'link_category';
54 $categories = get_terms( $taxonomy, $args );
56 if ( is_wp_error( $categories ) ) {
57 $categories = array();
59 $categories = (array) $categories;
60 foreach ( array_keys( $categories ) as $k ) {
61 _make_cat_compat( $categories[ $k ] );
69 * Retrieves category data given a category ID or category object.
71 * If you pass the $category parameter an object, which is assumed to be the
72 * category row object retrieved the database. It will cache the category data.
74 * If you pass $category an integer of the category ID, then that category will
75 * be retrieved from the database, if it isn't already cached, and pass it back.
77 * If you look at get_term(), then both types will be passed through several
78 * filters and finally sanitized based on the $filter parameter value.
80 * The category will converted to maintain backwards compatibility.
84 * @param int|object $category Category ID or Category row object
85 * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
86 * @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
87 * @return object|array|WP_Error|null Category data in type defined by $output parameter.
88 * WP_Error if $category is empty, null if it does not exist.
90 function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
91 $category = get_term( $category, 'category', $output, $filter );
93 if ( is_wp_error( $category ) )
96 _make_cat_compat( $category );
102 * Retrieve category based on URL containing the category slug.
104 * Breaks the $category_path parameter up to get the category slug.
106 * Tries to find the child path and will return it. If it doesn't find a
107 * match, then it will return the first category matching slug, if $full_match,
108 * is set to false. If it does not, then it will return null.
110 * It is also possible that it will return a WP_Error object on failure. Check
111 * for it when using this function.
115 * @param string $category_path URL containing category slugs.
116 * @param bool $full_match Optional. Whether full path should be matched.
117 * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
118 * @return object|array|WP_Error|void Type is based on $output value.
120 function get_category_by_path( $category_path, $full_match = true, $output = OBJECT ) {
121 $category_path = rawurlencode( urldecode( $category_path ) );
122 $category_path = str_replace( '%2F', '/', $category_path );
123 $category_path = str_replace( '%20', ' ', $category_path );
124 $category_paths = '/' . trim( $category_path, '/' );
125 $leaf_path = sanitize_title( basename( $category_paths ) );
126 $category_paths = explode( '/', $category_paths );
128 foreach ( (array) $category_paths as $pathdir ) {
129 $full_path .= ( $pathdir != '' ? '/' : '' ) . sanitize_title( $pathdir );
131 $categories = get_terms( 'category', array('get' => 'all', 'slug' => $leaf_path) );
133 if ( empty( $categories ) ) {
137 foreach ( $categories as $category ) {
138 $path = '/' . $leaf_path;
139 $curcategory = $category;
140 while ( ( $curcategory->parent != 0 ) && ( $curcategory->parent != $curcategory->term_id ) ) {
141 $curcategory = get_term( $curcategory->parent, 'category' );
142 if ( is_wp_error( $curcategory ) ) {
145 $path = '/' . $curcategory->slug . $path;
148 if ( $path == $full_path ) {
149 $category = get_term( $category->term_id, 'category', $output );
150 _make_cat_compat( $category );
155 // If full matching is not required, return the first cat that matches the leaf.
156 if ( ! $full_match ) {
157 $category = get_term( reset( $categories )->term_id, 'category', $output );
158 _make_cat_compat( $category );
164 * Retrieve category object by category slug.
168 * @param string $slug The category slug.
169 * @return object Category data object
171 function get_category_by_slug( $slug ) {
172 $category = get_term_by( 'slug', $slug, 'category' );
174 _make_cat_compat( $category );
180 * Retrieve the ID of a category from its name.
184 * @param string $cat_name Category name.
185 * @return int 0, if failure and ID of category on success.
187 function get_cat_ID( $cat_name ) {
188 $cat = get_term_by( 'name', $cat_name, 'category' );
190 return $cat->term_id;
195 * Retrieve the name of a category from its ID.
199 * @param int $cat_id Category ID
200 * @return string Category name, or an empty string if category doesn't exist.
202 function get_cat_name( $cat_id ) {
203 $cat_id = (int) $cat_id;
204 $category = get_term( $cat_id, 'category' );
205 if ( ! $category || is_wp_error( $category ) )
207 return $category->name;
211 * Check if a category is an ancestor of another category.
213 * You can use either an id or the category object for both parameters. If you
214 * use an integer the category will be retrieved.
218 * @param int|object $cat1 ID or object to check if this is the parent category.
219 * @param int|object $cat2 The child category.
220 * @return bool Whether $cat2 is child of $cat1
222 function cat_is_ancestor_of( $cat1, $cat2 ) {
223 return term_is_ancestor_of( $cat1, $cat2, 'category' );
227 * Sanitizes category data based on context.
231 * @param object|array $category Category data
232 * @param string $context Optional. Default is 'display'.
233 * @return object|array Same type as $category with sanitized data for safe use.
235 function sanitize_category( $category, $context = 'display' ) {
236 return sanitize_term( $category, 'category', $context );
240 * Sanitizes data in single category key field.
244 * @param string $field Category key to sanitize
245 * @param mixed $value Category value to sanitize
246 * @param int $cat_id Category ID
247 * @param string $context What filter to use, 'raw', 'display', etc.
248 * @return mixed Same type as $value after $value has been sanitized.
250 function sanitize_category_field( $field, $value, $cat_id, $context ) {
251 return sanitize_term_field( $field, $value, $cat_id, 'category', $context );
257 * Retrieves all post tags.
260 * @see get_terms() For list of arguments to pass.
262 * @param string|array $args Tag arguments to use when retrieving tags.
263 * @return array List of tags.
265 function get_tags( $args = '' ) {
266 $tags = get_terms( 'post_tag', $args );
268 if ( empty( $tags ) ) {
274 * Filter the array of term objects returned for the 'post_tag' taxonomy.
278 * @param array $tags Array of 'post_tag' term objects.
279 * @param array $args An array of arguments. @see get_terms()
281 $tags = apply_filters( 'get_tags', $tags, $args );
286 * Retrieve post tag by tag ID or tag object.
288 * If you pass the $tag parameter an object, which is assumed to be the tag row
289 * object retrieved the database. It will cache the tag data.
291 * If you pass $tag an integer of the tag ID, then that tag will
292 * be retrieved from the database, if it isn't already cached, and pass it back.
294 * If you look at get_term(), then both types will be passed through several
295 * filters and finally sanitized based on the $filter parameter value.
299 * @param int|object $tag
300 * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
301 * @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
302 * @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.
304 function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
305 return get_term( $tag, 'post_tag', $output, $filter );
311 * Remove the category cache data based on ID.
315 * @param int $id Category ID
317 function clean_category_cache( $id ) {
318 clean_term_cache( $id, 'category' );
322 * Update category structure to old pre 2.3 from new taxonomy structure.
324 * This function was added for the taxonomy support to update the new category
325 * structure with the old category one. This will maintain compatibility with
326 * plugins and themes which depend on the old key or property names.
328 * The parameter should only be passed a variable and not create the array or
329 * object inline to the parameter. The reason for this is that parameter is
330 * passed by reference and PHP will fail unless it has the variable.
332 * There is no return value, because everything is updated on the variable you
333 * pass to it. This is one of the features with using pass by reference in PHP.
336 * @since 4.4.0 The `$category` parameter now also accepts a WP_Term object.
339 * @param array|object|WP_Term $category Category Row object or array
341 function _make_cat_compat( &$category ) {
342 if ( is_object( $category ) && ! is_wp_error( $category ) ) {
343 $category->cat_ID = $category->term_id;
344 $category->category_count = $category->count;
345 $category->category_description = $category->description;
346 $category->cat_name = $category->name;
347 $category->category_nicename = $category->slug;
348 $category->category_parent = $category->parent;
349 } elseif ( is_array( $category ) && isset( $category['term_id'] ) ) {
350 $category['cat_ID'] = &$category['term_id'];
351 $category['category_count'] = &$category['count'];
352 $category['category_description'] = &$category['description'];
353 $category['cat_name'] = &$category['name'];
354 $category['category_nicename'] = &$category['slug'];
355 $category['category_parent'] = &$category['parent'];