wp_get_archives()

関数の概要

wp_get_archives() は、WordPressテーマ内で投稿のアーカイブリストを表示するために使用される関数です。この関数は、月別、年別、日別などの異なるアーカイブ形式で投稿リストを生成し、訪問者が過去の投稿を簡単に探せるようにします。主にサイドバーやフッターなどにアーカイブメニューを表示するために使用されます。

パラメータの説明

wp_get_archives( $args )

  • $args (array|string)（省略可能）：アーカイブリストをカスタマイズするための引数の配列またはクエリ文字列。主な引数は以下の通りです：
  • type (string)：アーカイブのタイプを指定します。デフォルトは 'monthly' です。他に 'yearly', 'daily', 'weekly', 'postbypost', 'alpha' などがあります。
  • limit (int)：表示するアーカイブの数を指定します。デフォルトは全て表示します。
  • format (string)：リストの形式を指定します。デフォルトは 'html' です。他に 'option', 'custom' などがあります。
  • before (string)：各アーカイブリンクの前に表示するテキストまたはHTML。
  • after (string)：各アーカイブリンクの後に表示するテキストまたはHTML。
  • show_post_count (bool)：各アーカイブの投稿数を表示するかどうか。デフォルトは false です。
  • echo (bool)：true ならアーカイブリストを表示し、false ならアーカイブリストを返します。デフォルトは true です。

使用例

以下は、wp_get_archives() 関数を使用して月別アーカイブリストを表示する基本的な例です：

<ul>
    <?php wp_get_archives(); ?>
</ul>

年別アーカイブリストを表示する例：

<ul>
    <?php wp_get_archives( array( 'type' => 'yearly' ) ); ?>
</ul>

アーカイブリンクの前後にカスタムテキストを追加する例：

<ul>
    <?php wp_get_archives( array( 'before' => '<span>', 'after' => '</span>' ) ); ?>
</ul>

アーカイブごとに投稿数を表示する例：

<ul>
    <?php wp_get_archives( array( 'show_post_count' => true ) ); ?>
</ul>

関連する関数

  • get_archives_link(): 特定のアーカイブリンクを生成し、返します。カスタムアーカイブリストを手動で作成するのに便利です。
  • wp_list_categories(): カテゴリーリストを表示するために使用されます。アーカイブリストと似た形式でカテゴリーリストを生成します。
  • get_calendar(): カレンダー形式で投稿日を表示するために使用されます。

アーカイブのカスタマイズ

アーカイブリストのスタイルや構造をカスタマイズするために、CSSクラスやカスタムHTMLを追加することができます。以下は、CSSクラスを追加してアーカイブリストをカスタマイズする例です：

<ul class="custom-archive-list">
    <?php wp_get_archives( array( 'before' => '<li class="archive-item">', 'after' => '</li>' ) ); ?>
</ul>

カスタムフォーマットの使用

format 引数を 'custom' に設定してカスタムHTMLを使用することもできます。以下は、カスタムフォーマットでアーカイブリンクを表示する例です：

<?php
$archives = wp_get_archives( array( 'type' => 'monthly', 'format' => 'custom', 'before' => '<li>', 'after' => '</li>', 'echo' => 0 ) );
echo '<ul class="custom-archive-list">' . $archives . '</ul>';
?>

このようにすることで、アーカイブリストの出力を完全にカスタマイズできます。

wp_get_archives() 関数を使用することで、テーマのテンプレートファイル内で投稿のアーカイブリストを簡単に表示することができます。これにより、訪問者が過去の投稿を簡単に探せるようになり、サイトのナビゲーションが向上します。

スポンサーリンク