Question

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

Remove metadata matching criteria from a user.

---

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.

---

参数

$user_id

(int) (Required) User ID

$meta_key

(string) (Required) Metadata name.

$meta_value

(mixed) (Optional) Metadata value.

Default value: ''

---

返回值

(bool) True on success, false on failure.

---

源代码

File: wp-includes/user.php

function delete_user_meta($user_id, $meta_key, $meta_value = '') {
	return delete_metadata('user', $user_id, $meta_key, $meta_value);
}

---

更新日志

Version	description
3.0.0	Introduced.

---

相关函数

Uses

• wp-includes/meta.php: delete_metadata()

---

Used By

• wp-includes/class-wp-user-meta-session-tokens.php: WP_User_Meta_Session_Tokens::update_sessions()
• wp-admin/includes/ms.php: send_confirmation_on_profile_email()
• wp-includes/class-wp-user.php: WP_User::remove_all_caps()
• wp-includes/user.php: delete_user_option()

---

User Contributed Notes

1. Skip to note content You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note Contributed by Codex

   Basic Example

   
   <?php
   if ( ! delete_user_meta($user_id, '_province') ) {
     echo "Ooops! Error while deleting this information!";
   }
   ?>