1. 首页
  2. WordPress 函数手册

get_tag()

get_tag( int|WP_Term|object $tag, string $output = OBJECT, string $filter = ‘raw’ )

通过标记ID或标记对象检索post标记。
Retrieve post tag by tag ID or tag object.

目录锚点:#说明#参数#返回#源码


说明(Description)

如果向$tag参数传递一个对象,则假定该对象是检索数据库的标记行对象。它将缓存标记数据。

如果将标记ID的整数传递给$tag,则将从数据库中检索该标记(如果尚未缓存),并将其传回。

如果查看get_term(),那么这两种类型都将通过几个过滤器,最后根据$filter参数值进行清理。


参数(Parameters)

参数 类型 必填 说明
$tag (int | WP_Term | object) 必需 标记ID或对象。
$output (string) 可选 所需的返回类型。数组或数组中的一个,分别对应于WP术语对象、关联数组或数值数组。
$filter (string) 可选 默认为raw或不应用WordPress定义的过滤器。

返回(Return)

(WP|Term|array|WP_Error|null)由$output参数定义的类型中的标记数据。WP_Error如果$tag为空,如果不存在则为空。


源码(Source)

/**
 * Retrieve post tag by tag ID or tag object.
 *
 * If you pass the $tag parameter an object, which is assumed to be the tag row
 * object retrieved the database. It will cache the tag data.
 *
 * If you pass $tag an integer of the tag ID, then that tag will
 * be retrieved from the database, if it isn't already cached, and pass it back.
 *
 * If you look at get_term(), then both types will be passed through several
 * filters and finally sanitized based on the $filter parameter value.
 *
 * @since 2.3.0
 *
 * @param int|object $tag
 * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
 * @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
 * @return object|array|WP_Error|null Tag data in type defined by $output parameter. WP_Error if $tag is empty, null if it does not exist.
 */
function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
	return get_term( $tag, 'post_tag', $output, $filter );
}

/* Cache */
更新版本 源码位置 使用 被使用
2.3.0 wp-includes/category.php:318 0 1 function

get_tag() 为WP2原创文章,链接:https://www.wp2.cn/functions/get_tag/

发表评论

您的电子邮箱地址不会被公开。