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

お勧め

Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

query_posts（WP_Queryクラス）で投稿タグを絞り込む（2011年9月14日 更新）

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts（WP_Queryクラス）でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

classic editorプラグインを試してみた（2018年12月10日 更新）

WordPress 5.0 beta1のリリースにあわせて旧エディター環境を実現できる「classic editor」（バージョン0.5.0）が公開された。自分が公開しているプラグインの一部が旧エディター環境に依存していることもあり、さっそく試してみた。WordPress 5.0正式リリースに合わせてclassic editorも1.0がリリースされたので、それについて追記しました。

コメントの「ウェブサイト」止めました（2014年4月15日 更新）

とあるサイトのスパムコメントが多く、その都度のスパム指定するのが面倒である。これまでいくつか対策を行ってきたが、そういった対応にもいい加減うんざりしてきたので、試験的に「ウェブサイト」を無効化しようと思った。

プラグインの設定ページもレスポンシブ対応（2014年6月3日 更新）

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。