Функция get_the_post_type_description() возвращает строку с описанием текущего типа записи, установленным в параметре description при регистрации типа записи. Чтобы функция корректно работала, она должна использоваться на страницах архивов типа записи, для чего применяется условный тег is_post_type_archive().
get_the_post_type_description(): stringПример использования
Чтобы вывести описание архива для текущего типа записи, используйте следующую строку кода:
echo get_the_post_type_description();Этот код выведет описание, которое было задано при регистрации типа записи.
Регистрация описания типа записи
При регистрации типа записи, укажите описание в параметре description. Вот пример кода, который демонстрирует, как это сделать:
function my_custom_post_type() {
register_post_type('my_custom_type',
array(
'labels' => array(
'name' => __('Custom Types'),
'singular_name' => __('Custom Type'),
'description' => __('This is a description for the custom post type.')
),
'public' => true,
'has_archive' => true,
// Другие параметры...
)
);
}
add_action('init', 'my_custom_post_type');В этом примере описание 'This is a description for the custom post type.' будет отображаться на архивной странице типа записи 'my_custom_type'.
Пояснения
- Возвращаемое значение: Функция возвращает строку с описанием архивной страницы типа записи. Если описание не задано, возвращается пустая строка.
- Работа на основе:
get_the_post_type_description()работает на основе функцииget_post_type_object(), которая возвращает объект типа записи.
Заключение
Функция get_the_post_type_description() предоставляет удобный способ отображения описания архивной страницы типа записи в WordPress. Убедитесь, что описание задано при регистрации типа записи, чтобы функция корректно отображала информацию.