get_the_archive_description

(4.1.0以降)
get_the_archive_description - アーカイブページの説明を取得する

説明

string get_the_archive_description()
アーカイブページの説明を取得する。

パラメータ

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

返り値

アーカイブページの説明を返す。

注意

アーカイブの説明はterm_description関数を呼び出して取得している。

[4.7.0]投稿者アーカイブ(is_author関数がtrue)の場合は投稿者の説明(メタ情報)を取得する。

使用例

  • アーカイブページの説明を取得する。
    <?php $description = get_the_archive_description(); ?>

フィルター

[4.1.0]説明を返す前に'get_the_archive_description'フィルターを呼び出す。パラメータ$descriptionにはアーカイブページの説明が格納される。
return apply_filters( 'get_the_archive_description', $description );

アクション

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

ソースファイル

/wp-includes/general-template.php

関連

お勧めコンテンツ

タイトルが一致する投稿を検索する(2014年2月20日 登録)

WordPressが提供する投稿ページの文字列検索機能の実現には、query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

決まった値を返すだけの関数群(2015年7月15日 登録)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

もうquery_postsは呼ばない(2011年9月27日 登録)

トップページやカテゴリーページで標準の条件に少し手を加えた投稿情報を表示するケースがある。そんな時、テンプレートファイルの先頭でquery_posts関数を呼び出して投稿情報を再抽出していたのだが、フィルター処理をうまく使えばquery_posts関数を呼び出さなくても大丈夫みたいだ。

「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 登録)

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

テキストエディタの文字を変更する(2016年8月30日 登録)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。

最終更新日時 : 2016-12-16 14:44