説明
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
関連
お勧め
決まった値を返すだけの関数群（2018年5月27日 更新）
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
the_date関数で投稿日を確実に表示する（2011年12月20日 更新）
投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）
WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。さくらのVPSでKUSANAGI（2018年5月27日 更新）
請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。
絵文字画像がPNGからSVGへ（2018年5月27日 更新）
WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。