Docs: List out accepted values for the `$field` parameter in `get_the_author_meta()`.

Props choongsavvii.
Fixes #38258.

Built from https://develop.svn.wordpress.org/trunk@40952


git-svn-id: http://core.svn.wordpress.org/trunk@40802 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2017-06-26 18:24:40 +00:00
parent faab7f4533
commit 78dba2fefd
2 changed files with 39 additions and 9 deletions

View File

@ -111,14 +111,43 @@ function the_modified_author() {
} }
/** /**
* Retrieve the requested data of the author of the current post. * Retrieves the requested data of the author of the current post.
* @link https://codex.wordpress.org/Template_Tags/the_author_meta *
* Valid values for the `$field` parameter include:
*
* - admin_color
* - aim
* - comment_shortcuts
* - description
* - display_name
* - first_name
* - ID
* - jabber
* - last_name
* - nickname
* - plugins_last_view
* - plugins_per_page
* - rich_editing
* - user_activation_key
* - user_description
* - user_email
* - user_firstname
* - user_lastname
* - user_level
* - user_login
* - user_nicename
* - user_pass
* - user_registered
* - user_status
* - user_url
* - yim
*
* @since 2.8.0 * @since 2.8.0
* *
* @global object $authordata The current author's DB object. * @global object $authordata The current author's DB object.
* *
* @param string $field selects the field of the users record. * @param string $field Optional. The user field to retrieve. Default empty.
* @param int $user_id Optional. User ID. * @param int $user_id Optional. User ID.
* @return string The author's field from the current author's DB object, otherwise an empty string. * @return string The author's field from the current author's DB object, otherwise an empty string.
*/ */
function get_the_author_meta( $field = '', $user_id = false ) { function get_the_author_meta( $field = '', $user_id = false ) {
@ -154,12 +183,13 @@ function get_the_author_meta( $field = '', $user_id = false ) {
/** /**
* Outputs the field from the user's DB object. Defaults to current post's author. * Outputs the field from the user's DB object. Defaults to current post's author.
* *
* @link https://codex.wordpress.org/Template_Tags/the_author_meta
*
* @since 2.8.0 * @since 2.8.0
* *
* @param string $field selects the field of the users record. * @param string $field Selects the field of the users record. See get_the_author_meta()
* @param int $user_id Optional. User ID. * for the list of possible fields.
* @param int $user_id Optional. User ID.
*
* @see get_the_author_meta()
*/ */
function the_author_meta( $field = '', $user_id = false ) { function the_author_meta( $field = '', $user_id = false ) {
$author_meta = get_the_author_meta( $field, $user_id ); $author_meta = get_the_author_meta( $field, $user_id );

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.9-alpha-40951'; $wp_version = '4.9-alpha-40952';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.