WordPress.org

Function Reference/get term

Description

Get all Term data from database by Term ID.

The usage of the get_term function is to apply filters to a term object. It is possible to get a term object from the database before applying the filters.

$term ID must be part of $taxonomy, to get from the database. Failure, might be able to be captured by the hooks. Failure would be the same value as $wpdb returns for the get_row method.

There are two hooks, one is specifically for each term, named 'get_term', and the second is for the taxonomy name, 'term_$taxonomy'. Both hooks gets the term object, and the taxonomy name as parameters. Both hooks are expected to return a Term object.

'get_term' hook - Takes two parameters the term Object and the taxonomy name. Must return term object. Used in get_term() as a catch-all filter for every $term.

'get_$taxonomy' hook - Takes two parameters the term Object and the taxonomy name. Must return term object. $taxonomy will be the taxonomy name, so for example, if 'category', it would be 'get_category' as the filter name. Useful for custom taxonomies or plugging into default taxonomies.

Usage

<?php &get_term( $term, $taxonomy, $output, $filter ) ?>

Parameters

$term

(integer|object) (required) If integer, will get from database. If object will apply filters and return $term.

Default: None

$taxonomy

(string) (required) Taxonomy name that $term is part of.

Default: None

$output

(string) (optional) Constant OBJECT, ARRAY_A, or ARRAY_N

Default: OBJECT

$filter

(string) (optional) default is raw or no WordPress defined filter will applied.

Default: 'raw'

Return Values

(mixed|null|WP_Error): Term Row from database. Will return null if $term is empty. If taxonomy does not exist then WP_Error will be returned.

Examples

Notes

See sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
Uses: sanitize_term() Cleanses the term based on $filter context before returning.
Uses global: (object) $wpdb

Change Log

Since: 2.3.0

Source File

&get_term() is located in wp-includes/taxonomy.php.

WordPress.org

Codex

Function Reference/get term

Contents