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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。