Attachment_Upload extends Field

Attachment upload.

Table of Contents

$args  : array<string|int, mixed>
Field arguments.
$attributes  : array<string|int, mixed>
HTML attributes.
$caption  : string
Button caption.
$context  : array<string|int, mixed>
Object context values.
$description  : string
Field description.
$disabled  : bool
Disable this field?
$display_template  : string
Display template.
$display_type  : string
Display type.
$errors  : array<string|int, mixed>
Field errors.
$filter  : mixed
SQL filter.
$formats  : array<string|int, mixed>
Allowed file formats.
$label  : string
Field label.
$max_files  : int
Maximum number of files.
$meta  : array<string|int, mixed>
Class meta values.
$multiple  : bool
Allow multiple files?
$name  : string
Field name.
$parent_value  : mixed
Parent field value.
$protected  : bool
Prevent direct URL access?
$required  : bool
Is value required?
$statuses  : array<string|int, mixed>
Field statuses.
$value  : mixed
Field value.
__construct()  : mixed
Class constructor.
display()  : string
Displays field HTML.
get_arg()  : mixed
Gets field argument.
get_args()  : array<string|int, mixed>
Gets field arguments.
get_context()  : mixed
Gets object context values.
get_description()  : string
Gets field description.
get_display_type()  : string
Gets display type.
get_display_value()  : mixed
Gets field value for display.
get_errors()  : array<string|int, mixed>
Gets field errors.
get_filter()  : mixed
Gets SQL filter.
get_formats()  : array<string|int, mixed>
Gets allowed file formats.
get_label()  : string
Gets field label.
get_max_files()  : int
Gets the maximum allowed number of files.
get_meta()  : mixed
Gets class meta values.
get_name()  : string
Gets field name.
get_slug()  : string
Gets field slug.
get_statuses()  : array<string|int, mixed>
Gets field statuses.
get_value()  : mixed
Gets field value.
init()  : mixed
Class initializer.
is_disabled()  : bool
Checks if field is disabled.
is_multiple()  : bool
Checks if multiple files are allowed.
is_protected()  : bool
Checks if attachment is protected.
is_required()  : bool
Checks if field is required.
render()  : string
Renders field HTML.
render_attachment()  : string
Renders attachment preview.
set_parent_value()  : object
Sets parent field value.
set_value()  : object
Sets field value.
update_filter()  : mixed
Updates SQL filter.
validate()  : bool
Validates field value.
add_errors()  : mixed
Adds field errors.
add_filter()  : mixed
Adds SQL filter.
boot()  : mixed
Bootstraps field properties.
normalize()  : mixed
Normalizes field value.
sanitize()  : mixed
Sanitizes field value.
set_display_template()  : mixed
Sets field display template.
set_formats()  : mixed
Sets allowed file formats.
set_meta()  : mixed
Sets class meta values.
set_property()  : mixed
Sets a property value.

Properties

Methods

__construct()

Class constructor.

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

Field arguments.

Return values
mixed

get_arg()

Gets field argument.

public final get_arg(string $name) : mixed
Parameters
$name : string

Argument name.

Return values
mixed

get_args()

Gets field arguments.

public final get_args() : array<string|int, mixed>
Return values
array<string|int, mixed>

get_context()

Gets object context values.

public final get_context([string $name = null ][, mixed $default = null ]) : mixed
Parameters
$name : string = null

Context name.

$default : mixed = null

Default value.

Return values
mixed

get_errors()

Gets field errors.

public final get_errors() : array<string|int, mixed>
Return values
array<string|int, mixed>

get_label()

Gets field label.

public final get_label([mixed $default = null ]) : string
Parameters
$default : mixed = null

Default label.

Return values
string

get_meta()

Gets class meta values.

public final static get_meta([string $name = '' ]) : mixed
Parameters
$name : string = ''

Meta name.

Return values
mixed

get_statuses()

Gets field statuses.

public final get_statuses() : array<string|int, mixed>
Return values
array<string|int, mixed>

init()

Class initializer.

public static init([array<string|int, mixed> $meta = [] ]) : mixed
Parameters
$meta : array<string|int, mixed> = []

Class meta values.

Return values
mixed

render_attachment()

Renders attachment preview.

public render_attachment(object $attachment) : string
Parameters
$attachment : object

Attachment object.

Return values
string

set_parent_value()

Sets parent field value.

public set_parent_value(mixed $value) : object
Parameters
$value : mixed

Field value.

Return values
object

set_value()

Sets field value.

public set_value(mixed $value) : object
Parameters
$value : mixed

Field value.

Return values
object

update_filter()

Updates SQL filter.

public final update_filter([bool $force = false ]) : mixed
Parameters
$force : bool = false

Force update?

Return values
mixed

add_errors()

Adds field errors.

protected final add_errors(mixed $errors) : mixed
Parameters
$errors : mixed

Field errors.

Return values
mixed

set_display_template()

Sets field display template.

protected set_display_template(string $display_template) : mixed
Parameters
$display_template : string

Display template.

Return values
mixed

set_formats()

Sets allowed file formats.

protected final set_formats(array<string|int, mixed> $formats) : mixed
Parameters
$formats : array<string|int, mixed>

File formats.

Return values
mixed

set_meta()

Sets class meta values.

protected final static set_meta(array<string|int, mixed> $meta) : mixed
Parameters
$meta : array<string|int, mixed>

Meta values.

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