delete_usermeta

Action Hook

Description

Remove user meta data.

Hook Information

File Location	`wp-includes/deprecated.php` View on GitHub
Hook Type	Action
Line Number	`2243`

Hook Parameters

Type	Name	Description
`int`	`$user_id`	User ID.
`string`	`$meta_key`	Metadata key.
`mixed`	`$meta_value`	Optional. Metadata value. Default empty.

Usage Examples

Basic Usage

<?php
// Hook into delete_usermeta
add_action('delete_usermeta', 'my_custom_function', 10, 3);

function my_custom_function($user_id, $meta_key, $meta_value) {
    // Your custom code here
}

Source Code Context

wp-includes/deprecated.php:2243 - How this hook is used in WordPress core

<?php
2238  	$meta_value = trim( $meta_value );
2239  
2240  	$cur = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
2241  
2242  	if ( $cur && $cur->umeta_id )
2243  		do_action( 'delete_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );
2244  
2245  	if ( ! empty($meta_value) )
2246  		$wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s AND meta_value = %s", $user_id, $meta_key, $meta_value) );
2247  	else
2248  		$wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );

PHP Documentation

<?php
/**
 * Remove user meta data.
 *
 * @since 2.0.0
 * @deprecated 3.0.0 Use delete_user_meta()
 * @see delete_user_meta()
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 * @param int $user_id User ID.
 * @param string $meta_key Metadata key.
 * @param mixed $meta_value Optional. Metadata value. Default empty.
 * @return bool True deletion completed and false if user_id is not a number.
 */

Quick Info

Hook Type: Action
Parameters: 3
File: wp-includes/deprecated.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.