概要
get_calendar関数は、WordPressにおいてカレンダーを表示するための関数です。この関数は主に以下のような機能を実装する際によく使われます。
- ブログやウェブサイト内での投稿をカレンダー形式で視覚化する。
- コンテンツのリリース履歴をカレンダーで示す。
- 特定の期間内の人気のある日付やイベントを強調表示する。
- カテゴリーやタグフィルターを使用して、特定のコンテンツを表示する。
- 日付ベースのナビゲーションを提供する。
- 月ごとのアーカイブを簡単に確認できる。
- ユーザーが特定の日の投稿を見つけやすくする。
- 定期的なイベントや更新のスケジュールを視覚的に示す。
構文
get_calendar( $echo = true );
パラメータ
$echo(bool) : カレンダーを表示するかどうか。デフォルトはtrue（表示）。
戻り値
- 成功した場合は、HTML形式のカレンダーを返します。
$echoがtrueの場合は、HTMLを直接出力します。
関連する関数
使用可能なバージョン
- この関数は、WordPressのコアから15.0以降のすべてのバージョンで使用可能です。
コアファイルのパス
wp-includes/general-template.php
サンプルコード
サンプルコード 1
// カレンダーを表示する
if ( !function_exists('get_calendar') ) {
return;
}
echo get_calendar();
このコードは、カレンダーを表示するために get_calendar 関数を使用しています。
サンプルコード 2
// カレンダーを要素に保存する
$calendar = get_calendar(false);
file_put_contents('calendar.html', $calendar);
このコードは、カレンダーをHTML形式で変数に保存し、ファイルに保存しています。
サンプルコード 3
// カレンダーをカスタムスタイルで表示
function custom_calendar() {
echo '<div class="custom-calendar">';
echo get_calendar();
echo '</div>';
}
add_action('wp_footer', 'custom_calendar');
このコードは、フッターにカスタムスタイルでカレンダーを表示する関数を作成しています。
サンプルコード 4
// 異なる month's のカレンダーを表示
echo get_calendar( true, '2023-12' );
このコードは、特定の月（2023年12月）のカレンダーを表示するサンプルです。
サンプルコード 5
// カレンダーを非表示で取得
$calendar = get_calendar(false);
echo '<pre>' . htmlspecialchars($calendar) . '</pre>';
このコードは、カレンダーを非表示で取得し、その内容を整形して出力しています。
この関数のアクションでの使用可能性
| アクション | 使用可能 |
|---|---|
| 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 |
非推奨または削除されたバージョン
- 特定のバージョンで非推奨や削除されていないため、該当する情報はありません。