get_the_post_type_description

（4.9.0以降）
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

関連

参考

Code Reference: get_the_post_type_description

お勧め

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた（2019年11月5日 更新）

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

headタグのmeta（generator）タグを取り除く（2018年5月27日 更新）

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。 
<meta name="generator" content="WordPress 3.0.5" />

Blacklist keys manager：プラグイン作ってみました（2015年5月22日 更新）

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

5.5の機能強化：テーマ変更時に要求バージョンを確認（2020年8月12日 更新）

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2（以降RC 2）」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

投稿内容に応じてwpautopを制御する（2013年8月13日 更新）

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。