Documentation

ReferenceContainerSettingsGroup extends SettingsGroup

in package

• footnotes

Class defining the reference container settings.

Tags

since

2.8.0

Table of Contents

BACKLINKS_COLUMN_MAX_WIDTH_ENABLED  = array('key' => 'footnotes_inputfield_backlinks_column_max_width_enabled', 'name' => 'Set Backlinks Column Max. Width', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable a max width for the backlinks column.

BACKLINKS_COLUMN_MAX_WIDTH_SCALAR  = array('key' => 'footnotes_inputfield_backlinks_column_max_width_scalar', 'name' => 'Backlinks Column Width', 'default_value' => 140, 'type' => 'number', 'input_type' => 'number', 'input_max' => 500, 'input_min' => 0, 'enabled_by' => self::BACKLINKS_COLUMN_MAX_WIDTH_ENABLED)

Settings container key for the backlinks column max width scalar.

BACKLINKS_COLUMN_MAX_WIDTH_UNIT  = array('key' => 'footnotes_inputfield_backlinks_column_max_width_unit', 'name' => 'Backlinks Column Width Unit', 'description' => 'Absolute width in pixels doesn't need to be accurate to the tenth, but relative width in `rem` or `em` may.', 'default_value' => 'px', 'type' => 'string', 'input_type' => 'select', 'input_options' => ootnotesincludessettingsSetting::WIDTH_UNIT_OPTIONS, 'enabled_by' => self::BACKLINKS_COLUMN_MAX_WIDTH_ENABLED)

Settings container key for the backlinks column max width unit.

BACKLINKS_COLUMN_WIDTH_ENABLED  = array('key' => 'footnotes_inputfield_backlinks_column_width_enabled', 'name' => 'Set Backlinks Column Width', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable the backlinks column width.

BACKLINKS_COLUMN_WIDTH_SCALAR  = array('key' => 'footnotes_inputfield_backlinks_column_width_scalar', 'name' => 'Backlinks Column Width', 'default_value' => 50, 'type' => 'number', 'input_type' => 'number', 'input_max' => 500, 'input_min' => 0, 'enabled_by' => self::BACKLINKS_COLUMN_WIDTH_ENABLED)

Settings container key for the backlinks column width scalar.

BACKLINKS_COLUMN_WIDTH_UNIT  = array('key' => 'footnotes_inputfield_backlinks_column_width_unit', 'name' => 'Backlinks Column Width Unit', 'description' => 'Absolute width in pixels doesn't need to be accurate to the tenth, but relative width in `rem` or `em` may.', 'default_value' => 'px', 'type' => 'string', 'input_type' => 'select', 'input_options' => ootnotesincludessettingsSetting::WIDTH_UNIT_OPTIONS, 'enabled_by' => self::BACKLINKS_COLUMN_WIDTH_ENABLED)

Settings container key for the backlinks column width unit.

BACKLINKS_LINE_BREAKS_ENABLED  = array('key' => 'footnotes_inputfield_backlinks_line_breaks_enabled', 'name' => 'Stack Backlinks When Enumerating', 'description' => 'This option adds a line break before each added backlink when identical footnotes are combined.', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable line breaks between backlinks.

BACKLINKS_SEPARATOR_CUSTOM  = array('key' => 'footnotes_inputfield_backlinks_separator_custom', 'name' => 'Custom Backlink Separator Symbol', 'description' => 'Your input overrides the selection.', 'type' => 'string', 'input_type' => 'text', 'enabled_by' => self::BACKLINKS_SEPARATOR_ENABLED)

Settings container key for a custom backlink separator.

BACKLINKS_SEPARATOR_ENABLED  = array('key' => 'footnotes_inputfield_backlinks_separator_enabled', 'name' => 'Add a Separator When Enumerating Backlinks', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable the presence of a backlink separator.

BACKLINKS_SEPARATOR_OPTION  = array('key' => 'footnotes_inputfield_backlinks_separator_option', 'name' => 'Backlink Separator Symbol', 'default_value' => 'comma', 'type' => 'string', 'input_type' => 'select', 'input_options' => array( // Unicode character names are conventionally uppercase. 'comma' => ',', 'semicolon' => ';', 'en_dash' => '–', ), 'enabled_by' => self::BACKLINKS_SEPARATOR_ENABLED, 'overridden_by' => self::BACKLINKS_SEPARATOR_CUSTOM)

Settings container key for the backlink separator options.

BACKLINKS_TERMINATOR_CUSTOM  = array('key' => 'footnotes_inputfield_backlinks_terminator_custom', 'name' => 'Custom Backlink Terminator Symbol', 'description' => 'Your input overrides the selection.', 'type' => 'string', 'input_type' => 'text', 'enabled_by' => self::BACKLINKS_TERMINATOR_ENABLED)

Settings container key for a custom backlink terminator.

BACKLINKS_TERMINATOR_ENABLED  = array('key' => 'footnotes_inputfield_backlinks_terminator_enabled', 'name' => 'Add a Terminal Punctuation to Backlinks', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable the presence of a backlink terminator.

BACKLINKS_TERMINATOR_OPTION  = array('key' => 'footnotes_inputfield_backlinks_terminator_option', 'name' => 'Backlink Terminator Symbol', 'default_value' => 'period', 'type' => 'string', 'input_type' => 'select', 'input_options' => array( 'period' => '.', // Unicode 1.0 name of RIGHT PARENTHESIS (represented as a left parenthesis in right-to-left scripts). 'parenthesis' => ')', 'colon' => ':', ), 'enabled_by' => self::BACKLINKS_TERMINATOR_ENABLED, 'overridden_by' => self::BACKLINKS_TERMINATOR_CUSTOM)

Settings container key for the backlink terminator options.

FOOTNOTE_SECTION_SHORTCODE  = array('key' => 'footnotes_inputfield_section_shortcode', 'name' => 'Footnote Section Shortcode', 'description' => 'If present in the content, any shortcode in this text box will delimit a section terminated by a reference container.', 'default_value' => '[[/footnotesection]]', 'type' => 'string', 'input_type' => 'text')

Settings container key for the footnote section shortcode.

FOOTNOTE_URL_WRAP_ENABLED  = array('key' => 'footnote_inputfield_url_wrap_enabled', 'name' => 'Allow URLs to Line-Wrap Anywhere', 'description' => 'Unicode-conformant browsers don't need this fix.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key for URL wrap option.

FOOTNOTES_PAGE_LAYOUT_SUPPORT  = array('key' => 'footnotes_inputfield_page_layout_support', 'name' => 'Apply Basic Responsive Page Layout', 'description' => 'Most themes don't need this fix.', 'default_value' => 'none', 'type' => 'string', 'input_type' => 'select', 'input_options' => array('none' => 'No', 'reference-container' => 'to the reference container exclusively', 'entry-content' => 'to the div element starting below the post title', 'main-content' => 'to the main element including the post title'))

Settings container key for basic responsive page layout support options.

FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE  = array('key' => 'footnotes_inputfield_reference_container_script_mode', 'name' => 'Script Mode', 'description' => 'The plain JavaScript mode will enable hard links with configurable scroll offset.', 'default_value' => 'jquery', 'type' => 'string', 'input_type' => 'select', 'input_options' => array('jquery' => 'jQuery', 'js' => 'plain JavaScript'))

Settings container key to select the script mode for the reference container.

GROUP_ID  = 'reference-container'

Setting group ID.

GROUP_NAME  = 'Reference Container'

Setting group name.

LINK_ELEMENT_ENABLED  = array('key' => 'footnote_inputfield_link_element_enabled', 'name' => 'Use the Link Element for Referrers and Backlinks', 'description' => 'The link element is needed to apply the theme's link color. If the link element is not desired for styling, a simple span is used instead when the above is unchecked.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key for the link element option.

REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE  = array('key' => 'footnotes_inputfield_reference_container_3column_layout_enable', 'name' => 'Backlink Symbol in an Extra Column', 'description' => 'This legacy layout is available if identical footnotes are not combined.', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable the legacy layout of the reference container.

REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE  = array('key' => 'footnotes_inputfield_reference_container_backlink_symbol_enable', 'name' => 'Display a Backlink Symbol', 'description' => 'Please choose or input the symbol at the top of the next dashboard tab.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable the display of a backlink symbol.

REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH  = array('key' => 'footnotes_inputfield_reference_container_backlink_symbol_switch', 'name' => 'Append Instead of Prepend Symbol', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to get the backlink symbol switch side.

REFERENCE_CONTAINER_BOTTOM_MARGIN  = array('key' => 'footnotes_inputfield_reference_container_bottom_margin', 'name' => 'Bottom Margin', 'description' => 'pixels; may be negative', 'default_value' => 0, 'type' => 'integer', 'input_type' => 'number', 'input_max' => 500, 'input_min' => -500)

Settings container key for reference container bottom margin.

REFERENCE_CONTAINER_COLLAPSE  = array('key' => 'footnote_inputfield_collapse_references', 'name' => 'Collapse by Default', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to collapse the reference container by default.

REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER  = array('key' => 'footnotes_inputfield_reference_container_label_bottom_border', 'name' => 'Border Under the Heading', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable the reference container label bottom border.

REFERENCE_CONTAINER_LABEL_ELEMENT  = array('key' => 'footnote_inputfield_references_label', 'name' => 'Heading's HTML Element', 'default_value' => 'p', 'type' => 'string', 'input_type' => 'select', 'input_options' => ootnotesincludessettingsSetting::TEXT_ELEMENT_OPTIONS)

Settings container key for the reference container label element.

REFERENCE_CONTAINER_NAME  = array('key' => 'footnote_inputfield_references_label', 'name' => 'Reference Container Title', 'default_value' => 'References', 'type' => 'string', 'input_type' => 'text')

Settings container key for the label of the reference container.

REFERENCE_CONTAINER_POSITION  = array('key' => 'footnote_inputfield_reference_container_place', 'name' => 'Container Position', 'description' => 'Where the container should be placed on the page. To use the position or section shortcode, please set the position to: at the end of the post', 'default_value' => 'post_end', 'type' => 'string', 'input_type' => 'select', 'input_options' => array('post_end' => 'at the end of the post', 'widget' => 'in the widget area', 'footer' => 'in the footer'))

Settings container key for the position of the reference container.

REFERENCE_CONTAINER_POSITION_SHORTCODE  = array('key' => 'footnote_inputfield_reference_container_position_shortcode', 'name' => 'Position Shortcode', 'description' => 'If present in the content, any shortcode in this text box will be replaced with the reference container.', 'default_value' => '[[references]]', 'type' => 'string', 'input_type' => 'text')

Settings container key for reference container position shortcode.

REFERENCE_CONTAINER_ROW_BORDERS_ENABLE  = array('key' => 'footnotes_inputfield_reference_container_row_borders_enable', 'name' => 'Borders Around the Table Rows', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable reference container table row borders.

REFERENCE_CONTAINER_START_PAGE_ENABLE  = array('key' => 'footnotes_inputfield_reference_container_start_page_enable', 'name' => 'Display on Start Page Too', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to not display the reference container on the homepage.

REFERENCE_CONTAINER_TOP_MARGIN  = array('key' => 'footnotes_inputfield_reference_container_top_margin', 'name' => 'Top Margin', 'description' => 'pixels; may be negative', 'default_value' => 24, 'type' => 'integer', 'input_type' => 'number', 'input_max' => 500, 'input_min' => -500)

Settings container key for reference container top margin.

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