set_post_format() WP 3.1

Устанавливает формат записи.

Функция может быть использована везде, где существует объект поста и включена поддержка форматов в теме.

Хуков нет.

Возвращает

Массив|WP_Error|false. Массив ID всех затронутых терминов таксономии post-format. Или объект WP_Error, если был указан неправильный ID поста или несуществующий объект поста.

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

set_post_format( $post, $format );

$post(число/объект) (обязательный)

ID или объект поста, для которого нужно установить формат записи.

$format(строка/массив) (обязательный)

Формат поста, который будет установлен для записи. Чтобы удалить все форматы, укажите пустую строку: ''. По умолчанию могут быть зарегистрированы следующие форматы:

aside
chat
gallery
link
image
quote
status
video
audio

Примеры

#1 Демонстрация

Установим формат 'gallery' текущему посту в цикле ($post->ID):

set_post_format( $post->ID, 'gallery' );

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

Код set_post_format() set post format ^{WP 5.7.2}

<?php
function set_post_format( $post, $format ) {
	$post = get_post( $post );

	if ( ! $post ) {
		return new WP_Error( 'invalid_post', __( 'Invalid post.' ) );
	}

	if ( ! empty( $format ) ) {
		$format = sanitize_key( $format );
		if ( 'standard' === $format || ! in_array( $format, get_post_format_slugs(), true ) ) {
			$format = '';
		} else {
			$format = 'post-format-' . $format;
		}
	}

	return wp_set_post_terms( $post->ID, $format, 'post_format' );
}

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

Из метки: post format (форматы записей)