• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

テンプレートタグ/wp get archives

提供: WordPress Codex 日本語版
移動先: 案内検索

この関数 wp_get_archives() は日付ベースのアーカイブリストを表示します。これはテンプレートのどこでも使えます。

参考:この関数は、非推奨になった get_archives() の後継です。違いは、パラメータの引数をクエリ文字列形式または配列形式で関数に渡すことだけです。

使い方

<?php wp_get_archives( $args ); ?>

初期設定での使用

<?php
$args = array(
	'type'            => 'monthly',
	'limit'           => '',
	'format'          => 'html', 
	'before'          => '',
	'after'           => '',
	'show_post_count' => false,
	'echo'            => 1,
	'order'           => 'DESC',
	'post_type'     => 'post'
);
wp_get_archives( $args );
?>

デフォルトのままで使うと、次のとおり表示します。

  • 月別アーカイブのリンクを表示
  • 全アーカイブを表示(表示数の制限なし)
  • HTML の <li>(番号なし箇条書き)リストでアーカイブを表示
  • 各リンクの前後に何も表示しない
  • 投稿数を表示しない
  • 降順に表示(新しい月を先に)

パラメータ

type 
(文字列) 表示するアーカイブリストの種類。初期値は月別アーカイブ。有効な値は:
  • yearly
  • monthly (初期値)
  • daily
  • weekly
  • postbypost (投稿を公開日時の順に)
  • alpha (投稿をタイトルのアルファベット順に)
limit 
(整数) 取得するアーカイブ数。初期値は制限なし。
format 
(文字列) アーカイブリストの形式。有効な値は:
  • html (初期値) - 前後に beforeafter の文字列を付け、HTML のリストタグ(<li>)で囲む。
  • option - セレクトボックスまたはドロップダウンメニュー用のセレクトタグ(<select>)内で使用するために、前後に beforeafter の文字列を付けてオプションタグ(<option>)で囲む。
  • link - リンクタグ(<link>)に入れる。
  • custom - 前後に beforeafter の文字列を付けたカスタムリスト。
before 
(文字列) format オプションが html または custom のとき、リンクの前に付けるテキスト。デフォルトは空文字列。
after 
(文字列) format オプションが html または custom のとき、リンクの後に付けるテキスト。デフォルトは空文字列。
show_post_count 
(真偽値) 投稿数を表示するかどうか。type オプションが 'postbypost' のときは無視される。
  • 1 (True) - 表示する
  • 0 (False) - 表示しない(初期値)
echo 
(真偽値) 表示するか、値として返すか。
  • 1 (True) - 表示する(初期値)
  • 0 (False) - 表示せず値として返す
order 
(文字列) リンクリストの順序(バージョン 3.5 以降)
  • 'ASC' - 昇順(A から Z へ)
  • 'DESC' - 降順(Z から A へ)(デフォルト)
post_type 
("string") Limit archives to a post type. Default is 'post'. (since Version 4.4)

用例

<?php 
$my_archives=wp_get_archives(array(
    'type'=>'alpha', 
    'show_post_count'=>true, 
    'limit'=>20, 
    'post_type'=>'post', 
    'format'=>'html' 
));
    
print_r($my_archives); 
?>

最近 12 ヵ月

この 12 ヵ月の月別アーカイブリストを表示します。投稿のない月は表示しません。

<ul><?php wp_get_archives( 'type=monthly&limit=12' ); ?></ul>

または

<ul><?php wp_get_archives( array( 'type' => 'monthly', 'limit' => 12 ) ); ?></ul>

最近 16 日

この 16日の日別アーカイブリストを表示します。

<ul><?php wp_get_archives( 'type=daily&limit=16' ); ?></ul>

または

<ul><?php wp_get_archives( array( 'type' => 'daily', 'limit' => 16 ) ); ?></ul>

最近の投稿 20 件

最新 20 件の投稿記事タイトルの一覧を表示します。

<ul><?php wp_get_archives( 'type=postbypost&limit=20&format=custom' ); ?></ul>

または

<ul><?php wp_get_archives( array( 'type' => 'postbypost', 'limit' => 20, 'format' => 'custom' ) ); ?></ul>

月別アーカイブのドロップダウンボックス(ドロップダウンメニュー)を表示、各選択肢に投稿数を表示します。

<select name="archive-dropdown" onChange='document.location.href=this.options[this.selectedIndex].value;'> 
  <option value=""><?php echo attribute_escape(__('Select Month')); ?></option> 
  <?php wp_get_archives( 'type=monthly&format=option&show_post_count=1' ); ?>
</select>

または

<select name="archive-dropdown" onchange="document.location.href=this.options[this.selectedIndex].value;">
  <option value=""><?php echo esc_attr( __( 'Select Month' ) ); ?></option> 
  <?php wp_get_archives( array( 'type' => 'monthly', 'format' => 'option', 'show_post_count' => 1 ) ); ?>
</select>

すべての投稿をアルファベット順に

すべての投稿をアルファベット順に表示します。サイトマップ風のアーカイブ表示になります。

<?php wp_get_archives( 'type=alpha' ); ?>

参考

get_archives_link() を呼び出して、一つ一つのアーカイブリンクの文字列を組み立てます。

変更履歴

  • 4.4.0: 'post_type'パラメータを追加しました。
  • 3.5.0 : 'order' パラメータを追加しました。
  • 1.2.0 : 新規導入。

ソースファイル

wp_get_archives()wp-includes/general-template.php にあります。

リスト・ドロップダウン関数: wp_list_authors(), wp_list_categories(), wp_list_pages(), wp_list_bookmarks(), wp_list_comments(), wp_get_archives(), wp_page_menu(), wp_dropdown_pages(), wp_dropdown_categories(), wp_dropdown_users()


テンプレートタグへのクエリ文字列型パラメータの渡し方関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp_get_archives最新版との差分