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



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。