概要
wp_validate_boolean関数は、引数として与えられた値がブール値かどうかを検証するための関数です。この関数は、設定オプションやユーザーの入力を扱う際に、意図しない型のデータを防ぐために非常に便利です。具体的には、次のようなシナリオでよく使用されます。
- カスタム設定オプションの検証
- プラグインやテーマの設定に対する入力値の確認
- ユーザーのフィードバックに基づくフラグの設定
- APIのリクエストパラメータのバリデーション
- コントローラのリクエストデータのサニタイズ
- ウィジェットのオプションの処理
- ショートコードの属性のバリデーション
- 投稿やページのメタデータの検証
構文
wp_validate_boolean( mixed $value )
パラメータ
$value(mixed): 検証したい値。ブール値に変換される。
戻り値
- (bool):
$valueが真の場合はtrue、それ以外はfalse。
関連する関数
ワードプレスのバージョン
この関数は、WordPress 3.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 |
サンプルコード
サンプルコード1: テーマの設定オプションの検証
$show_on_home = get_option( 'show_on_home' );
$show_on_home = wp_validate_boolean( $show_on_home );
// $show_on_homeはブール値になる
このコードは、テーマのオプションであるshow_on_homeの値を取得し、それがブール値であることを保証します。
サンプルコード2: プラグイン設定の処理
$my_plugin_option = isset( $_POST['my_plugin_option'] ) ? $_POST['my_plugin_option'] : 'false';
$my_plugin_option = wp_validate_boolean( $my_plugin_option );
// 設定をブール値に変換
このコードは、プラグインのオプションをPOSTリクエストから取得し、ブール値に変換します。
サンプルコード3: 特定の条件に基づくフラグ設定
$user_notification = '1'; // 文字列
$user_notification = wp_validate_boolean( $user_notification );
// $user_notificationはtrueになります
このコードは、ユーザーからの通知設定を文字列として受け取り、ブール値に変換しています。
サンプルコード4: APIレスポンスの処理
$response = get_api_response();
$response['active'] = wp_validate_boolean( $response['active'] );
// APIからの値をブール値に変換
このコードは、APIから取得したレスポンスのactiveフィールドをブール値として処理しています。
サンプルコード5: ウィジェットオプションの検証
$widget_options = get_option( 'my_widget_options' );
$widget_options['is_active'] = wp_validate_boolean( $widget_options['is_active'] );
// ウィジェットがアクティブかどうかを確認
このコードは、ウィジェットのオプションを取得し、is_activeフィールドの値をブール値に変換しています。