get_term_by

函数
get_term_by ( $field, $value, $taxonomy = '', $output = OBJECT, $filter = 'raw' )
参数
  • (string) $field Either 'slug', 'name', 'term_id' (or 'id', 'ID'), or 'term_taxonomy_id'.
    Required:
  • (string|int) $value Search for this term value.
    Required:
  • (string) $taxonomy Taxonomy name. Optional, if `$field` is 'term_taxonomy_id'.
    Required:
    Default: (empty)
  • (string) $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
    Required:
    Default: OBJECT
  • (string) $filter Optional. How to sanitize term fields. Default 'raw'.
    Required:
    Default: 'raw'
返回值
  • (WP_Term|array|false) WP_Term instance (or array) on success, depending on the `$output` value. False if `$taxonomy` does not exist or `$term` was not found.
相关
  • sanitize_term_field()
定义位置
相关方法
get_termget_user_byget_termsget_term_linkget_term_meta
引入
2.3.0
弃用
-

get_term_by: 这个函数通过一个特定的字段值检索一个特定的术语对象。它需要三个参数:要搜索的字段(名称、lug或ID),要搜索的值,以及该术语所属的分类法名称。它返回术语对象。

通过术语字段和数据从数据库中获取所有术语数据。

警告:$value对于’name’$field没有被转义。如果需要,你必须自己做。

默认的$field是’id’,因此也可以使用null作为字段,但不建议你这样做。

如果$value不存在,返回值将是false。如果$taxonomy存在,并且$field和$value的组合存在,将返回术语。

这个函数将总是返回与参数中指定的`$field`-`$value`-`$taxonomy`组合匹配的第一个术语。如果你的查询可能会匹配多个术语(例如,当`$field`是’name’时,可能会出现这种情况),考虑使用get_terms();这样,你会得到所有匹配的术语,并且可以提供你自己的逻辑来
决定哪一个才是目的。

function get_term_by( $field, $value, $taxonomy = '', $output = OBJECT, $filter = 'raw' ) {

	// 'term_taxonomy_id' lookups don't require taxonomy checks.
	if ( 'term_taxonomy_id' !== $field && ! taxonomy_exists( $taxonomy ) ) {
		return false;
	}

	// No need to perform a query for empty 'slug' or 'name'.
	if ( 'slug' === $field || 'name' === $field ) {
		$value = (string) $value;

		if ( 0 === strlen( $value ) ) {
			return false;
		}
	}

	if ( 'id' === $field || 'ID' === $field || 'term_id' === $field ) {
		$term = get_term( (int) $value, $taxonomy, $output, $filter );
		if ( is_wp_error( $term ) || null === $term ) {
			$term = false;
		}
		return $term;
	}

	$args = array(
		'get'                    => 'all',
		'number'                 => 1,
		'taxonomy'               => $taxonomy,
		'update_term_meta_cache' => false,
		'orderby'                => 'none',
		'suppress_filter'        => true,
	);

	switch ( $field ) {
		case 'slug':
			$args['slug'] = $value;
			break;
		case 'name':
			$args['name'] = $value;
			break;
		case 'term_taxonomy_id':
			$args['term_taxonomy_id'] = $value;
			unset( $args['taxonomy'] );
			break;
		default:
			return false;
	}

	$terms = get_terms( $args );
	if ( is_wp_error( $terms ) || empty( $terms ) ) {
		return false;
	}

	$term = array_shift( $terms );

	// In the case of 'term_taxonomy_id', override the provided `$taxonomy` with whatever we find in the DB.
	if ( 'term_taxonomy_id' === $field ) {
		$taxonomy = $term->taxonomy;
	}

	return get_term( $term, $taxonomy, $output, $filter );
}

常见问题

FAQs
查看更多 >