rest_validate_integer_value_from_schema()


WordPressのrest_validate_integer_value_from_schema()関数は、REST APIのスキーマに基づいて整数値のバリデーションを行うために使用されます。この関数は、指定された値が整数であり、スキーマで定義された制約を満たしているかどうかを確認します。

構文

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

引数の説明:

  • $value(mixed) — バリデーションを行う値。
  • $request(WP_REST_Request) — RESTリクエストオブジェクト。
  • $param(string) — バリデーションを行うパラメータ名。

例1: 基本的な整数値のバリデーション

この例では、値が整数であるかどうかを確認します。

$is_valid = rest_validate_integer_value_from_schema( 42, $request, 'my_param' );

例2: 最小値と最大値の制約を伴うバリデーション

スキーマに最小値と最大値の制約がある場合のバリデーションを行います。

$is_valid = rest_validate_integer_value_from_schema( 100, $request, 'my_param' );

例3: 無効な値のバリデーション

値が整数でない場合、バリデーションは失敗します。

$is_valid = rest_validate_integer_value_from_schema( 'not_an_integer', $request, 'my_param' );

例4: スキーマに基づくバリデーション

スキーマに基づいて値が適切かどうかを確認します。

$is_valid = rest_validate_integer_value_from_schema( 50, $request, 'my_param' );

例5: デフォルト値のバリデーション

デフォルト値がスキーマに適合しているかどうかを確認します。

$is_valid = rest_validate_integer_value_from_schema( 0, $request, 'my_param' );

例6: 範囲外の値のバリデーション

値がスキーマで定義された範囲外の場合、バリデーションは失敗します。

$is_valid = rest_validate_integer_value_from_schema( 200, $request, 'my_param' );

例7: 複数のパラメータに対するバリデーション

複数のパラメータに対してバリデーションを行う例です。

$is_valid = rest_validate_integer_value_from_schema( 75, $request, 'my_param' );

注意点

  • この関数は、REST APIのコンテキストでのみ使用することを想定しています。
  • スキーマに定義された制約を満たさない値は、バリデーションに失敗します。
  • 値が整数でない場合、バリデーションは自動的に失敗します。

関連機能：