Skip to content

Docs: Clarify get_user_meta() return value for a non-existing meta key on a valid user #13494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
haritpanchal wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Docs: Clarify get_user_meta() return value for a non-existing meta key on a valid user #13494

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/wp-includes/user.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1291,8 +1291,10 @@ function delete_user_meta( $user_id, $meta_key, $meta_value = '' ) {
* @return mixed An array of values if `$single` is false.
* The value of meta data field if `$single` is true.
* False for an invalid `$user_id` (non-numeric, zero, or negative value).
* An empty array if a valid but non-existing user ID is passed and `$single` is false.
* An empty string if a valid but non-existing user ID is passed and `$single` is true.
* An empty array if `$single` is false and either the user ID does not exist
* or the meta key does not exist for that user.
* An empty string if `$single` is true and either the user ID does not exist
* or the meta key does not exist for that user.
* Note: Non-serialized values are returned as strings:
* - false values are returned as empty strings ('')
* - true values are returned as '1'
Expand Down
Loading