ワードプレスのget_month_link関数の使用方法・解説

概要

get_month_link関数は、指定した年月の月アーカイブのURLを取得するためのWordPressの関数です。この関数は、特定の年月に関連する投稿を一覧表示するアーカイブページのリンクを生成する際に使用されます。主に以下のような機能を実装する際によく使われます。

1. 月別アーカイブリストの作成
2. カスタムナビゲーションメニューの作成
3. サイトマップの生成
4. サイドバーウィジェットでの投稿一覧表示
5. 月別動向のビジュアル表示
6. アーカイブページへの内部リンクの強化
7. スポットライト投稿の月別表示
8. SEO効果を高めるための月別リンク追加

構文

get_month_link( int $year, int $month, string $post_type = 'post' );

パラメータ

• $year (int): 取得する月の年 (例: 2023)
• $month (int): 取得する月 (1から12)
• $post_type (string, optional): 取得する投稿タイプ (デフォルトは ‘post’)

戻り値

• (string): 指定した年月の月アーカイブのURL。

関連する関数

• get_post_type_archive_link
• get_year_link
• get_day_link

使用可能なバージョン

• 2.0.0以降

コアファイルのパス

• /wp-includes/link-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

サンプルコード

1. 月別アーカイブリンクの生成

   echo '<a href="' . get_month_link(2023, 10) . '">October 2023 Archive</a>';
   

   このコードは、2023年10月の月別アーカイブへのリンクを生成します。

2. カスタム投稿タイプの月別アーカイブリンクの生成

   echo '<a href="' . get_month_link(2023, 10, 'custom_post_type') . '">October 2023 Custom Archives</a>';
   

   このコードは、カスタム投稿タイプの2023年10月の月別アーカイブへのリンクを生成します。

3. ループ内での月別アーカイブリンクの表示

   if (have_posts()) {
      while (have_posts()) {
          the_post();
          $post_month = get_the_time('m');
          $post_year = get_the_time('Y');
          echo '<a href="' . get_month_link($post_year, $post_month) . '">' . get_the_time('F Y') . '</a>';
      }
   }
   

   このコードは、投稿ループ内で各投稿の月別アーカイブリンクを生成します。

4. 月別アーカイブリストの作成

   $months = wp_get_archives(array('type' => 'monthly', 'echo' => 0));
   echo $months;
   

   このコードは、サイト内の全ての月別アーカイブリンクをリストとして表示します。

5. カスタムメニューの作成

   $links = '';
   for ($i = 1; $i <= 12; $i++) {
      $links .= '<li><a href="' . get_month_link(2023, $i) . '">Month ' . $i . ' 2023</a></li>';
   }
   echo '<ul>' . $links . '</ul>';
   

   このコードは、2023年の各月のアーカイブへのリンクを含むカスタムメニューを生成します。

これらのサンプルコードはすべて著作権フリーのものであり、WordPressのカスタマイズやテーマの開発時に活用できます。