rest_validate_boolean_value_from_schema()


WordPressのrest_validate_boolean_value_from_schema()関数は、REST APIのスキーマに基づいてブール値の検証を行うために使用されます。この関数は、指定された値がスキーマで定義されたブール値の要件を満たしているかどうかを確認します。

シンタックス

rest_validate_boolean_value_from_schema( mixed $value, WP_REST_Request $request, string $param );

引数の説明:

  • $value (mixed) — 検証する値。
  • $request (WP_REST_Request) — RESTリクエストオブジェクト。
  • $param (string) — 検証するパラメーターの名前。

例1: 基本的なブール値の検証

この例では、rest_validate_boolean_value_from_schema()を使用して、値がブール値であるかどうかを検証します。

$value = true; $request = new WP_REST_Request(); $param = 'is_active'; $result = rest_validate_boolean_value_from_schema( $value, $request, $param );

例2: 文字列のブール値検証

文字列がブール値として有効かどうかを検証します。

$value = 'true'; $request = new WP_REST_Request(); $param = 'is_enabled'; $result = rest_validate_boolean_value_from_schema( $value, $request, $param );

例3: 数値のブール値検証

数値がブール値として有効かどうかを検証します。

$value = 1; $request = new WP_REST_Request(); $param = 'is_available'; $result = rest_validate_boolean_value_from_schema( $value, $request, $param );

例4: 無効な値の検証

無効な値がブール値として検証されないことを確認します。

$value = 'invalid'; $request = new WP_REST_Request(); $param = 'is_active'; $result = rest_validate_boolean_value_from_schema( $value, $request, $param );

例5: カスタムスキーマを使用した検証

カスタムスキーマを使用してブール値を検証します。

$value = false; $request = new WP_REST_Request(); $param = 'is_visible'; $schema = array( 'type' => 'boolean' ); $result = rest_validate_boolean_value_from_schema( $value, $request, $param, $schema );

例6: デフォルト値の検証

デフォルト値がブール値として検証されることを確認します。

$value = null; $request = new WP_REST_Request(); $param = 'is_active'; $result = rest_validate_boolean_value_from_schema( $value, $request, $param );

例7: 複数のパラメーターの検証

複数のパラメーターに対してブール値の検証を行います。

$values = array( 'is_active' => true, 'is_visible' => false ); $request = new WP_REST_Request(); foreach ( $values as $param => $value ) { $result = rest_validate_boolean_value_from_schema( $value, $request, $param ); }

注意点

  • この関数は、REST APIのコンテキストでのみ使用することを推奨します。
  • 無効な値が渡された場合、関数はfalseを返します。
  • カスタムスキーマを使用する場合、スキーマの定義が正しいことを確認してください。

関連機能：