get_the_post_type_description

説明

string get_the_post_type_description()
投稿タイプアーカイブページ向けの説明を取得する。

パラメータ

パラメータはありません。

返り値

投稿タイプの説明を返す。投稿タイプが無効な場合は''を返す。

注意

本関数にパラメータはなく、リクエストクエリーの投稿タイプの説明を取得する。なお投稿タイプが複数存在した場合は先頭の投稿タイプが対象となる。

テーマの汎用アーカイブページテンプレートで説明が必要な場合は、本関数ではなく get_the_archive_description the_archive_description関数が使用できる。


使用例

  • 投稿タイプアーカイブページ向けの説明を取得する。
    <?php $description = get_the_post_type_description(); ?>

フィルター

[4.9.0]投稿タイプの説明を返す前に'get_the_post_type_description'を呼び出す。パラメータ$descriptionにはリクエストされた投稿タイプの説明が、$post_type_objにはリクエストされた投稿タイプ情報が格納されている。
return apply_filters( 'get_the_post_type_description', $description, $post_type_obj );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/general-template.php

最終更新 : 2018年05月27日 10:43



お勧め

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

Widgets on dashboard:プラグイン作ってみました(2014年5月7日 更新)

サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。