get_calendar

（1.0.0以降）
get_calendar - カレンダーを表示する

説明

[6.8.0以降] string get_calendar( [ array $args = array() ] )
[6.8.0前] string get_calendar( [ bool $initial = true [, bool $echo = true ] ] )
投稿ページへのリンク付きカレンダー（1月分）を表示する。

パラメータ

[6.8.0以降]
  • $args
    カレンダーの内容を指定する連想配列を指定（省略時はarray()）。
    キーデータ型内容省略時
    'initial'bool曜日の名前を初期化する場合はtruetrue
    'display'boolカレンダーを表示する場合はtruetrue
    'post_type'string投稿タイプ名'post'
[6.8.0前]
  • $initial
    曜日の名前を初期化する場合はtrue、初期化しない場合はfalseを指定（省略時はtrue）。
  • $echo
    カレンダーを表示する場合はtrue、表示しない場合はfalseを指定（省略時はtrue）。

返り値

パラメータ$echoがfalseの場合のみカレンダーのHTMLテキストを返す。そのほかの場合、返り値はありません。

注意

この関数はカレンダーウィジェットに使用されており、表示（出力）されるカレンダーは、管理者ページ「一般設定」の「週の始まり」で指定された「曜日」から始まる。

関数名はgetで始まるが、パラメータ$echoがtrueの場合（省略時）はカレンダーをすぐに表示し、何も返さない。

[6.8.0]パラメータは$argsに変更され、従来の指定は対応するキーの値で指定するようになった。あわせて'post_type'キーの値に'post'以外の有効なカスタム投稿タイプが指定可能になった（無効な投稿タイプを指定した場合は'post'が適用される）。

使用例

  • カレンダーを表示する。
    <?php get_calendar( ); ?>
  • [6.8.0以降]カレンダーのHTMLテキストを取得する。
    <?php $cal = get_calendar( array( 'initial' => true, 'display' => false ) ); ?>
  • [6.8.0前]カレンダーのHTMLテキストを取得する。
    <?php $cal = get_calendar( true, false ); ?>

フィルター

[6.8.0]カレンダーの内容を生成する前に'get_calendar_args'フィルターを呼び出す。パラメータ$argsには本関数が受け取った内容にデフォルト値を適用した配列が格納されている。 
$args = apply_filters( 'get_calendar_args', $args );
[3.0.0]カレンダーのHTMLを表示または返す前に'get_calendar'フィルターを呼び出す。パラメータ$calendar_outputにはカレンダーのHTMLが格納されている。[6.8.0]パラメータ$argsが追加され、'get_calendar_args'フィルターの返り値が格納されている。 
$calendar_output = apply_filters( 'get_calendar', $calendar_output, $args );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/general-template.php

最終更新 : 2025年04月17日 10:26

関連

参考

Code Reference: get_calendar

お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する（2013年9月26日 更新）

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

投稿情報を連想配列で参照する（2018年5月27日 更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

段落ブロックに日付・時刻の入力支援を実装した（2023年1月25日 更新）

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した（2019年1月10日 更新）

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。