rest_validate_string_value_from_schema()


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

構文

rest_validate_string_value_from_schema( mixed $value, array $schema, string $param );

引数の説明:

  • $value(mixed) — 検証する値。
  • $schema(array) — 検証に使用するスキーマ。
  • $param(string) — 検証するパラメータの名前。

例1: 基本的な文字列の検証

この例では、文字列がスキーマに定義された最小長を満たしているかどうかを検証します。

$schema = ['type' => 'string', 'minLength' => 5]; echo rest_validate_string_value_from_schema('Hello', $schema, 'param_name');

例2: 最大長の検証

この例では、文字列がスキーマに定義された最大長を超えていないかどうかを検証します。

$schema = ['type' => 'string', 'maxLength' => 10]; echo rest_validate_string_value_from_schema('HelloWorld', $schema, 'param_name');

例3: 正規表現による検証

この例では、文字列が正規表現に一致するかどうかを検証します。

$schema = ['type' => 'string', 'pattern' => '^[A-Za-z]+$']; echo rest_validate_string_value_from_schema('Hello', $schema, 'param_name');

例4: 必須フィールドの検証

この例では、値が必須フィールドであるかどうかを検証します。

$schema = ['type' => 'string', 'required' => true]; echo rest_validate_string_value_from_schema('', $schema, 'param_name');

例5: 列挙型の検証

この例では、値が指定された列挙型のいずれかに一致するかどうかを検証します。

$schema = ['type' => 'string', 'enum' => ['red', 'green', 'blue']]; echo rest_validate_string_value_from_schema('red', $schema, 'param_name');

例6: フォーマットの検証

この例では、値が指定されたフォーマット（例: email）に一致するかどうかを検証します。

$schema = ['type' => 'string', 'format' => 'email']; echo rest_validate_string_value_from_schema('test@example.com', $schema, 'param_name');

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

この例では、検証が失敗した場合にカスタムエラーメッセージを返します。

$schema = ['type' => 'string', 'minLength' => 5, 'error_message' => '文字列が短すぎます']; echo rest_validate_string_value_from_schema('Hi', $schema, 'param_name');

注意点

  • スキーマが正しく定義されていない場合、検証が失敗する可能性があります。
  • 検証に失敗した場合、エラーメッセージが返されるため、適切にハンドリングする必要があります。

関連機能：