update_user_meta

Advertisement

Summery Summery

Update user meta field based on user ID.

Syntax Syntax

update_user_meta( int $user_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' )

Description Description

Use the $prev_value parameter to differentiate between meta fields with the same key and user ID.

If the meta field for the user does not exist, it will be added.

Parameters Parameters

$user_id

(Required) User ID.

$meta_key

(Required) Metadata key.

$meta_value

(Required) Metadata value.

$prev_value

(Optional) Previous value to check before removing.

Default value: ''

Return Return

(int|bool) Meta ID if the key didn't exist, true on successful update, false on failure.

Source Source

File: wp-includes/user.php

 * @since 3.0.0
 *
 * @link https://developer.wordpress.org/reference/functions/update_user_meta/

Advertisement

Changelog Changelog

Changelog
Version Description
3.0.0 Introduced.

Advertisement

Leave a Reply