WordPress как на ладони
Недорогой хостинг для сайтов на WordPress: wordpress.jino.ru

update_metadata() WP 2.9

Обновляет метаданные для указанного объекта (пост, юзер, коммент). Если указанных данных не найдено, то они будут добавлены, как новые.

ВАЖНО! Функция ожидает экранированную строку в параметрах $meta_key и $meta_value. Т.е. перед записью в базу данных значение произвольных полей обрабатываются функцией wp_unslash(). Подробнее см.ниже: «Экранирование в значениях произвольных полей».

Экранирование в значениях произвольных полей

Перед записью в базу данных значение произвольных полей обрабатываются функцией wp_unslash(), поэтому нужно быть аккуратным, когда в значениях передаются данные с обратным слэш (\), например JSON строка.

Не размещайте экранированные значения!

Неправильный пример:

Предположим нам нужно разместить в значении произвольного поля такую JSON строку: {"key":"value with \"escaped quotes\""}:

$escaped_json = '{"key":"value with \\"escaped quotes\\""}';
update_post_meta( $id, 'escaped_json', $escaped_json );
$broken = get_post_meta( $id, 'escaped_json', true );

/*
Параметр $broken после обработки stripslashes(), превратиться в нерабочую строку:
{"key":"value with "escaped quotes""}
*/

Правильный пример:

Добавив еще один уровень экранирования (\), с помощью функции wp_slash() (с версии 3.6), можно компенсировать обработку wp_unslash():

$escaped_json = '{"key":"value with \\"escaped quotes\\""}';
update_post_meta( $id, 'double_escaped_json', wp_slash($escaped_json) );
$fixed = get_post_meta( $id, 'double_escaped_json', true );
/*
Параметр $fixed после обработки stripslashes(), останется правильным:
{"key":"value with \"escaped quotes\""}
*/
Возвращает

Число/true/false.

  • true - при успешном обновлении.
  • false - при неудаче или когда для обновления было передано значение которое уже есть в бд.
  • ID первичного поля таблицы метаполей (umeta_id), когда было создано новое поле.

Использование

update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_value );
$meta_type(строка) (обязательный)
Тип объекта метаданных которого обновляем. Например: comment, post, or user
По умолчанию: нет
$object_id(число) (обязательный)
ID объекта метаданные которого обновляем. Например, для поста, это будет ID поста.
По умолчанию: нет
$meta_key(строка) (обязательный)
Ключ (название) метаданных.
По умолчанию: нет
$meta_value(строка/число/массив/объект) (обязательный)

Новое значение которое нужно изменить/добавить.

Если указать значение, которое уже записано в метаполе (такое же), то функция не будет делать лишних запросов по обновлению старого значения, а просто прервет работу.

В значении можно хранить массивы и объекты, они будут храниться с виде сериализованной строки.

По умолчанию: нет

$prev_value(строка/число/массив/объект)
Предыдущее значение. Если указать, обновит только данные совпадающие в этим значением, а не все метаданных с указанным в $meta_key ключом.
По умолчанию: ''

Примеры

#1. Базовый пример, показывающий как обновить метаданные у поста.

Точный аналог работы функции update_post_meta(). Обновим метаданные с ключом key_1, у поста 76 - изменим значения "грустный" на "веселый":

update_metadata('post', 76, 'key_1', 'веселый', 'грустный');

#2 Еще примеры

Смотрите в функциях-обертках:

Заметки

  • Global. wpdb. $wpdb WordPress database abstraction object.

Список изменений

С версии 2.9.0 Введена.

Код update_metadata() WP 5.5.1

wp-includes/meta.php
<?php
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, `$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.
	 *
	 * @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, `$meta_type`, refers to the meta object type
		 * (post, comment, term, user, or any other type with an associated meta table).
		 *
		 * @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. Serialized if non-scalar.
		 */
		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, `$meta_type`, refers to the meta object type
		 * (post, comment, term, user, or any other type with an associated meta table).
		 *
		 * @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. Serialized if non-scalar.
		 */
		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;
}

Cвязанные функции

Из метки: metadata (метаданные)

Еще из раздела: Метаданные

7 комментов