get_the_archive_description

説明

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

パラメータ

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

返り値

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

注意

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

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

[4.9.0]投稿タイプアーカイブ(is_post_type_archive[/af関数が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

最終更新 : 2018年05月27日 10:46



お勧め

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

Somewhere search box:プラグイン作ってみました(2018年5月8日 更新)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

32ピクセルのサイトアイコンを別の画像ファイルに変更する(2018年5月27日 更新)

「サイトアイコン」は4.3の新機能の1つ。管理画面で適当な画像ファイルを指定するだけでサイトアイコンが適用されます。そんなサイトアイコンで、既存の favicon.ico を併用する方法を紹介します。