[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> category.php (summary)

Taxonomy API: Core category-specific functionality

File Size: 387 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 13 functions

  get_categories()
  get_category()
  get_category_by_path()
  get_category_by_slug()
  get_cat_ID()
  get_cat_name()
  cat_is_ancestor_of()
  sanitize_category()
  sanitize_category_field()
  get_tags()
  get_tag()
  clean_category_cache()
  _make_cat_compat()

Functions
Functions that are not part of a class:

get_categories( $args = '' )   X-Ref
Retrieves a list of category objects.

If you set the 'taxonomy' argument to 'link_category', the link categories
will be returned instead.

return: array List of category objects.
since: 2.1.0
param: string|array $args {

get_category( $category, $output = OBJECT, $filter = 'raw' )   X-Ref
Retrieves category data given a category ID or category object.

If you pass the $category parameter an object, which is assumed to be the
category row object retrieved the database. It will cache the category data.

If you pass $category an integer of the category ID, then that category will
be retrieved from the database, if it isn't already cached, and pass it back.

If you look at get_term(), then both types will be passed through several
filters and finally sanitized based on the $filter parameter value.

return: object|array|WP_Error|null Category data in type defined by $output parameter.
since: 1.5.1
param: int|object $category Category ID or Category row object
param: string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N,
param: string $filter Optional. Default is raw or no WordPress defined filter will applied.

get_category_by_path( $category_path, $full_match = true, $output = OBJECT )   X-Ref
Retrieves a category based on URL containing the category slug.

Breaks the $category_path parameter up to get the category slug.

Tries to find the child path and will return it. If it doesn't find a
match, then it will return the first category matching slug, if $full_match,
is set to false. If it does not, then it will return null.

It is also possible that it will return a WP_Error object on failure. Check
for it when using this function.

return: WP_Term|array|WP_Error|null Type is based on $output value.
since: 2.1.0
param: string $category_path URL containing category slugs.
param: bool   $full_match    Optional. Whether full path should be matched.
param: string $output        Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N,

get_category_by_slug( $slug )   X-Ref
Retrieves a category object by category slug.

return: object|false Category data object on success, false if not found.
since: 2.3.0
param: string $slug The category slug.

get_cat_ID( $cat_name )   X-Ref
Retrieves the ID of a category from its name.

return: int Category ID on success, 0 if the category doesn't exist.
since: 1.0.0
param: string $cat_name Category name.

get_cat_name( $cat_id )   X-Ref
Retrieves the name of a category from its ID.

return: string Category name, or an empty string if the category doesn't exist.
since: 1.0.0
param: int $cat_id Category ID.

cat_is_ancestor_of( $cat1, $cat2 )   X-Ref
Checks if a category is an ancestor of another category.

You can use either an ID or the category object for both parameters.
If you use an integer, the category will be retrieved.

return: bool Whether $cat2 is child of $cat1.
since: 2.1.0
param: int|object $cat1 ID or object to check if this is the parent category.
param: int|object $cat2 The child category.

sanitize_category( $category, $context = 'display' )   X-Ref
Sanitizes category data based on context.

return: object|array Same type as $category with sanitized data for safe use.
since: 2.3.0
param: object|array $category Category data.
param: string       $context  Optional. Default 'display'.

sanitize_category_field( $field, $value, $cat_id, $context )   X-Ref
Sanitizes data in single category key field.

return: mixed Same type as $value after $value has been sanitized.
since: 2.3.0
param: string $field   Category key to sanitize.
param: mixed  $value   Category value to sanitize.
param: int    $cat_id  Category ID.
param: string $context What filter to use, 'raw', 'display', etc.

get_tags( $args = '' )   X-Ref
Retrieves all post tags.

return: WP_Term[]|int $tags Array of 'post_tag' term objects, or a count thereof.
since: 2.3.0
param: string|array $args Tag arguments to use when retrieving tags.

get_tag( $tag, $output = OBJECT, $filter = 'raw' )   X-Ref
Retrieves a post tag by tag ID or tag object.

If you pass the $tag parameter an object, which is assumed to be the tag row
object retrieved from the database, it will cache the tag data.

If you pass $tag an integer of the tag ID, then that tag will be retrieved
from the database, if it isn't already cached, and passed back.

If you look at get_term(), both types will be passed through several filters
and finally sanitized based on the $filter parameter value.

return: WP_Term|array|WP_Error|null Tag data in type defined by $output parameter.
since: 2.3.0
param: int|WP_Term|object $tag    A tag ID or object.
param: string             $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N,
param: string             $filter Optional. Default is raw or no WordPress defined filter will applied.

clean_category_cache( $id )   X-Ref
Removes the category cache data based on ID.

since: 2.1.0
param: int $id Category ID

_make_cat_compat( &$category )   X-Ref
Updates category structure to old pre-2.3 from new taxonomy structure.

This function was added for the taxonomy support to update the new category
structure with the old category one. This will maintain compatibility with
plugins and themes which depend on the old key or property names.

The parameter should only be passed a variable and not create the array or
object inline to the parameter. The reason for this is that parameter is
passed by reference and PHP will fail unless it has the variable.

There is no return value, because everything is updated on the variable you
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.
param: array|object|WP_Term $category Category Row object or array



Generated: Thu Jun 4 01:00:04 2020 Cross-referenced by PHPXref 0.7.1