Использование функции SET_POST_FORMAT() в WordPress 3.1.0

## Функция SET_POST_FORMAT() │ WP 3.1.0

Функция SET_POST_FORMAT() позволяет назначить формат поста в WordPress. Это может быть полезно для классификации вашего контента, например, вы можете указать, что пост является "галереей", "видео" или "стандартным".

### Как это работает

Функция использует другую функцию wp_set_post_terms(), для назначения формата. 

### Возврат значений

Функция может вернуть различные значения:
- **Массив** идентификаторов назначенных форматов, если всё прошло успешно.
- **WP_Error**, если произошла ошибка, например, если указан неверный пост.

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

Чтобы назначить формат поста, используйте следующую запись:

```php
set_post_format( $post, $format );

Где:

  • $post (int|WP_Post) — обязательный параметр, который указывает пост, для которого назначается формат.
  • $format (string) — обязательный параметр, который задаёт формат. Если вы хотите убрать все форматы, используйте пустую строку или массив.

Примеры

Пример 1: установка формата "галерея"

Если вы хотите установить формат "галерея" для текущего поста (в цикле WordPress), используйте:

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

Вы можете добавить свои примеры использования функции, если у вас есть дополнительные идеи!

Изменения

Функция была введена в версии WordPress 3.1.0.

Код функции SET_POST_FORMAT

Ниже представлен код функции, который вы можете найти в файле wp-includes/post-formats.php:


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

if ( ! $post ) {
    return new WP_Error( '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' );

}

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

Для работы с форматами постов в WordPress также могут быть полезны следующие функции:

  • get_post_format() — позволяет получить формат поста.
  • has_post_format() — проверяет, имеет ли пост определённый формат.

Leave a Reply

Ваш адрес email не будет опубликован. Обязательные поля помечены *