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



お勧め

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

同じ名前のメタ情報をまとめて削除する(2014年3月21日 更新)

WordPressには、投稿情報、コメント情報、ユーザ情報のそれぞれを拡張できるメタ情報の仕組みが用意されている。投稿情報のメタ情報は「カスタムフィールド」として投稿画面に用意されているので投稿者自身が随時操作できるほか、テーマやプラグインからの操作も容易である。今回の中身はそんなメタ情報の一括削除の話だ。