delete_user_meta

Advertisement

Summery Summery

Remove metadata matching criteria from a user.

Syntax Syntax

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

Description Description

You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.

Parameters Parameters

$user_id

(int) (Required) User ID

$meta_key

(string) (Required) Metadata name.

$meta_value

(mixed) (Optional) Metadata value.

Default value: ''

Return Return

(bool) True on success, false on failure.

Source Source

File: wp-includes/user.php

 *                           rows will only be removed that match the value.
 *                           Must be serializable if non-scalar. Default empty.
 * @return bool True on success, false on failure.

Advertisement

Changelog Changelog

Changelog
Version Description
3.0.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.