Documentation

TooltipsSettingsGroup extends SettingsGroup
in package

Class defining the tooltip settings.

Tags
since
2.8.0

Table of Contents

FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE  = array('key' => 'footnote_inputfield_custom_mouse_over_box_alternative', 'name' => 'Display Alternative Tooltips', 'description' => 'Intended to work around a configuration-related tooltip outage. These alternative tooltips work around a website related jQuery UI outage. They are low-script but use the AMP incompatible onmouseover and onmouseout arguments, along with CSS transitions for fade-in/out. The very small script is inserted after Footnotes' internal stylesheet. When this option is enabled, footnotes does not load jQuery UI nor jQuery Tools.', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')
Settings container key to enable the alternative tooltips.
FOOTNOTES_MOUSE_OVER_BOX_ENABLED  = array('key' => 'footnote_inputfield_custom_mouse_over_box_enabled', 'name' => 'Display Tooltips', 'description' => 'Formatted text boxes allowing hyperlinks, displayed on mouse-over or tap and hold.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')
Settings container key to enable the mouse-over box.
GROUP_ID  = 'tooltips'
Setting group ID.
GROUP_NAME  = 'Tooltips'
Setting group name.
$options_group_slug  : string
Setting options group slug.
$section_slug  : string
Setting section slug.
$setting_classes  : array<string|int, mixed>
The setting classes.
$settings  : array<string|int, mixed>
The settings in this group.
$settings_obj  : Settings
The plugin settings object.
__construct()  : mixed
Constructs the settings section.
add_settings_fields()  : void
Adds all the settings fields for this group to the admin. dashboard.
get_options()  : array<string|int, mixed>
Creates an options group from the values of the settings in this section.
get_setting()  : Setting|null
Retrieve a setting by its key.
get_setting_value()  : mixed
Get a setting's value by its key.
set_setting_value()  : bool
Set a setting's value by its key.
add_setting()  : Setting
Constructs settings from the provided details.
add_settings()  : void
Add the settings for this settings group.
load_dependencies()  : void
Load the required dependencies.
load_values()  : void
Load the values for this settings group.

Constants

FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE

Settings container key to enable the alternative tooltips.

public array<string|int, mixed> FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE = array('key' => 'footnote_inputfield_custom_mouse_over_box_alternative', 'name' => 'Display Alternative Tooltips', 'description' => 'Intended to work around a configuration-related tooltip outage. These alternative tooltips work around a website related jQuery UI outage. They are low-script but use the AMP incompatible onmouseover and onmouseout arguments, along with CSS transitions for fade-in/out. The very small script is inserted after Footnotes' internal stylesheet. When this option is enabled, footnotes does not load jQuery&nbsp;UI nor jQuery&nbsp;Tools.', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

These alternative tooltips work around a website-related jQuery UI outage. They are low-script but use the AMP-incompatible onmouseover and onmouseout arguments, along with CSS transitions for fade-in/out. The very small script is inserted after the plugin's internal stylesheet.

Tags
since
2.1.1
since
2.8.0

Move from Settings to ReferenceContainerSettingsGroup. Convert from string to array. Convert setting data type from string to boolean.

FOOTNOTES_MOUSE_OVER_BOX_ENABLED

Settings container key to enable the mouse-over box.

public array<string|int, mixed> FOOTNOTES_MOUSE_OVER_BOX_ENABLED = array('key' => 'footnote_inputfield_custom_mouse_over_box_enabled', 'name' => 'Display Tooltips', 'description' => 'Formatted text boxes allowing hyperlinks, displayed on mouse-over or tap and hold.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')
Tags
since
1.5.2
since
2.8.0

Move from Settings to ReferenceContainerSettingsGroup. Convert from string to array. Convert setting data type from string to boolean.

Properties

$options_group_slug

Setting options group slug.

protected string $options_group_slug
Tags
since
2.8.0

$setting_classes

The setting classes.

protected array<string|int, mixed> $setting_classes
Tags
since
2.8.0

$settings

The settings in this group.

protected array<string|int, mixed> $settings
Tags
since
2.8.0

Methods

__construct()

Constructs the settings section.

public __construct(string $options_group_slug, string $section_slug, Settings $settings_obj) : mixed
Parameters
$options_group_slug : string
$section_slug : string
$settings_obj : Settings
Tags
since
2.8.0
Return values
mixed —

add_settings_fields()

Adds all the settings fields for this group to the admin. dashboard.

public add_settings_fields(SettingsPage $component) : void
Parameters
$component : SettingsPage

The admin. dashboard settings page.

Tags
since
2.8.0
Return values
void —

set_setting_value()

Set a setting's value by its key.

public set_setting_value(string $setting_key, mixed $value) : bool
Parameters
$setting_key : string
$value : mixed
Tags
see
Settings::set_setting_value()
Return values
bool —

add_setting()

Constructs settings from the provided details.

protected add_setting(array<string, mixed> $setting) : Setting
Parameters
$setting : array<string, mixed>

The setting details.

Tags
since
2.8.0
Return values
Setting —

The constructed setting object.

add_settings()

Add the settings for this settings group.

protected add_settings(array<string|int, mixed>|false $options) : void
Parameters
$options : array<string|int, mixed>|false

Saved values for the settings in this group. 'False' if none exist.

Tags
see
SettingsGroup::add_settings()
Return values
void —

load_dependencies()

Load the required dependencies.

protected load_dependencies() : void

Include the following files that provide the settings for this plugin:

  • Setting: defines individual settings.
Tags
since
2.8.0
Return values
void —

load_values()

Load the values for this settings group.

protected load_values(array<string, mixed>|false $options) : void
Parameters
$options : array<string, mixed>|false

Saved values for the settings in this group. 'False' if none exist.

Tags
since
2.8.0
todo

Remove settings from options group when not found.

Return values
void —

Search results