Home

update_metadata

February 12, 2011 by Thorsten 0 Comments

Definition:
function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value = '') {}

Update metadata for the specified object. If no value already exists for the specified object ID and metadata key, the metadata will be added.

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: Metadata value
  • string $prev_value: Optional. If specified, only update existing metadata entries with the specified value. Otherwise, update all entries.

Return values

returns:True on successful update, false on failure.

Defined filters

  • update_{$meta_type}_metadata
    apply_filters( "update_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $prev_value )

Source code

function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value = '') {

	if ( !$meta_type || !$meta_key )

		return false;



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

		return false;



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

		return false;



	global $wpdb;



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

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



	// expected_slashed ($meta_key)

	$meta_key = stripslashes($meta_key);

	$passed_value = $meta_value;

	$meta_value = stripslashes_deep($meta_value);

	$meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );



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

3177

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

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

Leave a comment