函数文档

the_author_meta()

💡 云策文档标注

概述

the_author_meta() 是一个 WordPress 模板标签,用于输出用户数据库对象中的指定字段。默认情况下,它显示当前文章作者的信息,但也可通过参数指定其他用户。

关键要点

  • 功能:输出用户元数据字段,如昵称、邮箱等,每次调用仅返回一个字段。
  • 参数:$field(必需)指定要检索的字段,参考 get_the_author_meta() 获取可用字段列表;$user_id(可选)指定用户 ID,默认为 false,表示使用当前文章作者。
  • 使用场景:在 The Loop 内使用时无需指定 $user_id;在 The Loop 外使用时需提供用户 ID。
  • 注意事项:如果字段不存在,则不输出任何内容;若需返回值而非直接显示,应使用 get_the_author_meta()。
  • 钩子:通过 apply_filters("the_author_{$field}", $author_meta, $user_id) 过滤输出值。

代码示例

// 显示用户 ID 25 的邮箱地址
the_author_meta('user_email', 25);

注意事项

  • 此函数直接输出内容,适用于模板显示;若需在代码中处理返回值,请使用 get_the_author_meta()。
  • 字段名需准确,否则可能无输出;可参考相关函数获取支持的字段列表。

📄 原文内容

Outputs the field from the user’s DB object. Defaults to current post’s author.

Description

See also

Parameters

$fieldstringrequired
Selects the field of the users record. See get_the_author_meta() for the list of possible fields.

More Arguments from get_the_author_meta( … $field )

The user field to retrieve. Default empty.

$user_idint|falseoptional
User ID. Defaults to the current post author.

Default:false

More Information

This template tag displays a desired meta data field for a user. Only one field is returned at a time, you need to specify which you want.

If this tag is used within The Loop, the user ID value need not be specified, and the displayed data is that of the current post author. A user ID can be specified if this tag is used outside The Loop.

If the meta field does not exist, nothing is printed.

NOTE: Use get_the_author_meta() if you need to return (and do something with) the field, rather than just display it.

For parameter $userID, if the user ID fields is used, then this function display the specific field for this user ID.

Source

function the_author_meta( $field = '', $user_id = false ) {
	$author_meta = get_the_author_meta( $field, $user_id );

	/**
	 * Filters the value of the requested user metadata.
	 *
	 * The filter name is dynamic and depends on the $field parameter of the function.
	 *
	 * @since 2.8.0
	 *
	 * @param string    $author_meta The value of the metadata.
	 * @param int|false $user_id     The user ID.
	 */
	echo apply_filters( "the_author_{$field}", $author_meta, $user_id );
}

Hooks

apply_filters( “the_author_{$field}”, string $author_meta, int|false $user_id )

Filters the value of the requested user metadata.

Changelog

Version Description
2.8.0 Introduced.

User Contributed Notes

  1. Skip to note 5 content

    Advanced Uses
    A plugin may add an additional field in the registration or manage users, which adds a new value in the wp_usermeta (where wp_ is your data base prefix. For this example we will use a Twitter ID if a plugin set meta_key value to “twitter” and meta_value to “wordpress” then

    <p></p>

    would return:

    This author’s Twitter name is WordPress