wp_get_archives

説明

string wp_get_archives( [ mixed $args = '' ] )
投稿記事のアーカイブリンクをパラメータ$argsのecho値が1ならば表示する。echo値が0ならばその文字列を取得する。

パラメータ

  • $args
    表示条件を指定する文字列(または連想配列)。文字列の場合はname=valueの形式で指定し、複数の条件はname1=value1&name2=value2のように'&'の後に続ける。主なキーワードは次の通り。
    キーワード省略時の値意味
    type'monthly'アーカイブ種別を指定('daily'、'weekly'、'monthly'、'yearly'、'postbypost'、'alpha'など)
    limit''表示件数(正数)
    format'html'表示形式を指定('html'、'link'、'option'など)
    before''リンク名の前に連結する文字列
    after''リンク名の後に連結する文字列
    show_post_countfalse投稿件数を表示する場合はtrue、表示しない場合はfalse
    echo1表示する場合は1、文字列として取得する場合は0
    order'DESC'降順は'DESC'、昇順は'ASC'を指定
    post_type'post'[4.4.0]投稿タイプを指定
    year get_query_var('year')[5.2.0]年を指定
    monthnumget_query_var('monthnum')[5.2.0]月(1~12)を指定
    dayget_query_var('day')[5.2.0]日(1~31)を指定
    wget_query_var('w')[5.2.0]曜日(1~53)を指定

返り値

パラメータ$argsにecho値が0の場合は、リンクの文字列を返す。echo値が1(デフォルト)の場合は何も返さない。

注意

[4.4.0]'post_type'パラメータが追加され、任意の投稿タイプのアーカイブ情報を取得できるようになった。

[5.2.0]'year'、'monthnum'、'day'、'w'パラメータが追加され、プルダウンメニュー(option要素)のselected属性を指定できるようになった。


使用例

  • アーカイブリンクを表示する。
    <?php wp_get_archives( ); ?>
  • アーカイブリンクのプルダウンメニューを表示する。
    <select id="archives" name="archives">
    <?php wp_get_archives( array( 'format' => 'option', 'year' => 2018, 'monthnum' => 12 ) ); ?>
    </select>
    

フィルター

[2.2.0]検索を行う直前にgetarchives_whereフィルターが実行される。このフィルターを利用することで、アーカイブの取得条件を変更できる。フィルター関数には$where$r(本関数呼び出し時のパラメータが展開されたもの)が渡り、$whereにはデフォルトとして "WHERE post_type = 'post' AND post_status = 'publish'" が格納されている。
$where = apply_filters( 'getarchives_where', $where, $r );
[2.2.0]getarchives_whereフィルターの実行直後にgetarchives_joinフィルターが実行される。アーカイブの取得条件で投稿情報以外のテーブルを使用する場合にこのフィルターを利用する。フィルター関数には$join$rが渡り、$whereにはデフォルトとして '' が格納されている。
$join = apply_filters( 'getarchives_join', $join, $r );
指定された条件で取得された投稿情報に投稿タイトルがある場合は'the_title'フィルターを呼び出す。パラメータ$post_titleには投稿タイトルが、$post_idには投稿IDが格納される。
$text = strip_tags( apply_filters( 'the_title', $post_title, $post_id ) );

アクション

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

ソースファイル

/wp-includes/general-template.php

最終更新 : 2019年05月09日 17:53



お勧め

フィードにサムネイル画像を追加する(2022年11月1日 更新)

WordPressが出力するの標準のフィードには、各投稿のサムネイル画像の情報が含まれていない。ネットで検索してみるといくつかの方法があることがわかったので、その中から2つ試してみた。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。

5.5の機能強化:コメントフォームのちょっとした改良(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3(以降Beta 3)」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

index.htmlでアーカイブページを表示させる(2011年10月14日 更新)

静的なサイトでは、各ディレクトリにindex.htmlファイルを置き、そのディレクトリの内容を紹介することが多い。WordPressで構築したサイトも同様にできないかと考え、試行錯誤してみた(こんなことを考えてるのは自分だけだろうか!?)。