get_term

函数
get_term ( $term, $taxonomy = '', $output = OBJECT, $filter = 'raw' )
参数
  • (int|WP_Term|object) $term If integer, term data will be fetched from the database, or from the cache if available. If stdClass object (as in the results of a database query), will apply filters and return a `WP_Term` object with the `$term` data. If `WP_Term`, will return `$term`.
    Required:
  • (string) $taxonomy Optional. Taxonomy name that `$term` is part of.
    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|WP_Error|null) WP_Term instance (or array) on success, depending on the `$output` value. WP_Error if `$taxonomy` does not exist. Null for miscellaneous failure.
相关
  • sanitize_term_field()
定义位置
相关方法
get_termsget_term_byget_themeget_themesget_footer
引入
2.3.0
弃用
-

get_term: 这个函数通过ID检索一个特定的术语对象。它需要两个参数:术语ID和该术语所属的分类法名称。它返回术语对象。

按术语ID从数据库中获取所有术语数据。

get_term函数的用途是对术语对象应用过滤器。在应用过滤器之前,可以从数据库中获得一个术语对象。

$term ID必须是$taxonomy的一部分,才能从数据库中获取。失败,可能会被钩子捕获。失败将是与$wpdb在get_row方法中返回的值相同。

有两个钩子,一个是专门针对每个术语的,名为’get_term’,第二个是针对分类学名称的,’term_$taxonomy’。这两个钩子都获得了术语对象和分类法名称作为参数。两个钩子都期望返回一个术语对象。

{@see ‘get_term’}钩子 – 接收两个参数:术语对象和分类法名称。必须返回术语对象。在get_term()中使用,作为每个$term的总过滤器。

{@see ‘get_$taxonomy’} 钩子 – 接收两个参数:术语对象和分类法名称。必须返回术语对象。$taxonomy将是分类名称,因此,例如,如果是’category’,它将是’get_category’作为过滤器的名称。适用于用于自定义分类法或插入到默认分类法中。

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;
	}

	// Ensure for filters that this is not empty.
	$taxonomy = $_term->taxonomy;

	/**
	 * Filters a taxonomy term object.
	 *
	 * The {@see 'get_$taxonomy'} hook is also available for targeting a specific
	 * taxonomy.
	 *
	 * @since 2.3.0
	 * @since 4.4.0 `$_term` is now a `WP_Term` object.
	 *
	 * @param WP_Term $_term    Term object.
	 * @param string  $taxonomy The taxonomy slug.
	 */
	$_term = apply_filters( 'get_term', $_term, $taxonomy );

	/**
	 * Filters a taxonomy term object.
	 *
	 * The dynamic portion of the hook name, `$taxonomy`, refers
	 * to the slug of the term's taxonomy.
	 *
	 * Possible hook names include:
	 *
	 *  - `get_category`
	 *  - `get_post_tag`
	 *
	 * @since 2.3.0
	 * @since 4.4.0 `$_term` is now a `WP_Term` object.
	 *
	 * @param WP_Term $_term    Term object.
	 * @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 ( ARRAY_A === $output ) {
		return $_term->to_array();
	} elseif ( ARRAY_N === $output ) {
		return array_values( $_term->to_array() );
	}

	return $_term;
}

常见问题

FAQs
查看更多 >