Функция get_the_post_type_description() в WordPress

Доступна с версии: 4.9

Функция 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. Убедитесь, что описание задано при регистрации типа записи, чтобы функция корректно отображала информацию.

Функция get_the_post_type_description() в WordPress с примером.

Пример использования

Регистрация описания типа записи

Заключение

Стартовая премиум тема для WordPress

Дополнительно по: Записи и страницы

rel_canonical()

wp_write_post()

wp_oembed_get()

wp_star_rating()

wp_transition_post_status()

wp_oembed_add_provider()

wp_get_shortlink()

wp_get_canonical_url()

wp_embed_register_handler()

url_to_postid()

sanitize_post()

the_shortlink()

post_exists()

get_post_timestamp()

get_post_embed_url()

get_post_embed_html()

unregister_post_type()

set_post_type()

remove_post_type_support()

set_post_format()

get_post_format()

get_default_post_to_edit()

wp_delete_post()

wp_insert_post()

wp_publish_post()

wp_trash_post()

wp_update_post()

wp_text_diff()

wp_save_post_revision()

wp_revisions_to_keep()

wp_revisions_enabled()

wp_is_post_revision()

wp_is_post_autosave()

wp_get_post_revisions()

wp_get_post_revision()

wp_delete_post_revision()

wp_delete_auto_drafts()

the_post_navigation()

previous_post_link()

next_post_link()

get_the_post_navigation()

get_previous_post_link()

get_previous_post()

get_next_post_link

get_next_post()

get_boundary_post()

get_adjacent_post_link()

get_adjacent_post()

register_post_type()

post_type_supports()

post_type_exists()

post_type_archive_title()

is_post_type_viewable()

get_the_post_type_description()

get_post_types()

get_post_type_object()

get_post_type_archive_link()

get_post_permalink()

add_post_type_support()

get_all_page_ids()

get_page_by_path()

get_page_children()

get_page_uri()

get_page_template_slug()

get_page_link()

wp_dropdown_pages()

page_template_dropdown()

parent_dropdown()

get_post_ancestors()

get_pages()

wp_link_pages()

wp_list_pages()

wp_page_menu()

get_post_field()