SLP® phpDocs

SLP_Settings_manage_locations_table extends SLP_Setting
in package

Responsible for managing and displaying the locations table in the settings interface.

Table of Contents

Properties

$addon  : object
$allowed_tags  : array<string|int, object>
$custom  : mixed
$data_field  : mixed
$description  : mixed
$disabled  : mixed
$display_value  : mixed
$id  : mixed
$label  : mixed
$myslp  : MySLP
$name  : mixed
$onChange  : mixed
$placeholder  : mixed
$related_to  : mixed
$show_label  : mixed
$slplus  : SLPlus
$type  : mixed
$uses_myslp  : bool
$uses_slplus  : bool
$value  : mixed
$vue  : mixed
$wrapper  : mixed
$attributes  : mixed
$classes  : mixed
$content  : mixed
$data  : mixed
$slug  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
display()  : void
Render the setting using the content from your override get_content().
extend_vars_for_react()  : array<string|int, mixed>
Add locations table variables to the React bootstrap data.
filter_safe_style_css_for_admin()  : array<string|int, mixed>
Allow all inline CSS on the admin tabs.
filter_wp_kses_allowed_admin_tags()  : mixed
Tell KSES these tags are allowed on our admin settings pages so wpcs does not freak out.
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
render_description()  : mixed
Render the description if needed.
set_properties()  : void
Set our properties.
at_startup()  : mixed
Override this in your class to do things at startup after we are initialized. Optional.
get_attribute_string()  : string
Create the HTML attribute string by joining the attributes array.
get_classes_string()  : string
Create the HTML classes string by joining the classes array.
get_content()  : string
Get the content to be displayed. Override to generate the custom content for your setting.
get_data_string()  : string
Create the HTML data string by joining the data array.
initialize()  : mixed
Initialize.
render_label()  : mixed
Render the label if needed.
set_display_value()  : mixed
Set the display value
wrap_in_default_html()  : mixed
Wrap our HTML in default divs.
get_bulk_actions_for_react()  : array<string|int, mixed>
Build the bulk action list for the React locations table header.
get_current_filter_action()  : string
Get the current active manage locations filter action.
get_filter_values_for_react()  : array<string|int, mixed>
Get active filter field values for the React location filter drawer.
get_filters_for_react()  : array<string|int, mixed>
Build the location filters list for the React locations table header.
get_search_for_react()  : string
Get the current search string for the React locations table header.
locations_are_available()  : bool
True when the current table query has locations available for row actions.
locations_exist()  : bool
True when locations exist in the database, even if the current filter has no matches.
normalize_bulk_action_for_react()  : array<string|int, mixed>
Normalize legacy PHP dropdown metadata into a React-friendly action record.
normalize_filter_for_react()  : array<string|int, mixed>
Normalize legacy PHP dropdown metadata into a React-friendly filter record.
sanitize_filter_value_list()  : array<string|int, string>
Sanitize a scalar or array list of submitted filter values.

Properties

$allowed_tags

public array<string|int, object> $allowed_tags = array()

$uses_slplus

public bool $uses_slplus

Set to true (default) if the object needs access to the SLPlus plugin object.

Methods

__construct()

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

display()

Render the setting using the content from your override get_content().

public display() : void

Only override this if you do not want the standard HTML wrapper.

extend_vars_for_react()

Add locations table variables to the React bootstrap data.

public extend_vars_for_react(array<string|int, mixed> $vars) : array<string|int, mixed>
Parameters
$vars : array<string|int, mixed>

React variables.

Return values
array<string|int, mixed>

filter_safe_style_css_for_admin()

Allow all inline CSS on the admin tabs.

public filter_safe_style_css_for_admin(mixed $safe_css_array) : array<string|int, mixed>
Parameters
$safe_css_array : mixed
Return values
array<string|int, mixed>

filter_wp_kses_allowed_admin_tags()

Tell KSES these tags are allowed on our admin settings pages so wpcs does not freak out.

public filter_wp_kses_allowed_admin_tags(mixed $allowed_tags) : mixed

It does not look like there is a valid esc* or kses* method that allows echo $var when $var contains valid admin-page tags like or