get_calendar() 関数は、投稿が存在する日にリンクを用意したカレンダーを表示します。

get_calendar() 関数とは

投稿が存在する日にリンクをつけたカレンダーを表示する関数です。

カレンダーはキャッシュされ、投稿などが存在すれば取得されます。しかし、その月に投稿がない場合には表示されません。

パラメーター

使い方

一般的な使い方は以下のように関数を設置することでカレンダーを出力する方法です。

get_calendar();

$display を false にした場合は、カレンダーの HTML を返します。

$calendar = get_calendar( true, false);

echo '<hr>' . basename(__FILE__) . ' :: ' . __LINE__;
echo( '<pre>' );
var_dump( $calendar );
echo( '</pre>' );
echo '<hr>';

フック

get_calendar

apply_filters( ‘get_calendar’, string $calendar_output )

出力するカレンダーの HTML にフィルターします。以下のコードで確認できます。

add_filter(
	'get_calendar',
	function ( $calendar_output ) {
		echo '<hr>' . basename(__FILE__) . ' :: ' . __LINE__;
		echo( '<pre>' );
		var_dump( $calendar_output );
		echo( '</pre>' );
		echo '<hr>';

		return $calendar_output;
	},
	10,
	1
);

まとめ

サイドバーなどに表示されるカレンダーウィジェットもこちらを活用されています。内部のコードはなかなか盛りだくさんな内容になっていますが、処理の流れを見てみると学びがたくさんありそうです。

get_calendar() – Function | Developer.WordPress.org

Displays calendar with days that have posts as links.

developer.wordpress.org