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

Сигнатура

delete_post_meta( int $post_id, string $meta_key, mixed $meta_value = '' ): bool

Описание

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

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

You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching the key, if needed.

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

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

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

bool

Исходный код

wp-includes/post.php:2675

function delete_post_meta( $post_id, $meta_key, $meta_value = '' ) {
	// Make sure meta is deleted from the post, not from a revision.
	$the_post = wp_is_post_revision( $post_id );
	if ( $the_post ) {
		$post_id = $the_post;
	}

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

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

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