get_term

Получает данные об элементе таксономии (термине) по переданному ID.

Функция имеет два хука:

  1. get_term – срабатывает всегда;
  2. get_$taxonomy – срабатывает для определенного элемента таксономии.

Оба хука в качестве параметров получают объект (массив) элемента и название таксономии. Оба хука должны вернуть объект (массив) элемента.

Второй хук term_$taxonomy динамический, т.е. в нем $taxonomy должно быть заменено на название таксономии. Например для категорий, название таксономии у которых “category”, название фильтра будет таким: “get_category”. Может пригодится для произвольных таксономий.

Чтобы получить термин по полю: name или slug, используйте get_term_by().

get_term() кэширует результат и при повторном получении того же термина, запроса к БД уже не происходить – результат просто возвращается из кэша.

get_term() идентична get_category(), только в этой функции можно указать название таксономии с которой работать.
✈ 1 раз = 0.00011с = быстро | 50000 раз = 2.15с = быстро
Хуки из функции:
get_(taxonomy)
get_term
Возвращает

Объект/массив/null/WP_Error.

  • WP_Term (объект термина) или данные из БД.
  • null, если термина нет.
  • WP_Error (объект), если таксономии не существует.

Использование

$term = get_term( $term, $taxonomy, $output, $filter );
$term(число/объект) (обязательный)
Если передан ID, то данные будут получены из БД, если передан объект, то будут применены фильтры и возвращен переданный объект.
По умолчанию: нет
$taxonomy(строка)
Название таксономии, к которой принадлежит элемент $term.
С версии 4.4. параметр стал необязательным.
По умолчанию: ”
$output(строка)

Каким видом массива возвращать данные:

  • OBJECT – объект;
  • ARRAY_A – ассоциативный массив;
  • ARRAY_N – индексированный массив.

По умолчанию: OBJECT

$filter(строка)
Как очищать поля массива перед возвращением.
По умолчанию: ‘raw’

Примеры

#1. Получим данные об элементе таксономии из БД:

$term_id = 65;
$taxonomy = 'my_taxonomy'; // С версии 4.4. параметр стал не обязательным.
$term = get_term( $term_id, $taxonomy );
// Теперь, переменная содержит данные о элементе таксономии.

// Альтернативное название элемента находится здесь
$slug = $term->slug;

// Название элемента
$name = $term->name;

// А так мы получим описание элемента таксономии
$desc = $term->description;

#2 Получение элемента таксономии без указания таксономии

С версии 4.4. стало возможными не указывать параметр $taxonomy:

print_r( get_term(562) );

/* Выведет:
WP_Term Object
(
	[term_id] => 562
	[name] => Записи
	[slug] => zapisi
	[term_group] => 0
	[term_taxonomy_id] => 582
	[taxonomy] => my_taxonomy_name
	[description] => 
	[parent] => 0
	[count] => 1
	[filter] => raw
)
*/

#3 С версии 4.4. параметр $taxonomy можно не указывать.

Т.е. если нужно получить данные элемента 55, можно использовать такой простой код:

$term = get_term( 55 );

Заметки

sanitize_term

Использует: sanitize_term(). Чистит элемент на основе правил фильтра указанного в параметре $filter

Код из


wp-includes/taxonomy.php

WP 4.7.2

<?php
function get_term( $term, $taxonomy = '', $output = OBJECT, $filter = 'raw' ) {
	if ( empty( $term ) ) {
		return new WP_Error( 'invalid_term', __( 'Empty Term' ) );
	}

	if ( $taxonomy && ! taxonomy_exists( $taxonomy ) ) {
		return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
	}

	if ( $term instanceof WP_Term ) {
		$_term = $term;
	} elseif ( is_object( $term ) ) {
		if ( empty( $term->filter ) || 'raw' === $term->filter ) {
			$_term = sanitize_term( $term, $taxonomy, 'raw' );
			$_term = new WP_Term( $_term );
		} else {
			$_term = WP_Term::get_instance( $term->term_id );
		}
	} else {
		$_term = WP_Term::get_instance( $term, $taxonomy );
	}

	if ( is_wp_error( $_term ) ) {
		return $_term;
	} elseif ( ! $_term ) {
		return null;
	}

	/**
	 * Filters a term.
	 *
	 * @since 2.3.0
	 * @since 4.4.0 `$_term` can now also be a WP_Term object.
	 *
	 * @param int|WP_Term $_term    Term object or ID.
	 * @param string      $taxonomy The taxonomy slug.
	 */
	$_term = apply_filters( 'get_term', $_term, $taxonomy );

	/**
	 * Filters a taxonomy.
	 *
	 * The dynamic portion of the filter name, `$taxonomy`, refers
	 * to the taxonomy slug.
	 *
	 * @since 2.3.0
	 * @since 4.4.0 `$_term` can now also be a WP_Term object.
	 *
	 * @param int|WP_Term $_term    Term object or ID.
	 * @param string      $taxonomy The taxonomy slug.
	 */
	$_term = apply_filters( "get_{$taxonomy}", $_term, $taxonomy );

	// Bail if a filter callback has changed the type of the `$_term` object.
	if ( ! ( $_term instanceof WP_Term ) ) {
		return $_term;
	}

	// Sanitize term, according to the specified filter.
	$_term->filter( $filter );

	if ( $output == ARRAY_A ) {
		return $_term->to_array();
	} elseif ( $output == ARRAY_N ) {
		return array_values( $_term->to_array() );
	}

	return $_term;
}

Комментарии:


Оставить комментарий

Your email address will not be published. Required fields are marked *