Documentation

TooltipTextSettingsGroup extends SettingsGroup
in package

Class defining the tooltip position settings.

Tags
since
2.8.0

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>
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_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
since
2.5.4
since
2.8.0

Move from Settings to ReferenceContainerSettingsGroup. Convert from string to array.

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
since
2.5.4
since
2.8.0

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

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 &lt;br /&gt;, or any string in your language.', 'default_value' => ' — ', 'type' => 'string', 'input_type' => 'text')
Tags
since
2.5.4
since
2.8.0

Move from Settings to ReferenceContainerSettingsGroup. Convert from string to array.

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