概要
wp_checkdate関数は、与えられた日付がグレゴリオ暦として有効かどうかを調べるために使用されるWordPressの関数です。この関数はカレンダーの日付検証を行う際によく使われます。具体的には以下のようなシナリオで利用されます:
- ユーザーからの入力を検証する際
- カスタム投稿タイプの日付フィールドの確認
- イベントの日付データの妥当性チェック
- 定期的なスケジュールの設定時
- フォーム入力のバリデーション
- プラグインやテーマの設定画面での日付確認
- データベースに保存する前の日付検証
- APIから取得した日付データの整合性確認
構文
bool wp_checkdate( int $month, int $day, int $year, string $format = 'Y-m-d' );
パラメータ
month(int): 検証したい月 (1から12)day(int): 検証したい日 (1から31)year(int): 検証したい年 (4桁)format(string): 日付形式 (省略可能、デフォルトは ‘Y-m-d’)
戻り値
- 成功した場合は
true、無効な日付の場合はfalseを返します。
関連する関数
使用可能なバージョン
wp_checkdateはWordPress 2.0.0以降で利用可能です。
コアファイルのパス
wp-includes/functions.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 |
wp_checkdate関数が特定のWordPressバージョンで非推奨または削除された情報はありません。