BacklinkSymbolSettingsGroup
extends SettingsGroup
in package
Class defining the backlink symbol settings.
Tags
Table of Contents
- GROUP_ID = 'backlink-symbol'
- Setting group ID.
- GROUP_NAME = 'Backlink Symbol'
- Setting group name.
- HYPERLINK_ARROW = array('key' => 'footnote_inputfield_custom_hyperlink_symbol', 'name' => 'Select the Backlink Symbol', 'description' => 'This symbol is used in the reference container. But this setting pre-existed under this tab and cannot be moved to another one.', 'default_value' => 0, 'type' => 'number', 'input_type' => 'select', 'input_options' => array('↑', '↥', '↟', '↩', '↲', '↵', '⇑', '⇡', '⇧', '￪'), 'overridden_by' => self::HYPERLINK_ARROW_USER_DEFINED)
- Settings container key for the backlink symbol selection.
- HYPERLINK_ARROW_USER_DEFINED = array('key' => 'footnote_inputfield_custom_hyperlink_symbol_user', 'name' => 'Input the Backlink Symbol', 'description' => 'Your input overrides the selection.', 'type' => 'string', 'input_type' => 'text')
- Settings container key for the user-defined backlink symbol.
- $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
GROUP_ID
Setting group ID.
public
string
GROUP_ID
= 'backlink-symbol'
Tags
GROUP_NAME
Setting group name.
public
string
GROUP_NAME
= 'Backlink Symbol'
Tags
HYPERLINK_ARROW
Settings container key for the backlink symbol selection.
public
array<string|int, mixed>
HYPERLINK_ARROW
= array('key' => 'footnote_inputfield_custom_hyperlink_symbol', 'name' => 'Select the Backlink Symbol', 'description' => 'This symbol is used in the reference container. But this setting pre-existed under this tab and cannot be moved to another one.', 'default_value' => 0, 'type' => 'number', 'input_type' => 'select', 'input_options' => array('↑', '↥', '↟', '↩', '↲', '↵', '⇑', '⇡', '⇧', '￪'), 'overridden_by' => self::HYPERLINK_ARROW_USER_DEFINED)
Tags
HYPERLINK_ARROW_USER_DEFINED
Settings container key for the user-defined backlink symbol.
public
array<string|int, mixed>
HYPERLINK_ARROW_USER_DEFINED
= array('key' => 'footnote_inputfield_custom_hyperlink_symbol_user', 'name' => 'Input the Backlink Symbol', 'description' => 'Your input overrides the selection.', 'type' => 'string', 'input_type' => '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()
Creates an options group from the values of the settings in this section.
public
get_options() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —get_setting()
Retrieve a setting by its key.
public
get_setting(string $setting_key) : Setting|null
Parameters
- $setting_key : string
Tags
Return values
Setting|null —get_setting_value()
Get a setting's value by its key.
public
get_setting_value(string $setting_key) : mixed
Parameters
- $setting_key : string
Tags
Return values
mixed —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
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.