概要
wp_get_archives 関数は、WordPressサイトにおいて、アーカイブリンクを表示するための便利な関数です。この関数を使用することで、過去の投稿やページへのリンクを簡単に作成することができます。特に、ブログやコンテンツサイトでは、訪問者が過去の投稿にアクセスできるようにするために頻繁に利用されます。
この関数は以下のような機能を実装する際によく使われます。
- 年別アーカイブの表示
- 月別アーカイブの表示
- タグやカテゴリ別のアーカイブリストの表示
- Widgetsやサイドバーにアーカイブを追加
- カスタム投稿タイプのアーカイブを表示
- 投稿者別のアーカイブページへのリンク
- 過去の投稿への視認性を高める
- SEO対策としてのアーカイブの整備
構文
wp_get_archives( $args );
パラメータ
$args は配列であり、以下のオプションがあります。
type– 表示するアーカイブのタイプ（例: ‘daily’, ‘monthly’, ‘yearly’）。limit– 表示するアーカイブの数。format– 表示形式（例: ‘html’, ‘option’）。before– リンクの前に付加する文字列。after– リンクの後に付加する文字列。echo– 出力するかどうか（true または false）。
戻り値
関数は、設定された形式に応じて生成されたアーカイブリンクのHTMLを返します。
関連する関数
使用可能なバージョン
wp_get_archives 関数は WordPress 1.5.0 以降で使用可能です。
コアファイルのパス
wp-includes/general-template.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | 〇 |
| set_current_user | |
| init | |
| register_sidebar | 〇 |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head | 〇 |
著作権フリーのサンプルコード
-
年別アーカイブの表示
これは、年別に投稿をアーカイブするリンクを表示するサンプルコードです。<?php wp_get_archives( array( 'type' => 'yearly' ) ); ?> -
月別アーカイブの表示
投稿を月別にリストするためのリンクを作成します。<?php wp_get_archives( array( 'type' => 'monthly' ) ); ?> -
カスタムアーカイブ形式の表示
HTML形式でアーカイブを表示するサンプルです。<?php wp_get_archives( array( 'format' => 'html' ) ); ?> -
アーカイブリンクのカスタマイズ
リンクの前後にテキストを追加する例です。<?php wp_get_archives( array( 'before' => '<span>', 'after' => '</span>' ) ); ?> -
表示制限付きのアーカイブ表示
最新の5つのアーカイブリンクを表示するサンプルコードです。<?php wp_get_archives( array( 'limit' => 5 ) ); ?>
これらのサンプルコードは、WordPress公式サイトやその他のリソースでも同様の形式で提供されていますので、応用してみてください。