Home

delete_metadata

February 11, 2011 by Thorsten 0 Comments

Definition:
function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false) {}

Delete metadata for the specified object.

Parameters

  • string $meta_type: Type of object metadata is for (e.g., comment, post, or user)
  • int $object_id: ID of the object metadata is for
  • string $meta_key: Metadata key
  • string $meta_value: Optional. Metadata value. If specified, only delete metadata entries with this value. Otherwise, delete all entries with the specified meta_key.
  • bool $delete_all: Optional, default is false. If true, delete matching metadata entries for all objects, ignoring the specified object_id. Otherwise, only delete matching metadata entries for the specified object_id.

Return values

returns:True on successful delete, false on failure.

Defined filters

  • delete_{$meta_type}_metadata
    apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all )

Source code

function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false) {

	if ( !$meta_type || !$meta_key )

		return false;



	if ( (!$object_id = absint($object_id)) && !$delete_all )

		return false;



	if ( ! $table = _get_meta_table($meta_type) )

		return false;



	global $wpdb;



	$type_column = esc_sql($meta_type . '_id');

	$id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';

	// expected_slashed ($meta_key)

	$meta_key = stripslashes($meta_key);

	$meta_value = stripslashes_deep($meta_value);



	$check = apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all );

800

/wp-includes/meta.php, Documentation, Files, Filters, Filters by letter d, Functions, Functions by letter d
, ,

No comments yet... Be the first to leave a reply!

Leave a comment