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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。