String_Schema
extends Schema
in package
Represents a schema for a string.
See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#strings
Table of Contents
- $schema : array<string|int, mixed>
- Schema definition.
- default() : static
- Set the default value.
- description() : static
- Set the description of the schema.
- field() : static
- Set the field name and value.
- formatDateTime() : self
- Set the format of the string according to DateTime.
- formatEmail() : self
- Set the format of the string according to email.
- formatHexColor() : self
- Set the format of the string according to Hex color.
- formatIp() : self
- Set the format of the string according to IP address.
- formatUri() : self
- Set the format of the string according to uri.
- formatUuid() : self
- Set the format of the string according to uuid.
- maxLength() : self
- Set maximum length of the string.
- minLength() : self
- Set minimum length of the string.
- non_nullable() : static
- Sets the schema as non-nullable.
- nullable() : static
- Sets the schema as nullable.
- optional() : static
- Unsets the required property.
- pattern() : self
- Parameter $pattern is a regular expression without leading/trailing delimiters.
- required() : static
- Sets the schema as required.
- title() : static
- Set the title of the schema.
- to_array() : array<string|int, mixed>
- Returns the schema as an array.
- to_string() : string
- Returns the schema as a JSON string.
- get_reserved_keywords() : array<string|int, string>
- Returns reserved keywords.
- unset_schema_property() : static
- Unsets the schema property.
- update_schema_property() : static
- Updates the schema property.
- validate_pattern() : void
- Validates the regular expression pattern.
Properties
$schema
Schema definition.
protected
array<string|int, mixed>
$schema
= array('type' => 'string')
Methods
default()
Set the default value.
public
default(mixed $default_value) : static
Parameters
- $default_value : mixed
-
Default value.
Return values
static —description()
Set the description of the schema.
public
description(string $description) : static
Parameters
- $description : string
-
Description.
Return values
static —field()
Set the field name and value.
public
field(string $name, mixed $value) : static
Parameters
- $name : string
-
Name of the field.
- $value : mixed
-
Value of the field.
Tags
Return values
static —formatDateTime()
Set the format of the string according to DateTime.
public
formatDateTime() : self
Return values
self —formatEmail()
Set the format of the string according to email.
public
formatEmail() : self
Return values
self —formatHexColor()
Set the format of the string according to Hex color.
public
formatHexColor() : self
Return values
self —formatIp()
Set the format of the string according to IP address.
public
formatIp() : self
Return values
self —formatUri()
Set the format of the string according to uri.
public
formatUri() : self
Return values
self —formatUuid()
Set the format of the string according to uuid.
public
formatUuid() : self
Return values
self —maxLength()
Set maximum length of the string.
public
maxLength(int $value) : self
Parameters
- $value : int
-
Maximum length.
Return values
self —minLength()
Set minimum length of the string.
public
minLength(int $value) : self
Parameters
- $value : int
-
Minimum length.
Return values
self —non_nullable()
Sets the schema as non-nullable.
public
non_nullable() : static
Return values
static —nullable()
Sets the schema as nullable.
public
nullable() : static
Return values
static —optional()
Unsets the required property.
public
optional() : static
Return values
static —pattern()
Parameter $pattern is a regular expression without leading/trailing delimiters.
public
pattern(string $pattern) : self
See: https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#pattern
Parameters
- $pattern : string
-
Regular expression pattern.
Return values
self —required()
Sets the schema as required.
public
required() : static
Return values
static —title()
Set the title of the schema.
public
title(string $title) : static
Parameters
- $title : string
-
Title.
Return values
static —to_array()
Returns the schema as an array.
public
to_array() : array<string|int, mixed>
Return values
array<string|int, mixed> —to_string()
Returns the schema as a JSON string.
public
to_string() : string
Tags
Return values
string —get_reserved_keywords()
Returns reserved keywords.
protected
get_reserved_keywords() : array<string|int, string>
Return values
array<string|int, string> —unset_schema_property()
Unsets the schema property.
protected
unset_schema_property(string $name) : static
Parameters
- $name : string
-
Property name.
Return values
static —update_schema_property()
Updates the schema property.
protected
update_schema_property(string $name, mixed $value) : static
Parameters
- $name : string
-
Property name.
- $value : mixed
-
Property value.
Return values
static —validate_pattern()
Validates the regular expression pattern.
protected
validate_pattern(string $pattern) : void
Parameters
- $pattern : string
-
Regular expression pattern.