使用WordPress函数update_metadata()更新指定对象的元数据

使用WordPress函数update_metadata()更新指定对象的元数据

　　update_metadata()更新指定对象的元数据。如果指定的对象 ID 和元数据键尚不存在值，则将添加元数据。

　　WordPress 中的该update_metadata函数用于更新指定对象的元数据。这对于修改与帖子、用户或任何其他支持元数据的对象类型相关的元数据非常有用。通过使用该update_metadata功能，开发人员可以轻松更新和修改与对象相关的元数据，而无需手动操作数据库。这有助于简化更新元数据的过程，并确保以一致、可靠的方式完成更新。该update_metadata功能是管理和更新 WordPress 网站内元数据的有用工具，提供了一种无需直接与数据库交互即可修改元数据的便捷方法。

　　推荐：[最新版]WordPress SEO插件Rank Math Pro

update_metadata()基本语法

描述

　　更新指定对象的元数据。如果指定的对象 ID 和元数据键尚不存在值，则将添加元数据

用法

update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_value );

• $meta_type (string)– 必填。对象元数据的类型。接受“帖子”、“评论”、“术语”、“用户”或任何其他具有关联元表的对象类型。
• $object_id (int)– 必填。对象元数据的 ID。
• $meta_key（字符串），必需。元数据键。
• $meta_value  (string)– 必填。元数据值。如果是非标量，则必须是可序列化的。默认值：”。
• $prev_value(mixed)– 可选。更新前要检查的先前值。如果指定，则仅使用此值更新现有元数据条目。否则，更新所有条目

　　推荐：[最新版]YITH WooCommerce Tab Manager Premium插件WordPress WooCommerce选项卡插件

update_metadata()函数

　　更新指定对象的元数据。如果指定的对象 ID 和元数据键尚不存在值，则将添加元数据，该函数返回一个整数或布尔值。如果具有给定键的字段不存在并因此添加，则返回新的元字段 ID。如果更新成功，则返回 true；如果更新失败，或者传递给函数的值与数据库中已有的值相同，则返回 false（源文件可参考这里）

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

	if ( ! $meta_type || ! $meta_key || ! is_numeric( $object_id ) ) {
		return false;
	}

	$object_id = absint( $object_id );
	if ( ! $object_id ) {
		return false;
	}

	$table = _get_meta_table( $meta_type );
	if ( ! $table ) {
		return false;
	}

	$meta_subtype = get_object_subtype( $meta_type, $object_id );

	$column    = sanitize_key( $meta_type . '_id' );
	$id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id';

	// expected_slashed ($meta_key)
	$raw_meta_key = $meta_key;
	$meta_key     = wp_unslash( $meta_key );
	$passed_value = $meta_value;
	$meta_value   = wp_unslash( $meta_value );
	$meta_value   = sanitize_meta( $meta_key, $meta_value, $meta_type, $meta_subtype );

	/**
	 * Short-circuits updating metadata of a specific type.
	 *
	 * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
	 * (post, comment, term, user, or any other type with an associated meta table).
	 * Returning a non-null value will effectively short-circuit the function.
	 *
	 * Possible hook names include:
	 *
	 *  - `update_post_metadata`
	 *  - `update_comment_metadata`
	 *  - `update_term_metadata`
	 *  - `update_user_metadata`
	 *
	 * @since 3.1.0
	 *
	 * @param null|bool $check      Whether to allow updating metadata for the given type.
	 * @param int       $object_id  ID of the object metadata is for.
	 * @param string    $meta_key   Metadata key.
	 * @param mixed     $meta_value Metadata value. Must be serializable if non-scalar.
	 * @param mixed     $prev_value Optional. Previous value to check before updating.
	 *                              If specified, only update existing metadata entries with
	 *                              this value. Otherwise, update all entries.
	 */
	$check = apply_filters( "update_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $prev_value );
	if ( null !== $check ) {
		return (bool) $check;
	}

	// Compare existing value to new value if no prev value given and the key exists only once.
	if ( empty( $prev_value ) ) {
		$old_value = get_metadata_raw( $meta_type, $object_id, $meta_key );
		if ( is_countable( $old_value ) && count( $old_value ) === 1 ) {
			if ( $old_value[0] === $meta_value ) {
				return false;
			}
		}
	}

	$meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s AND $column = %d", $meta_key, $object_id ) );
	if ( empty( $meta_ids ) ) {
		return add_metadata( $meta_type, $object_id, $raw_meta_key, $passed_value );
	}

	$_meta_value = $meta_value;
	$meta_value  = maybe_serialize( $meta_value );

	$data  = compact( 'meta_value' );
	$where = array(
		$column    => $object_id,
		'meta_key' => $meta_key,
	);

	if ( ! empty( $prev_value ) ) {
		$prev_value          = maybe_serialize( $prev_value );
		$where['meta_value'] = $prev_value;
	}

	foreach ( $meta_ids as $meta_id ) {
		/**
		 * Fires immediately before updating metadata of a specific type.
		 *
		 * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
		 * (post, comment, term, user, or any other type with an associated meta table).
		 *
		 * Possible hook names include:
		 *
		 *  - `update_post_meta`
		 *  - `update_comment_meta`
		 *  - `update_term_meta`
		 *  - `update_user_meta`
		 *
		 * @since 2.9.0
		 *
		 * @param int    $meta_id     ID of the metadata entry to update.
		 * @param int    $object_id   ID of the object metadata is for.
		 * @param string $meta_key    Metadata key.
		 * @param mixed  $_meta_value Metadata value.
		 */
		do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );

		if ( 'post' === $meta_type ) {
			/**
			 * Fires immediately before updating a post's metadata.
			 *
			 * @since 2.9.0
			 *
			 * @param int    $meta_id    ID of metadata entry to update.
			 * @param int    $object_id  Post ID.
			 * @param string $meta_key   Metadata key.
			 * @param mixed  $meta_value Metadata value. This will be a PHP-serialized string representation of the value
			 *                           if the value is an array, an object, or itself a PHP-serialized string.
			 */
			do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
		}
	}

	$result = $wpdb->update( $table, $data, $where );
	if ( ! $result ) {
		return false;
	}

	wp_cache_delete( $object_id, $meta_type . '_meta' );

	foreach ( $meta_ids as $meta_id ) {
		/**
		 * Fires immediately after updating metadata of a specific type.
		 *
		 * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
		 * (post, comment, term, user, or any other type with an associated meta table).
		 *
		 * Possible hook names include:
		 *
		 *  - `updated_post_meta`
		 *  - `updated_comment_meta`
		 *  - `updated_term_meta`
		 *  - `updated_user_meta`
		 *
		 * @since 2.9.0
		 *
		 * @param int    $meta_id     ID of updated metadata entry.
		 * @param int    $object_id   ID of the object metadata is for.
		 * @param string $meta_key    Metadata key.
		 * @param mixed  $_meta_value Metadata value.
		 */
		do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );

		if ( 'post' === $meta_type ) {
			/**
			 * Fires immediately after updating a post's metadata.
			 *
			 * @since 2.9.0
			 *
			 * @param int    $meta_id    ID of updated metadata entry.
			 * @param int    $object_id  Post ID.
			 * @param string $meta_key   Metadata key.
			 * @param mixed  $meta_value Metadata value. This will be a PHP-serialized string representation of the value
			 *                           if the value is an array, an object, or itself a PHP-serialized string.
			 */
			do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
		}
	}

	return true;
}

　　推荐：Max Mega Menu插件教程WordPress添加超级菜单

如何使用update_metadata()

　　如何更新帖子元数据的基本示例

update_metadata ( 'post' , 76 , 'key_1' , 'cheerful' , 'sad' ) ;

　　使用 update_metadata 函数更新用户的元数据，此代码片段使用函数以键“user_meta_key”更新用户元数据，使用update_metadata其中 ID 为 456 的用户的元数据值为“new_user_meta_value” 

$user_id = 456;
$meta_key = 'user_meta_key';
$meta_value = 'new_user_meta_value';

update_metadata('user', $user_id, $meta_key, $meta_value);

　　如何使用 update_metadata 函数更新帖子的自定义字段，此代码片段使用函数更新 ID 为 123 的帖子的键为“custom_field_key”的自定义字段，使用update_metadata使其值为“new_custom_field_value” 

$post_id = 123;
$meta_key = 'custom_field_key';
$meta_value = 'new_custom_field_value';

update_metadata('post', $post_id, $meta_key, $meta_value);

　　使用 update_metadata 函数更新术语的元数据，此代码片段使用函数将 ID 为 789 的术语的元数据更新为键“term_meta_key”，使用update_metadata使其值为“new_term_meta_value” 

$term_id = 789;
$meta_key = 'term_meta_key';
$meta_value = 'new_term_meta_value';

update_metadata('term', $term_id, $meta_key, $meta_value);

　　推荐：[最新版]WP Speed of Light Pro插件WordPress速度优化插件

　　推荐：WordPress函数使用手册