Form extends Component

Handles forms.

Table of Contents

__construct()  : mixed
Class constructor.
add_captcha()  : array<string|int, mixed>
Adds captcha field.
enqueue_scripts()  : mixed
Enqueues scripts.
set_captcha()  : array<string|int, mixed>
Sets captcha flag.
set_field_arguments()  : array<string|int, mixed>
Sets field arguments.
set_field_options()  : array<string|int, mixed>
Sets field options.
validate_captcha()  : array<string|int, mixed>
Validates captcha.
boot()  : mixed
Bootstraps component properties.
get_days()  : array<string|int, mixed>
Gets days of the week.
get_emails()  : array<string|int, mixed>
Gets email names.
get_field_options()  : array<string|int, mixed>
Gets field options.
get_fields()  : array<string|int, mixed>
Gets field names.
get_forms()  : array<string|int, mixed>
Gets form names.
get_mime_types()  : array<string|int, mixed>
Gets MIME types.
get_posts()  : array<string|int, mixed>
Gets post objects.
get_templates()  : array<string|int, mixed>
Gets template names.
get_terms()  : array<string|int, mixed>
Gets term objects.
get_timezones()  : array<string|int, mixed>
Gets time zones.
get_users()  : array<string|int, mixed>
Gets user objects.
is_captcha_enabled()  : bool
Checks if captcha is enabled.
set_callbacks()  : mixed
Sets the action and filter callbacks.
set_property()  : mixed
Sets a property value.

Methods

__construct()

Class constructor.

public __construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
$args : array<string|int, mixed> = []

Component arguments.

Return values
mixed —

add_captcha()

Adds captcha field.

public add_captcha(array<string|int, mixed> $args, object $form) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>

Form arguments.

$form : object

Form object.

Return values
array<string|int, mixed> —

set_captcha()

Sets captcha flag.

public set_captcha(string $meta) : array<string|int, mixed>
Parameters
$meta : string

Class meta.

Return values
array<string|int, mixed> —

set_field_arguments()

Sets field arguments.

public set_field_arguments(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>

Field arguments.

Return values
array<string|int, mixed> —

set_field_options()

Sets field options.

public set_field_options(array<string|int, mixed> $options, object $field) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed>

Field options.

$field : object

Field object.

Return values
array<string|int, mixed> —

validate_captcha()

Validates captcha.

public validate_captcha(array<string|int, mixed> $errors, object $form) : array<string|int, mixed>
Parameters
$errors : array<string|int, mixed>

Form errors.

$form : object

Form object.

Return values
array<string|int, mixed> —

get_days()

Gets days of the week.

protected get_days(array<string|int, mixed> $args, mixed $value) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>

Day arguments.

$value : mixed

Current value.

Return values
array<string|int, mixed> —

get_emails()

Gets email names.

protected get_emails(array<string|int, mixed> $args, mixed $value) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>

Email arguments.

$value : mixed

Current value.

Return values
array<string|int, mixed> —

get_field_options()

Gets field options.

protected get_field_options(string $type, array<string|int, mixed> $args[, mixed $value = null ]) : array<string|int, mixed>
Parameters
$type : string

Options type.

$args : array<string|int, mixed>

Option arguments.

$value : mixed = null

Current value.

Return values
array<string|int, mixed> —

get_fields()

Gets field names.

protected get_fields(array<string|int, mixed> $args, mixed $value) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>

Field arguments.

$value : mixed

Current value.

Return values
array<string|int, mixed> —

get_forms()

Gets form names.

protected get_forms(array<string|int, mixed> $args, mixed $value) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>

Form arguments.

$value : mixed

Current value.

Return values
array<string|int, mixed> —

get_mime_types()

Gets MIME types.

protected get_mime_types(array<string|int, mixed> $args, mixed $value) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>

MIME type arguments.

$value : mixed

Current value.

Return values
array<string|int, mixed> —

get_posts()

Gets post objects.

protected get_posts(array<string|int, mixed> $args, mixed $value) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>

Post arguments.

$value : mixed

Current value.

Return values
array<string|int, mixed> —

get_templates()

Gets template names.

protected get_templates(array<string|int, mixed> $args, mixed $value) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>

Template arguments.

$value : mixed

Current value.

Return values
array<string|int, mixed> —

get_terms()

Gets term objects.

protected get_terms(array<string|int, mixed> $args, mixed $value) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>

Term arguments.

$value : mixed

Current value.

Return values
array<string|int, mixed> —

get_timezones()

Gets time zones.

protected get_timezones() : array<string|int, mixed>
Return values
array<string|int, mixed> —

get_users()

Gets user objects.

protected get_users(array<string|int, mixed> $args, mixed $value) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>

User arguments.

$value : mixed

Current value.

Return values
array<string|int, mixed> —

set_callbacks()

Sets the action and filter callbacks.

protected final set_callbacks(array<string|int, mixed> $callbacks) : mixed
Parameters
$callbacks : array<string|int, mixed>

Callback arguments.

Return values
mixed —

set_property()

Sets a property value.

protected final set_property(string $name, mixed $value[, string $prefix = '' ]) : mixed
Parameters
$name : string

Property name.

$value : mixed

Property value.

$prefix : string = ''

Method prefix.

Return values
mixed —