Filter_Settings
Translate PTP builder filter settings at the save, editor and shortcode boundaries.
Tags
Table of Contents
- display() : array<string|int, mixed>
- Normalize checkbox lists and keyed location flags.
- enabled() : bool
- Determine the saved decision without promoting an explicit off value.
- for_editor() : array<string|int, mixed>
- Show off without deleting the remembered selection or writing the database.
- normalize() : array<string|int, mixed>
- Normalize only supplied filter fields. Omitted fields keep their saved values.
- runtime() : array<string|int, mixed>
- Respect explicit shortcode decisions and locations after the shared merge.
Methods
display()
Normalize checkbox lists and keyed location flags.
public
static display(mixed $value) : array<string|int, mixed>
Parameters
- $value : mixed
-
Stored or submitted locations.
Tags
Return values
array<string|int, mixed> —enabled()
Determine the saved decision without promoting an explicit off value.
public
static enabled(array<string|int, mixed> $settings) : bool
Parameters
- $settings : array<string|int, mixed>
-
Stored settings.
Tags
Return values
bool —for_editor()
Show off without deleting the remembered selection or writing the database.
public
static for_editor(array<string|int, mixed> $settings) : array<string|int, mixed>
Parameters
- $settings : array<string|int, mixed>
-
Stored settings.
Tags
Return values
array<string|int, mixed> —normalize()
Normalize only supplied filter fields. Omitted fields keep their saved values.
public
static normalize(array<string|int, mixed> $submitted[, array<string|int, mixed> $previous = [] ]) : array<string|int, mixed>
Parameters
- $submitted : array<string|int, mixed>
-
Original submitted fields after sanitization.
- $previous : array<string|int, mixed> = []
-
Stored settings.
Tags
Return values
array<string|int, mixed> —Normalized submitted fields.
runtime()
Respect explicit shortcode decisions and locations after the shared merge.
public
static runtime(array<string|int, mixed> $args, array<string|int, mixed> $settings, array<string|int, mixed> $attributes) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Merged arguments.
- $settings : array<string|int, mixed>
-
Stored settings.
- $attributes : array<string|int, mixed>
-
Explicit attributes.