SLPWidget_cities
extends WP_Widget_SLPExp
in package
Class SLPWidget_cities
Display the Store Locator Plus state drop down followed by cities. Forwards the user to a specified page that has the pslplus] shortcode on it.
Tags
Table of Contents
Properties
- $addon : mixed
- $control_options : mixed
- $description_admin : string
- $settings : array<string|int, SLP_Widget_Setting>
- $slplus : SLPlus
- $slug : string
- $title_admin : string
- $title_ui : string
- $ui : SLPWidget_states_UI
- $ui_class_name : string
Methods
- __construct() : mixed
- Creates a widget and registers it with WordPress.
- configure_widget_properties() : mixed
- Set the properties for this widget.
- create_string_docs_link() : string
- Create a hypertext link to the widget pack support docs.
- create_string_widget_checkbox() : string
- Generates an HTML string for a checkbox widget with a label.
- create_string_widget_input() : string
- Creates an HTML string for a text input widget.
- create_ui_object() : mixed
- Create and attach the UI object for this widget
- form() : mixed
- Render the admin interface widget form.
- update() : array<string|int, mixed>
- Sanitize widget form values as they are saved.
- widget() : mixed
- Front-end display of widget.
- configure_widget_settings() : mixed
- Configure the settings for this particular widget.
Properties
$addon
public
mixed
$addon
$control_options
public
mixed
$control_options
= array()
$description_admin
public
string
$description_admin
The description to go on the admin UI widget box.
$settings
public
array<string|int, SLP_Widget_Setting>
$settings
The settings for a widget instance.
$slplus
public
SLPlus
$slplus
The Store Locator Plus plugin.
$slug
public
string
$slug
The slug for this widget.
$title_admin
public
string
$title_admin
The title to go on the admin UI widget box.
$title_ui
public
string
$title_ui
The default title for the front-end UI widget box.
$ui
public
SLPWidget_states_UI
$ui
The invoked UI class object.
$ui_class_name
public
string
$ui_class_name
Class name for this widget's UI class.
Methods
__construct()
Creates a widget and registers it with WordPress.
public
__construct() : mixed
configure_widget_properties()
Set the properties for this widget.
public
configure_widget_properties() : mixed
create_string_docs_link()
Create a hypertext link to the widget pack support docs.
public
create_string_docs_link() : string
Return values
stringcreate_string_widget_checkbox()
Generates an HTML string for a checkbox widget with a label.
public
create_string_widget_checkbox(string $field_slug, string $label, bool $value) : string
Parameters
- $field_slug : string
-
The slug identifier for the field.
- $label : string
-
The text label associated with the checkbox.
- $value : bool
-
The current value of the checkbox, where true indicates checked.
Return values
string —The generated HTML for the checkbox widget with its label.
create_string_widget_input()
Creates an HTML string for a text input widget.
public
create_string_widget_input(string $field_slug, string $label, string $value) : string
Parameters
- $field_slug : string
-
The unique identifier for the input field.
- $label : string
-
The label text for the input field.
- $value : string
-
The value to populate the input field with.
Return values
string —The HTML string for the text input widget.
create_ui_object()
Create and attach the UI object for this widget
public
create_ui_object([string $slug = null ]) : mixed
Parameters
- $slug : string = null
form()
Render the admin interface widget form.
public
form(array<string|int, mixed> $instance) : mixed
Parameters
- $instance : array<string|int, mixed>
update()
Sanitize widget form values as they are saved.
public
update(array<string|int, mixed> $new_instance, array<string|int, mixed> $old_instance) : array<string|int, mixed>
Parameters
- $new_instance : array<string|int, mixed>
-
Values just sent to be saved.
- $old_instance : array<string|int, mixed>
-
Previously saved values from database.
Tags
Return values
array<string|int, mixed> —Updated safe values to be saved.
widget()
Front-end display of widget.
public
widget(array<string|int, mixed> $args, array<string|int, mixed> $instance) : mixed
Parameters
- $args : array<string|int, mixed>
-
Widget arguments.
- $instance : array<string|int, mixed>
-
Saved values from database.
Tags
configure_widget_settings()
Configure the settings for this particular widget.
protected
configure_widget_settings() : mixed