Получение описания архива типа записи в WordPress

# Функция GET_THE_POST_TYPE_DESCRIPTION() │ WP 4.9.0

Функция get_the_post_type_description() позволяет получить описание архива типа записи в WordPress.

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

Эта функция запрашивает объект типа записи и возвращает его описание.

```php
get_the_post_type_description();

Например

Вывод описания для архива типа записи

Чтобы вывести описание архива типа записи, можно использовать следующий код:

echo get_the_post_type_description();

Результат

Функция возвращает строку с описанием типа записи.

Краткое описание функции

Внутри функции происходит следующее:

1. Сначала функция получает переменную запроса post_type.
2. Если post_type является массивом, используется только первый элемент.
3. Затем функция получает объект типа записи с помощью get_post_type_object().
4. Проверяется, задано ли описание для данного типа записи. Если да, то оно сохраняется в переменной $description, иначе будет установлено значение пустой строки.
5. Наконец, описание передается в фильтр get_the_post_type_description, что позволяет другим функциям модифицировать это значение.

function get_the_post_type_description() {
    $post_type = get_query_var( 'post_type' );

    if ( is_array( $post_type ) ) {
        $post_type = reset( $post_type );
    }

    $post_type_obj = get_post_type_object( $post_type );

    // Проверяем, задано ли описание.
    if ( isset( $post_type_obj->description ) ) {
        $description = $post_type_obj->description;
    } else {
        $description = '';
    }

    /**
     * Фильтрует описание архива типа записи.
     *
     * @since 4.9.0
     *
     * @param string       $description   Описание типа записи.
     * @param WP_Post_Type $post_type_obj Объект типа записи.
     */
    return apply_filters( 'get_the_post_type_description', $description, $post_type_obj );
}

Изменения

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