delete_user_setting

Definition:
function delete_user_setting( $names ) {}

Delete user interface settings.
Deleting settings would reset them to the defaults. This function has to be used before any output has started as it calls setcookie().

Parameters

  • mixed $names: The name or array of names of the setting to be deleted.

Return values

returns:true if deleted successfully/false if not.

Source code

function delete_user_setting( $names ) {



	if ( headers_sent() )

		return false;



	$all = get_all_user_settings();

	$names = (array) $names;



	foreach ( $names as $name ) {

		if ( isset($all[$name]) ) {

			unset($all[$name]);

			$deleted = true;

		}

	}



	if ( isset($deleted) )

		return wp_set_all_user_settings($all);



	return false;

}

824

delete_user_option

Definition:
function delete_user_option( $user_id, $option_name, $global = false ) {}

Delete user option with global blog capability.
User options are just like user metadata except that they have support for global blog options. If the ‘global’ parameter is false, which it is by default it will prepend the WordPress table prefix to the option name.

Parameters

  • int $user_id: User ID
  • string $option_name: User option name.
  • bool $global: Optional. Whether option name is global or blog specific. Default false (blog specific).

Source code

function delete_user_option( $user_id, $option_name, $global = false ) {

	global $wpdb;



	if ( !$global )

		$option_name = $wpdb->prefix . $option_name;

	return delete_user_meta( $user_id, $option_name );

}

822

delete_user_meta

Definition:
function delete_user_meta($user_id, $meta_key, $meta_value = '') {}

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.

Parameters

  • int $user_id: user ID
  • string $meta_key: Metadata name.
  • mixed $meta_value: Optional. Metadata value.

Return values

returns:False for failure. True for success.

Source code

function delete_user_meta($user_id, $meta_key, $meta_value = '') {

	return delete_metadata('user', $user_id, $meta_key, $meta_value);

}

820

delete_usermeta

Definition:
function delete_usermeta( $user_id, $meta_key, $meta_value = '' ) {}

Remove user meta data.

Parameters

  • int $user_id: User ID.
  • string $meta_key: Metadata key.
  • mixed $meta_value: Metadata value.

Return values

returns:True deletion completed and false if user_id is not a number.

Defined actions

  • delete_usermeta
    do_action( 'delete_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );
  • deleted_usermeta
    do_action( 'deleted_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );

Source code

function delete_usermeta( $user_id, $meta_key, $meta_value = '' ) {

	_deprecated_function( __FUNCTION__, '3.0', 'delete_user_meta()' );

	global $wpdb;

	if ( !is_numeric( $user_id ) )

		return false;

	$meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);



	if ( is_array($meta_value) || is_object($meta_value) )

		$meta_value = serialize($meta_value);

	$meta_value = trim( $meta_value );



	$cur = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );



	if ( $cur && $cur->umeta_id )

		do_action( 'delete_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );



	if ( ! empty($meta_value) )

		$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) );

	else

		$wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );



	clean_user_cache( $user_id );

	wp_cache_delete( $user_id, 'user_meta' );



	if ( $cur && $cur->umeta_id )

		do_action( 'deleted_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );



	return true;

}

818

delete_transient

Definition:
function delete_transient( $transient ) {}

Delete a transient.

Parameters

  • string $transient: Transient name. Expected to not be SQL-escaped.

Return values

returns:true if successful, false otherwise

Defined actions

  • delete_transient_’.$transient
    do_action( 'delete_transient_' . $transient, $transient );
  • deleted_transient
    do_action( 'deleted_transient', $transient );

Source code

function delete_transient( $transient ) {

	global $_wp_using_ext_object_cache;



	do_action( 'delete_transient_' . $transient, $transient );



	if ( $_wp_using_ext_object_cache ) {

		$result = wp_cache_delete( $transient, 'transient' );

	} else {

		$option_timeout = '_transient_timeout_' . $transient;

		$option = '_transient_' . $transient;

		$result = delete_option( $option );

		if ( $result )

			delete_option( $option_timeout );

	}



	if ( $result )

		do_action( 'deleted_transient', $transient );

	return $result;

}

816