Documentation

TooltipAppearanceSettingsGroup extends SettingsGroup
in package

Class defining the tooltip appearance settings.

Tags
since
2.8.0

Table of Contents

FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND  = array('key' => 'footnote_inputfield_custom_mouse_over_box_background', 'name' => 'Background Color', 'description' => 'To use the current theme's default background color, clear or leave empty', 'default_value' => '#ffffff', 'type' => 'string', 'input_type' => 'color')
Settings container key for the mouse-over box to define the background color.
FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR  = array('key' => 'footnote_inputfield_custom_mouse_over_box_border_color', 'name' => 'Border Color', 'description' => 'To use the current theme's default border color, clear or leave empty', 'default_value' => '#ffffff', 'type' => 'string', 'input_type' => 'color')
Settings container key for the mouse-over box to define the border color.
FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS  = array('key' => 'footnote_inputfield_custom_mouse_over_box_border_radius', 'name' => 'Rounded Corner Radius', 'description' => 'pixels; 0 for sharp corners', 'default_value' => 0, 'type' => 'number', 'input_type' => 'number', 'input_max' => 500, 'input_min' => 0)
Settings container key for the mouse-over box to define the border radius.
FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH  = array('key' => 'footnote_inputfield_custom_mouse_over_box_border_width', 'name' => 'Border Width', 'description' => 'pixels; 0 for borderless', 'default_value' => 1.0, 'type' => 'number', 'input_type' => 'number', 'input_max' => 4.0, 'input_min' => 0.0)
Settings container key for the mouse-over box to define the border width.
FOOTNOTES_MOUSE_OVER_BOX_COLOR  = array('key' => 'footnote_inputfield_custom_mouse_over_box_color', 'name' => 'Text Color', 'description' => 'To use the current theme's default text color, clear or leave empty', 'default_value' => '#000000', 'type' => 'string', 'input_type' => 'color')
Settings container key for the mouse-over box to define the color.
FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR  = array('key' => 'footnote_inputfield_custom_mouse_over_box_shadow_color', 'name' => 'Box Shadow Color', 'description' => 'To use the current theme's default box shadow color, clear or leave empty', 'default_value' => '#666666', 'type' => 'string', 'input_type' => 'color')
Settings container key for the mouse-over box to define the box-shadow color.
GROUP_ID  = 'tooltip-appearance'
Setting group ID.
GROUP_NAME  = 'Tooltip Appearance'
Setting group name.
MOUSE_OVER_BOX_FONT_SIZE_ENABLED  = array('key' => 'footnotes_inputfield_mouse_over_box_font_size_enabled', 'name' => 'Set Font Size', 'description' => '', 'default_value' => '', 'type' => 'boolean', 'input_type' => 'checkbox')
Settings container key to enable setting the tooltip font size.
MOUSE_OVER_BOX_FONT_SIZE_SCALAR  = array('key' => 'footnotes_inputfield_mouse_over_box_font_size_scalar', 'name' => 'Font Size', 'description' => 'By default, the font size is set to equal the surrounding text.', 'default_value' => 13.0, 'type' => 'number', 'input_type' => 'number', 'input_max' => 50.0, 'input_min' => 0.0)
Settings container key for the scalar value of the tooltip font size.
MOUSE_OVER_BOX_FONT_SIZE_UNIT  = array('key' => 'footnotes_inputfield_mouse_over_box_font_size_unit', 'name' => 'Font Size Unit', 'default_value' => 'px', 'type' => 'string', 'input_type' => 'select', 'input_options' => ootnotesincludessettingsSetting::FONT_SIZE_UNIT_OPTIONS)
Settings container key for the unit of the tooltip font size.
$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_BACKGROUND

Settings container key for the mouse-over box to define the background color.

public array<string|int, mixed> FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND = array('key' => 'footnote_inputfield_custom_mouse_over_box_background', 'name' => 'Background Color', 'description' => 'To use the current theme's default background color, clear or leave empty', 'default_value' => '#ffffff', 'type' => 'string', 'input_type' => 'color')

Theme default background color is best, but theme default background color doesn't seem to exist.

The default is currently #ffffff with #000000 as the text color.

Tags
since
1.5.6
since
2.8.0

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

FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR

Settings container key for the mouse-over box to define the border color.

public array<string|int, mixed> FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR = array('key' => 'footnote_inputfield_custom_mouse_over_box_border_color', 'name' => 'Border Color', 'description' => 'To use the current theme's default border color, clear or leave empty', 'default_value' => '#ffffff', 'type' => 'string', 'input_type' => 'color')
Tags
since
1.5.6
since
2.8.0

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

FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS

Settings container key for the mouse-over box to define the border radius.

public array<string|int, mixed> FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS = array('key' => 'footnote_inputfield_custom_mouse_over_box_border_radius', 'name' => 'Rounded Corner Radius', 'description' => 'pixels; 0 for sharp corners', 'default_value' => 0, 'type' => 'number', 'input_type' => 'number', 'input_max' => 500, 'input_min' => 0)
Tags
since
1.5.6
since
2.8.0

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

FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH

Settings container key for the mouse-over box to define the border width.

public array<string|int, mixed> FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH = array('key' => 'footnote_inputfield_custom_mouse_over_box_border_width', 'name' => 'Border Width', 'description' => 'pixels; 0 for borderless', 'default_value' => 1.0, 'type' => 'number', 'input_type' => 'number', 'input_max' => 4.0, 'input_min' => 0.0)
Tags
since
1.5.6
since
2.8.0

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

FOOTNOTES_MOUSE_OVER_BOX_COLOR

Settings container key for the mouse-over box to define the color.

public array<string|int, mixed> FOOTNOTES_MOUSE_OVER_BOX_COLOR = array('key' => 'footnote_inputfield_custom_mouse_over_box_color', 'name' => 'Text Color', 'description' => 'To use the current theme's default text color, clear or leave empty', 'default_value' => '#000000', 'type' => 'string', 'input_type' => 'color')
Tags
since
1.5.6
since
2.8.0

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

FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR

Settings container key for the mouse-over box to define the box-shadow color.

public array<string|int, mixed> FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR = array('key' => 'footnote_inputfield_custom_mouse_over_box_shadow_color', 'name' => 'Box Shadow Color', 'description' => 'To use the current theme's default box shadow color, clear or leave empty', 'default_value' => '#666666', 'type' => 'string', 'input_type' => 'color')
Tags
since
1.5.8
since
2.8.0

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

MOUSE_OVER_BOX_FONT_SIZE_ENABLED

Settings container key to enable setting the tooltip font size.

public array<string|int, mixed> MOUSE_OVER_BOX_FONT_SIZE_ENABLED = array('key' => 'footnotes_inputfield_mouse_over_box_font_size_enabled', 'name' => 'Set Font Size', 'description' => '', 'default_value' => '', 'type' => 'boolean', 'input_type' => 'checkbox')

Tooltip font size reset to legacy by default since 2.1.4; Was set to inherit since 2.1.1 as it overrode custom CSS, Called mouse over box not tooltip for consistency.

Tags
since
2.1.4
since
2.8.0

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

MOUSE_OVER_BOX_FONT_SIZE_SCALAR

Settings container key for the scalar value of the tooltip font size.

public array<string|int, mixed> MOUSE_OVER_BOX_FONT_SIZE_SCALAR = array('key' => 'footnotes_inputfield_mouse_over_box_font_size_scalar', 'name' => 'Font Size', 'description' => 'By default, the font size is set to equal the surrounding text.', 'default_value' => 13.0, 'type' => 'number', 'input_type' => 'number', 'input_max' => 50.0, 'input_min' => 0.0)
Tags
since
2.1.4
since
2.8.0

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

MOUSE_OVER_BOX_FONT_SIZE_UNIT

Settings container key for the unit of the tooltip font size.

public array<string|int, mixed> MOUSE_OVER_BOX_FONT_SIZE_UNIT = array('key' => 'footnotes_inputfield_mouse_over_box_font_size_unit', 'name' => 'Font Size Unit', 'default_value' => 'px', 'type' => 'string', 'input_type' => 'select', 'input_options' => ootnotesincludessettingsSetting::FONT_SIZE_UNIT_OPTIONS)
Tags
since
2.1.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