update_post_meta() — описание функции WordPress на русском

Сигнатура

update_post_meta( int $post_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ): int|bool

Описание

Используйте параметр $prev_value, чтобы различать метаполя с одинаковым ключом и ID записи.
Если метаполе для записи не существует, оно будет добавлено, а его ID возвращён.
Может использоваться вместо add_post_meta().
По историческим причинам и ключ метаданных, и значение метаданных на входе ожидаются «со слэшами» (с экранированными слэшами).

Оригинал (английский)

Use the $prev_value parameter to differentiate between meta fields with the same key and post ID.

If the meta field for the post does not exist, it will be added and its ID returned.

Can be used in place of add_post_meta() .

For historical reasons both the meta key and the meta value are expected to be “slashed” (slashes escaped) on input.

Параметры

$post_id int обязательный

Идентификатор записи.

$meta_key string обязательный

Ключ метаданных.

$meta_value mixed обязательный

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

$prev_value mixed необязательный = ''

Предыдущее значение для проверки перед обновлением. Если указано, обновляются только существующие записи метаданных с этим значением. В противном случае обновляются все записи.

Возвращаемое значение

int|bool

Исходный код

wp-includes/post.php:2735

function update_post_meta( $post_id, $meta_key, $meta_value, $prev_value = '' ) {
	// Make sure meta is updated for the post, not for a revision.
	$the_post = wp_is_post_revision( $post_id );
	if ( $the_post ) {
		$post_id = $the_post;
	}

	return update_metadata( 'post', $post_id, $meta_key, $meta_value, $prev_value );
}

История изменений

Версия	Описание
1.5.0	Introduced.