A WordPress-centric search engine for devs and theme authors



delete_user_meta ›

Since3.0.0
Deprecatedn/a
delete_user_meta ( $user_id, $meta_key, $meta_value = '' )
Parameters: (3)
  • (int) $user_id User ID
    Required: Yes
  • (string) $meta_key Metadata name.
    Required: Yes
  • (mixed) $meta_value Optional. Metadata value.
    Required: No
    Default: (empty)
Links:
Returns:
  • (bool) True on success, false on failure.
Defined at:
Codex:

Remove metadata matching criteria from a user.

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.



Source

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