TooltipTextSettingsGroup
extends SettingsGroup
in package
Class defining the tooltip position settings.
Tags
Table of Contents
- FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER = array('key' => 'footnotes_inputfield_tooltip_excerpt_delimiter', 'name' => 'Delimiter for Dedicated Tooltip Text', 'description' => 'Tooltips can display another content than the footnote entry in the reference container. The trigger is a shortcode in the footnote text separating the tooltip text from the note. That is consistent with what WordPress does for excerpts. If the delimiter shortcode is present, the tooltip text will be the part before it.', 'default_value' => '[[/tooltip]]', 'type' => 'string', 'input_type' => 'text')
- Settings container key to configure the tooltip excerpt delimiter.
- FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE = array('key' => 'footnotes_inputfield_tooltip_excerpt_mirror_enable', 'name' => 'Mirror the Tooltip in the Reference Container', 'description' => 'Tooltips may be harder to use on mobiles. This option allows to read it in the reference container. Tooltips, even jQuery-driven, may be hard to consult on mobiles. This option allows to read the tooltip content in the reference container too.', 'default_value' => 'false', 'type' => 'boolean', 'input_type' => 'checkbox')
- Settings container key to enable mirroring the tooltip excerpt in the reference container.
- FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR = array('key' => 'footnotes_inputfield_tooltip_excerpt_mirror_separator', 'name' => 'Separator Between Tooltip Text and Footnote Text', 'description' => 'May be a simple space, or a line break <br />, or any string in your language.', 'default_value' => ' — ', 'type' => 'string', 'input_type' => 'text')
- Settings container key to configure the tooltip excerpt separator in the reference container.
- GROUP_ID = 'tooltip-text'
- Setting group ID.
- GROUP_NAME = 'Tooltip Text'
- 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>
- get_setting() : Setting|null
- get_setting_value() : mixed
- set_setting_value() : bool
- 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_TOOLTIP_EXCERPT_DELIMITER
Settings container key to configure the tooltip excerpt delimiter.
public
array<string|int, mixed>
FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER
= array('key' => 'footnotes_inputfield_tooltip_excerpt_delimiter', 'name' => 'Delimiter for Dedicated Tooltip Text', 'description' => 'Tooltips can display another content than the footnote entry in the reference container. The trigger is a shortcode in the footnote text separating the tooltip text from the note. That is consistent with what WordPress does for excerpts. If the delimiter shortcode is present, the tooltip text will be the part before it.', 'default_value' => '[[/tooltip]]', 'type' => 'string', 'input_type' => 'text')
The first implementation used a fixed shortcode provided in the changelog, but footnotes should have freely-configurable shortcodes.
Tooltips can display another content than the footnote entry in the reference container. The trigger is a shortcode in the footnote text separating the tooltip text from the note. That is consistent with what WordPress does for excerpts.
Tags
FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE
Settings container key to enable mirroring the tooltip excerpt in the reference container.
public
array<string|int, mixed>
FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE
= array('key' => 'footnotes_inputfield_tooltip_excerpt_mirror_enable', 'name' => 'Mirror the Tooltip in the Reference Container', 'description' => 'Tooltips may be harder to use on mobiles. This option allows to read it in the reference container. Tooltips, even jQuery-driven, may be hard to consult on mobiles. This option allows to read the tooltip content in the reference container too.', 'default_value' => 'false', 'type' => 'boolean', 'input_type' => 'checkbox')
Tooltips, even jQuery-driven, may be hard to consult on mobiles. This option allows users to read the tooltip content in the reference container too. See here for more information, and here for why this must not be the default behavior.
Tags
FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR
Settings container key to configure the tooltip excerpt separator in the reference container.
public
array<string|int, mixed>
FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR
= array('key' => 'footnotes_inputfield_tooltip_excerpt_mirror_separator', 'name' => 'Separator Between Tooltip Text and Footnote Text', 'description' => 'May be a simple space, or a line break <br />, or any string in your language.', 'default_value' => ' — ', 'type' => 'string', 'input_type' => 'text')
Tags
GROUP_ID
Setting group ID.
public
string
GROUP_ID
= 'tooltip-text'
Tags
GROUP_NAME
Setting group name.
public
string
GROUP_NAME
= 'Tooltip Text'
Tags
Properties
$options_group_slug
Setting options group slug.
protected
string
$options_group_slug
Tags
$section_slug
Setting section slug.
protected
string
$section_slug
Tags
$setting_classes
The setting classes.
protected
array<string|int, mixed>
$setting_classes
Tags
$settings
The settings in this group.
protected
array<string|int, mixed>
$settings
Tags
$settings_obj
The plugin settings object.
protected
Settings
$settings_obj
Tags
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
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
Return values
void —get_options()
public
get_options() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —get_setting()
public
get_setting(string $setting_key) : Setting|null
Parameters
- $setting_key : string
Tags
Return values
Setting|null —get_setting_value()
public
get_setting_value(string $setting_key) : mixed
Parameters
- $setting_key : string
Tags
Return values
mixed —set_setting_value()
public
set_setting_value(string $setting_key, mixed $value) : bool
Parameters
- $setting_key : string
- $value : mixed
Tags
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
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
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
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.