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



お勧め

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

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

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

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。