Docs: Remove an unrelated description about post meta from the DocBlock for add_user_meta().

Clean up syntax.

See #41017.


git-svn-id: https://develop.svn.wordpress.org/trunk@41186 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2017-07-30 14:32:00 +00:00
parent 37ce2ffe85
commit b22e409f81
1 changed files with 2 additions and 5 deletions

View File

@ -756,17 +756,14 @@ function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
}
/**
* Add meta data field to a user.
*
* Post meta data is called "Custom Fields" on the Administration Screens.
* Adds meta data to a user.
*
* @since 3.0.0
* @link https://codex.wordpress.org/Function_Reference/add_user_meta
*
* @param int $user_id User ID.
* @param string $meta_key Metadata name.
* @param mixed $meta_value Metadata value.
* @param bool $unique Optional, default is false. Whether the same key should not be added.
* @param bool $unique Optional. Whether the same key should not be added. Default false.
* @return int|false Meta ID on success, false on failure.
*/
function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {