Documentation

HardLinksSettingsGroup extends SettingsGroup

in package

• footnotes

Class defining the hard links settings.

Tags

since

2.8.0

Table of Contents

FOOTNOTE_FRAGMENT_ID_SLUG  = array('key' => 'footnotes_inputfield_footnote_fragment_id_slug', 'name' => 'Fragment Identifier Slug for Footnotes', 'description' => 'This will show up in the address bar after clicking on a hard-linked footnote referrer.', 'default_value' => 'f', 'type' => 'string', 'input_type' => 'text')

Settings container key for the fragment ID slug in footnotes.

FOOTNOTES_BACKLINK_TOOLTIP_ENABLE  = array('key' => 'footnotes_inputfield_backlink_tooltip_enable', 'name' => 'Enable Backlink Tooltips', 'description' => 'Hard backlinks get ordinary tooltips hinting to use the backbutton instead to keep it usable.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable backlink tooltips.

FOOTNOTES_BACKLINK_TOOLTIP_TEXT  = array('key' => 'footnotes_inputfield_backlink_tooltip_text', 'name' => 'Backlink Tooltip Text', 'description' => 'Default text is the keyboard shortcut; may be a localized descriptive hint.', 'default_value' => 'Alt + ←', 'type' => 'string', 'input_type' => 'text')

Settings container key to configure the backlink tooltip.

FOOTNOTES_HARD_LINKS_ENABLE  = array('key' => 'footnotes_inputfield_hard_links_enable', 'name' => 'Enable Hard Links', 'description' => 'Hard links disable jQuery delays but have the same scroll offset, and allow to share footnotes (accessed if the list is not collapsed by default).', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable hard links.

GROUP_ID  = 'hard-links'

Setting group ID.

GROUP_NAME  = 'URL Fragment ID Configuration'

Setting group name.

HARD_LINK_IDS_SEPARATOR  = array('key' => 'footnotes_inputfield_hard_link_ids_separator', 'name' => 'ID Separator', 'description' => 'May be empty or any string, for example _, - or +, to distinguish post number, container number and footnote number.', 'default_value' => '+', 'type' => 'string', 'input_type' => 'text')

Settings container key for the ID separator in fragment IDs.

REFERRER_FRAGMENT_ID_SLUG  = array('key' => 'footnotes_inputfield_referrer_fragment_id_slug', 'name' => 'Fragment Identifier Slug for Footnote Referrers', 'description' => 'This will show up in the address bar after clicking on a hard-linked backlink.', 'default_value' => 'r', 'type' => 'string', 'input_type' => 'text')

Settings container key for the fragment ID slug in referrers.

$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.