[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

Taxonomy API: Core category-specific template tags

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

Defines 30 functions

  get_category_link()
  get_category_parents()
  get_the_category()
  get_the_category_by_ID()
  get_the_category_list()
  in_category()
  the_category()
  category_description()
  wp_dropdown_categories()
  wp_list_categories()
  wp_tag_cloud()
  default_topic_count_scale()
  wp_generate_tag_cloud()
  _wp_object_name_sort_cb()
  _wp_object_count_sort_cb()
  walk_category_tree()
  walk_category_dropdown_tree()
  get_tag_link()
  get_the_tags()
  get_the_tag_list()
  the_tags()
  tag_description()
  term_description()
  get_the_terms()
  get_the_term_list()
  get_term_parents_list()
  the_terms()
  has_category()
  has_tag()
  has_term()

Functions
Functions that are not part of a class:

get_category_link( $category )   X-Ref
Retrieves category link URL.

since: 1.0.0
param: int|object $category Category ID or object.
return: string Link on success, empty string if category does not exist.

get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $deprecated = array()   X-Ref
Retrieves category parents with separator.

since: 1.2.0
since: 4.8.0 The `$visited` parameter was deprecated and renamed to `$deprecated`.
param: int $id Category ID.
param: bool $link Optional, default is false. Whether to format with link.
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 $deprecated Not used.
return: string|WP_Error A list of category parents on success, WP_Error on failure.

get_the_category( $id = false )   X-Ref
Retrieves 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
param: int $id Optional, default to current post ID. The post ID.
return: WP_Term[] Array of WP_Term objects, one for each category assigned to the post.

get_the_category_by_ID( $cat_ID )   X-Ref
Retrieves category name based on category ID.

since: 0.71
param: int $cat_ID Category ID.
return: string|WP_Error Category name on success, WP_Error on failure.

get_the_category_list( $separator = '', $parents = '', $post_id = false )   X-Ref
Retrieves category list for a post in either HTML list or custom format.

since: 1.5.1
param: string $separator Optional. Separator between the categories. By default, the links are placed
param: string $parents Optional. How to display the parents.
param: int $post_id Optional. Post ID to retrieve categories.
return: string

in_category( $category, $post = null )   X-Ref
Checks if the current post is within any of the given categories.

The given categories are checked against the post's categories' term_ids, names and slugs.
Categories given as integers will only be checked against the post's categories' term_ids.

Prior to v2.5 of WordPress, category names were not supported.
Prior to v2.7, category slugs were not supported.
Prior to v2.7, only one category could be compared: in_category( $single_category ).
Prior to v2.7, this function could only be used in the WordPress Loop.
As of 2.7, the function can be used anywhere if it is provided a post ID or post object.

For more information on this and similar theme functions, check out
the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
Conditional Tags} article in the Theme Developer Handbook.

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)
return: bool True if the current post is in any of the given categories.

the_category( $separator = '', $parents = '', $post_id = false )   X-Ref
Displays category list for a post in either HTML list or custom format.

since: 0.71
param: string $separator Optional. Separator between the categories. By default, the links are placed
param: string $parents Optional. How to display the parents.
param: int $post_id Optional. Post ID to retrieve categories.

category_description( $category = 0 )   X-Ref
Retrieves category description.

since: 1.0.0
param: int $category Optional. Category ID. Will use global category ID by default.
return: string Category description, available.

wp_dropdown_categories( $args = '' )   X-Ref
Displays or retrieves the HTML dropdown list of categories.

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
since: 4.2.0 Introduced the `value_field` argument.
since: 4.6.0 Introduced the `required` argument.
param: array|string $args {
return: string HTML dropdown list of categories.

wp_list_categories( $args = '' )   X-Ref
Displays or retrieves the HTML list of categories.

since: 2.1.0
since: 4.4.0 Introduced the `hide_title_if_empty` and `separator` arguments.
since: 4.4.0 The `current_category` argument was modified to optionally accept an array of values.
param: array|string $args {
return: void|string|false Void if 'echo' argument is true, HTML list of categories if 'echo' is false.

wp_tag_cloud( $args = '' )   X-Ref
Displays a tag cloud.

since: 2.3.0
since: 4.8.0 Added the `show_count` argument.
param: array|string $args {
return: void|string|array Void if 'echo' argument is true, or on failure. Otherwise, tag cloud

default_topic_count_scale( $count )   X-Ref
Default topic count scaling for tag links.

since: 2.9.0
param: int $count Number of posts with that tag.
return: int Scaled count.

wp_generate_tag_cloud( $tags, $args = '' )   X-Ref
Generates a tag cloud (heatmap) from provided data.

since: 2.3.0
since: 4.8.0 Added the `show_count` argument.
param: WP_Term[]    $tags Array of WP_Term objects to generate the tag cloud for.
param: string|array $args {
return: string|array Tag cloud as a string or an array, depending on 'format' argument.

_wp_object_name_sort_cb( $a, $b )   X-Ref
Serves as a callback for comparing objects based on name.

Used with `uasort()`.

since: 3.1.0
param: object $a The first object to compare.
param: object $b The second object to compare.
return: int Negative number if `$a->name` is less than `$b->name`, zero if they are equal,

_wp_object_count_sort_cb( $a, $b )   X-Ref
Serves as a callback for comparing objects based on count.

Used with `uasort()`.

since: 3.1.0
param: object $a The first object to compare.
param: object $b The second object to compare.
return: bool Whether the count value for `$a` is greater than the count value for `$b`.

walk_category_tree( ...$args )   X-Ref
Retrieves HTML list content for category list.

since: 2.1.0
since: 5.3.0 Formalized the existing `...$args` parameter by adding it
param: mixed ...$args Elements array, maximum hierarchical depth and optional additional arguments.
return: string

walk_category_dropdown_tree( ...$args )   X-Ref
Retrieves HTML dropdown (select) content for category list.

since: 2.1.0
since: 5.3.0 Formalized the existing `...$args` parameter by adding it
param: mixed ...$args Elements array, maximum hierarchical depth and optional additional arguments.
return: string

get_tag_link( $tag )   X-Ref
Retrieves the link to the tag.

since: 2.3.0
param: int|object $tag Tag ID or object.
return: string Link on success, empty string if tag does not exist.

get_the_tags( $id = 0 )   X-Ref
Retrieves the tags for a post.

since: 2.3.0
param: int $id Post ID.
return: array|false|WP_Error Array of tag objects on success, false on failure.

get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 )   X-Ref
Retrieves the tags for a post formatted as a string.

since: 2.3.0
param: string $before Optional. Before tags.
param: string $sep Optional. Between tags.
param: string $after Optional. After tags.
param: int $id Optional. Post ID. Defaults to the current post.
return: string|false|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.

the_tags( $before = null, $sep = ', ', $after = '' )   X-Ref
Retrieves the tags for a post.

since: 2.3.0
param: string $before Optional. Before list.
param: string $sep Optional. Separate items using this.
param: string $after Optional. After list.

tag_description( $tag = 0 )   X-Ref
Retrieves tag description.

since: 2.8.0
param: int $tag Optional. Tag ID. Will use global tag ID by default.
return: string Tag description, available.

term_description( $term = 0, $deprecated = null )   X-Ref
Retrieves term description.

since: 2.8.0
since: 4.9.2 The `$taxonomy` parameter was deprecated.
param: int  $term       Optional. Term ID. Will use global term ID by default.
param: null $deprecated Deprecated argument.
return: string Term description, available.

get_the_terms( $post, $taxonomy )   X-Ref
Retrieves the terms of the taxonomy that are attached to the post.

since: 2.5.0
param: int|WP_Post $post     Post ID or object.
param: string      $taxonomy Taxonomy name.
return: WP_Term[]|false|WP_Error Array of WP_Term objects on success, false if there are no terms

get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' )   X-Ref
Retrieves a post's terms as a list with specified format.

since: 2.5.0
param: int    $id       Post ID.
param: string $taxonomy Taxonomy name.
param: string $before   Optional. Before list.
param: string $sep      Optional. Separate items using this.
param: string $after    Optional. After list.
return: string|false|WP_Error A list of terms on success, false if there are no terms, WP_Error on failure.

get_term_parents_list( $term_id, $taxonomy, $args = array()   X-Ref
Retrieves term parents with separator.

since: 4.8.0
param: int     $term_id  Term ID.
param: string  $taxonomy Taxonomy name.
param: string|array $args {
return: string|WP_Error A list of term parents on success, WP_Error or empty string on failure.

the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' )   X-Ref
Displays the terms in a list.

since: 2.5.0
param: int    $id       Post ID.
param: string $taxonomy Taxonomy name.
param: string $before   Optional. Before list.
param: string $sep      Optional. Separate items using this.
param: string $after    Optional. After list.
return: void|false Void on success, false on failure.

has_category( $category = '', $post = null )   X-Ref
Checks if the current post has any of given category.

since: 3.1.0
param: string|int|array $category Optional. The category name/term_id/slug or array of them to check for.
param: int|object       $post     Optional. Post to check instead of the current post.
return: bool True if the current post has any of the given categories (or any category, if no category specified).

has_tag( $tag = '', $post = null )   X-Ref
Checks if the current post has any of given tags.

The given tags are checked against the post's tags' term_ids, names and slugs.
Tags given as integers will only be checked against the post's tags' term_ids.
If no tags are given, determines if post has any tags.

Prior to v2.7 of WordPress, tags given as integers would also be checked against the post's tags' names and slugs (in addition to term_ids)
Prior to v2.7, this function could only be used in the WordPress Loop.
As of 2.7, the function can be used anywhere if it is provided a post ID or post object.

For more information on this and similar theme functions, check out
the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
Conditional Tags} article in the Theme Developer Handbook.

since: 2.6.0
param: string|int|array $tag  Optional. The tag name/term_id/slug or array of them to check for.
param: int|object       $post Optional. Post to check instead of the current post. (since 2.7.0)
return: bool True if the current post has any of the given tags (or any tag, if no tag specified).

has_term( $term = '', $taxonomy = '', $post = null )   X-Ref
Checks if the current post has any of given terms.

The given terms are checked against the post's terms' term_ids, names and slugs.
Terms given as integers will only be checked against the post's terms' term_ids.
If no terms are given, determines if post has any terms.

since: 3.1.0
param: string|int|array $term     Optional. The term name/term_id/slug or array of them to check for.
param: string           $taxonomy Taxonomy name.
param: int|WP_Post      $post     Optional. Post to check instead of the current post.
return: bool True if the current post has any of the given tags (or any tag, if no tag specified).



Generated: Tue Jun 2 01:00:03 2020 Cross-referenced by PHPXref 0.7.1