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

Сигнатура

add_post_meta( int $post_id, string $meta_key, mixed $meta_value, bool $unique = false ): int|false

Описание

Метаданные записи называются «Произвольными полями» на экране администрирования.
По историческим причинам и ключ метаданных, и значение метаданных на входе ожидаются «со слэшами» (с экранированными слэшами).

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

Post meta data is called “Custom Fields” on the Administration Screen.

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 обязательный

Значение метаданных. Массивы и объекты сохраняются как сериализованные данные и возвращаются того же типа при получении. Остальные типы данных сохраняются в базе данных как строки: false сохраняется и возвращается как пустая строка ('') true сохраняется и возвращается как '1' числа (как целые, так и с плавающей точкой) сохраняются и возвращаются как строки. Должно быть сериализуемым, если не является скалярным значением.

$unique bool необязательный = false

Следует ли запретить добавление одного и того же ключа.

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

int|false

Исходный код

wp-includes/post.php:2647

function add_post_meta( $post_id, $meta_key, $meta_value, $unique = false ) {
	// Make sure meta is added to the post, not a revision.
	$the_post = wp_is_post_revision( $post_id );
	if ( $the_post ) {
		$post_id = $the_post;
	}

	return add_metadata( 'post', $post_id, $meta_key, $meta_value, $unique );
}

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

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