rest_validate_number_value_from_schema()


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

構文

rest_validate_number_value_from_schema( $value, $schema );

引数の説明:

  • $value(mixed) — バリデーションを行う値。
  • $schema(array) — バリデーションルールを含むスキーマ配列。

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

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

$schema = ['type' => 'integer']; $value = 42; echo rest_validate_number_value_from_schema($value, $schema);

例2: 最小値と最大値のバリデーション

この例では、値が指定された範囲内にあるかどうかを確認します。

$schema = ['type' => 'number', 'minimum' => 10, 'maximum' => 100]; $value = 50; echo rest_validate_number_value_from_schema($value, $schema);

例3: 浮動小数点数のバリデーション

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

$schema = ['type' => 'number']; $value = 3.14; echo rest_validate_number_value_from_schema($value, $schema);

例4: 必須フィールドのバリデーション

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

$schema = ['type' => 'number', 'required' => true]; $value = null; echo rest_validate_number_value_from_schema($value, $schema);

例5: 複数のバリデーションルール

この例では、複数のバリデーションルールを適用します。

$schema = ['type' => 'number', 'minimum' => 1, 'maximum' => 10]; $value = 5; echo rest_validate_number_value_from_schema($value, $schema);

例6: エラーメッセージの取得

この例では、バリデーションが失敗した場合にエラーメッセージを取得します。

$schema = ['type' => 'number', 'minimum' => 10]; $value = 5; if (!rest_validate_number_value_from_schema($value, $schema)) { echo '値が最小値以下です。'; }

例7: カスタムエラーメッセージの設定

この例では、カスタムエラーメッセージを設定します。

$schema = ['type' => 'number', 'minimum' => 10, 'error_message' => '値は10以上でなければなりません。']; $value = 5; echo rest_validate_number_value_from_schema($value, $schema);

注意点

  • スキーマの定義が正しくない場合、バリデーションが正しく動作しないことがあります。
  • 値が数値でない場合、バリデーションは失敗します。
  • スキーマにrequiredが設定されている場合、値がnullだとバリデーションは失敗します。

関連機能：