wp_get_archives

パラメータ

• $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]投稿タイプを指定
  year	get_query_var('year')	[5.2.0]年を指定
  monthnum	get_query_var('monthnum')	[5.2.0]月（1～12）を指定
  day	get_query_var('day')	[5.2.0]日（1～31）を指定
  w	get_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'" が格納されている。 [2.2.0]getarchives_whereフィルターの実行直後にgetarchives_joinフィルターが実行される。アーカイブの取得条件で投稿情報以外のテーブルを使用する場合にこのフィルターを利用する。フィルター関数には$joinと$rが渡り、$whereにはデフォルトとして '' が格納されている。 指定された条件で取得された投稿情報に投稿タイトルがある場合は'the_title'フィルターを呼び出す。パラメータ$post_titleには投稿タイトルが、$post_idには投稿IDが格納される。

アクション

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

ソースファイル

/wp-includes/general-template.php