wp_get_archives:WordPress私的マニュアル

wp_get_archives

(1.2.0以降)
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_count	false	投稿件数を表示する場合はtrue、表示しない場合はfalse
echo	1	表示する場合は1、文字列として取得する場合は0
order	'DESC'	降順は'DESC'、昇順は'ASC'を指定
post_type	'post'	[4.4.0]投稿タイプを指定

返り値

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

注意

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

使用例

アーカイブリンクを表示する。
<?php wp_get_archives( ); ?>

フィルター

[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

参考

Code Reference: wp_get_archives

お勧めコンテンツ

カスタム投稿タイプの投稿保存には専用アクションを使おう（2014年7月4日登録）

カスタム投稿タイプを登録して、専用ウィジェット（meta_box）を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。

Posts filter multiselect：プラグイン作ってみました（2015年3月9日登録）

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

スクリプトファイルのバージョンパラメータを変更する（2015年2月10日登録）

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

「テキスト」モードと「ビジュアル」モードを行き来すると投稿内容の一部が消える（2015年3月14日登録）

仕事がらサイトの引っ越し作業のお手伝いをすることがあるのですが、今回は引っ越しにあわせてWordPressを「3.7.1」から最新版「4.1.1」にアップデートすることになりました。ここで紹介するのはこの案件で発生したトラブルの話です。

投稿情報を連想配列で参照する（2014年11月16日登録）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。