Documentation

Footnotes_Settings

Class defining configurable plugin settings.

C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR

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


    public
    float
    C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR
    = 'footnotes_inputfield_mouse_over_box_font_size_scalar'

C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR

Settings container key for the backlinks column max width scalar.


    public
    int
    C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR
    = 'footnotes_inputfield_backlinks_column_max_width_scalar'

C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR

Settings container key for the backlinks column width scalar.


    public
    int
    C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR
    = 'footnotes_inputfield_backlinks_column_width_scalar'

C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL

Settings container key for `the_content` hook priority level.


    public
    int
    C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL
    = 'footnote_inputfield_expert_lookup_the_content_priority_level'

Priority level of the_content and of widget_text as the only relevant hooks must be less than 99 because social buttons may yield scripts that contain the strings ‘((’ and ‘))’ (i.e., the default footnote start and end shortcodes), which causes issues with fake footnotes.

Setting the_content priority to 10 instead of PHP_INT_MAX makes the footnotes reference container display beneath the post and above other features added by other plugins, e.g. related post lists and social buttons.

For the YARPP plugin to display related posts below the Footnotes reference container, priority needs to be at least 1,200.

PHP_INT_MAX cannot be reset by leaving the number box empty, because WebKit browsers don't allow it, so we must resort to -1.

C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL

Settings container key for `the_excerpt` hook priority level.


    public
    int
    C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL
    = 'footnote_inputfield_expert_lookup_the_excerpt_priority_level'

C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL

Settings container key for `the_title` hook priority level.


    public
    int
    C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL
    = 'footnote_inputfield_expert_lookup_the_title_priority_level'

C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL

Settings container key for `widget_text` hook priority level.


    public
    int
    C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL
    = 'footnote_inputfield_expert_lookup_widget_text_priority_level'

C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL

Settings container key for `widget_title` hook priority level.


    public
    int
    C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL
    = 'footnote_inputfield_expert_lookup_widget_title_priority_level'

C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X

Settings container key for alternative tooltip _x_-offset.


    public
    int
    C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X
    = 'footnotes_inputfield_alternative_mouse_over_box_offset_x'

C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y

Settings container key for alternative tooltip _y_-offset.


    public
    int
    C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y
    = 'footnotes_inputfield_alternative_mouse_over_box_offset_y'

C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH

Settings container key for alternative tooltip width.


    public
    int
    C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH
    = 'footnotes_inputfield_alternative_mouse_over_box_width'

C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS

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


    public
    int
    C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS
    = 'footnote_inputfield_custom_mouse_over_box_border_radius'

C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH

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


    public
    int
    C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH
    = 'footnote_inputfield_custom_mouse_over_box_border_width'

C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH

Settings container key for the mouse-over box to define the max. length of the enabled excerpt.


    public
    int
    C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH
    = 'footnote_inputfield_custom_mouse_over_box_excerpt_length'

The default truncation length is 200 chars.

C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH

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


    public
    int
    C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH
    = 'footnote_inputfield_custom_mouse_over_box_max_width'

The width should be limited to start with, for the box to have shape.

The default width is 450.

C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X

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


    public
    int
    C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X
    = 'footnote_inputfield_custom_mouse_over_box_offset_x'

C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y

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


    public
    int
    C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y
    = 'footnote_inputfield_custom_mouse_over_box_offset_y'

The vertical offset must be negative for the box not to cover the current line of text.

C_INT_FOOTNOTES_SCROLL_DOWN_DELAY

Settings container key for scroll-down delay.


    public
    int
    C_INT_FOOTNOTES_SCROLL_DOWN_DELAY
    = 'footnotes_inputfield_scroll_down_delay'

C_INT_FOOTNOTES_SCROLL_DOWN_DURATION

Settings container key for scroll-down duration.


    public
    int
    C_INT_FOOTNOTES_SCROLL_DOWN_DURATION
    = 'footnotes_inputfield_scroll_down_duration'

C_INT_FOOTNOTES_SCROLL_DURATION

Settings container key for scroll duration.


    public
    int
    C_INT_FOOTNOTES_SCROLL_DURATION
    = 'footnotes_inputfield_scroll_duration'

C_INT_FOOTNOTES_SCROLL_OFFSET

Settings container key for scroll offset.


    public
    int
    C_INT_FOOTNOTES_SCROLL_OFFSET
    = 'footnotes_inputfield_scroll_offset'

C_INT_FOOTNOTES_SCROLL_UP_DELAY

Settings container key for scroll-up delay.


    public
    int
    C_INT_FOOTNOTES_SCROLL_UP_DELAY
    = 'footnotes_inputfield_scroll_up_delay'

C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY

Settings container key for tooltip display fade-in delay.


    public
    int
    C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY
    = 'footnotes_inputfield_mouse_over_box_fade_in_delay'

C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION

Settings container key for tooltip display fade-in duration.


    public
    int
    C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION
    = 'footnotes_inputfield_mouse_over_box_fade_in_duration'

C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY

Settings container key for tooltip display fade-out delay.


    public
    int
    C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY
    = 'footnotes_inputfield_mouse_over_box_fade_out_delay'

C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION

Settings container key for tooltip display fade-out duration.


    public
    int
    C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION
    = 'footnotes_inputfield_mouse_over_box_fade_out_duration'

C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN

Settings container key for reference container bottom margin.


    public
    int
    C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN
    = 'footnotes_inputfield_reference_container_bottom_margin'

C_INT_REFERENCE_CONTAINER_TOP_MARGIN

Settings container key for reference container top margin.


    public
    int
    C_INT_REFERENCE_CONTAINER_TOP_MARGIN
    = 'footnotes_inputfield_reference_container_top_margin'

C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED

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


    public
    string
    C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED
    = 'footnotes_inputfield_backlinks_column_max_width_enabled'

C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT

Settings container key for the backlinks column max width unit.


    public
    string
    C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT
    = 'footnotes_inputfield_backlinks_column_max_width_unit'

C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED

Settings container key to enable the backlinks column width.


    public
    string
    C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED
    = 'footnotes_inputfield_backlinks_column_width_enabled'

C_STR_BACKLINKS_COLUMN_WIDTH_UNIT

Settings container key for the backlinks column width unit.


    public
    string
    C_STR_BACKLINKS_COLUMN_WIDTH_UNIT
    = 'footnotes_inputfield_backlinks_column_width_unit'

C_STR_BACKLINKS_LINE_BREAKS_ENABLED

Settings container key to enable line breaks between backlinks.


    public
    string
    C_STR_BACKLINKS_LINE_BREAKS_ENABLED
    = 'footnotes_inputfield_backlinks_line_breaks_enabled'

C_STR_BACKLINKS_SEPARATOR_CUSTOM

Settings container key for a custom backlink separator.


    public
    string
    C_STR_BACKLINKS_SEPARATOR_CUSTOM
    = 'footnotes_inputfield_backlinks_separator_custom'

C_STR_BACKLINKS_SEPARATOR_ENABLED

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


    public
    string
    C_STR_BACKLINKS_SEPARATOR_ENABLED
    = 'footnotes_inputfield_backlinks_separator_enabled'

Backlink separators and terminators are often not preferred, but a choice should be provided along with the ability to customize.

C_STR_BACKLINKS_SEPARATOR_OPTION

Settings container key for the backlink separator options.


    public
    string
    C_STR_BACKLINKS_SEPARATOR_OPTION
    = 'footnotes_inputfield_backlinks_separator_option'

C_STR_BACKLINKS_TERMINATOR_CUSTOM

Settings container key for a custom backlink terminator.


    public
    string
    C_STR_BACKLINKS_TERMINATOR_CUSTOM
    = 'footnotes_inputfield_backlinks_terminator_custom'

C_STR_BACKLINKS_TERMINATOR_ENABLED

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


    public
    string
    C_STR_BACKLINKS_TERMINATOR_ENABLED
    = 'footnotes_inputfield_backlinks_terminator_enabled'

C_STR_BACKLINKS_TERMINATOR_OPTION

Settings container key for the backlink terminator options.


    public
    string
    C_STR_BACKLINKS_TERMINATOR_OPTION
    = 'footnotes_inputfield_backlinks_terminator_option'

C_STR_COMBINE_IDENTICAL_FOOTNOTES

Settings container key for combining identical footnotes.


    public
    string
    C_STR_COMBINE_IDENTICAL_FOOTNOTES
    = 'footnote_inputfield_combine_identical'

C_STR_CUSTOM_CSS

Settings container key for the Custom CSS.


    public
    string
    C_STR_CUSTOM_CSS
    = 'footnote_inputfield_custom_css'

C_STR_CUSTOM_CSS_LEGACY_ENABLE

Settings container key to enable display of legacy Custom CSS metaboxes.


    public
    string
    C_STR_CUSTOM_CSS_LEGACY_ENABLE
    = 'footnote_inputfield_custom_css_legacy_enable'

This must be false if its setting is contained in the container to be hidden because when saving, all missing constants are emptied, and Footnotes_Convert::to_bool() converts empty to false.

C_STR_CUSTOM_CSS_NEW

Settings container key for the Custom CSS migrated to a dedicated tab.


    public
    string
    C_STR_CUSTOM_CSS_NEW
    = 'footnote_inputfield_custom_css_new'

C_STR_EXPERT_LOOKUP_THE_CONTENT

Settings container key to enable the `the_content` hook.


    public
    string
    C_STR_EXPERT_LOOKUP_THE_CONTENT
    = 'footnote_inputfield_expert_lookup_the_content'

C_STR_EXPERT_LOOKUP_THE_EXCERPT

Settings container key to enable the `the_excerpt` hook.


    public
    string
    C_STR_EXPERT_LOOKUP_THE_EXCERPT
    = 'footnote_inputfield_expert_lookup_the_excerpt'

C_STR_EXPERT_LOOKUP_THE_TITLE

Settings container key to enable the `the_title` hook.


    public
    string
    C_STR_EXPERT_LOOKUP_THE_TITLE
    = 'footnote_inputfield_expert_lookup_the_title'

These are checkboxes; the keyword checked is converted to true, whilst an empty string (the default) is converted to false.

Hooks should all be enabled by default to prevent users from thinking at first that the feature is broken in post titles (see here for more information).

C_STR_EXPERT_LOOKUP_WIDGET_TEXT

Settings container key to enable the `widget_text` hook.


    public
    string
    C_STR_EXPERT_LOOKUP_WIDGET_TEXT
    = 'footnote_inputfield_expert_lookup_widget_text'

The widget_text hook must be disabled by default, because it causes multiple reference containers to appear in Elementor accordions, but it must be enabled if multiple reference containers are desired, as in Elementor toggles.

C_STR_EXPERT_LOOKUP_WIDGET_TITLE

Settings container key to enable the `widget_title` hook.


    public
    string
    C_STR_EXPERT_LOOKUP_WIDGET_TITLE
    = 'footnote_inputfield_expert_lookup_widget_title'

C_STR_FOOTNOTE_FRAGMENT_ID_SLUG

Settings container key for the fragment ID slug in footnotes.


    public
    string
    C_STR_FOOTNOTE_FRAGMENT_ID_SLUG
    = 'footnotes_inputfield_footnote_fragment_id_slug'

C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT

Settings container key to enable superscript style normalization.


    public
    string
    C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT
    = 'footnotes_inputfield_referrers_normal_superscript'

C_STR_FOOTNOTE_SECTION_SHORTCODE

Settings container key for the footnote section shortcode.


    public
    string
    C_STR_FOOTNOTE_SECTION_SHORTCODE
    = 'footnotes_inputfield_section_shortcode'

C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE

Settings container key to enable shortcode syntax validation.


    public
    string
    C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE
    = 'footnotes_inputfield_shortcode_syntax_validation_enable'

C_STR_FOOTNOTE_URL_WRAP_ENABLED

Settings container key for URL wrap option.


    public
    string
    C_STR_FOOTNOTE_URL_WRAP_ENABLED
    = 'footnote_inputfield_url_wrap_enabled'

This is made optional because it causes weird line breaks. Unicode-compliant browsers break URLs at slashes.

C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION

Settings container key for alternative tooltip position.


    public
    string
    C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION
    = 'footnotes_inputfield_alternative_mouse_over_box_position'

Fixed-width is for alternative tooltips, cannot reuse max-width nor offsets.

C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE

Settings container key to enable AMP compatibility mode.


    public
    string
    C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE
    = 'footnotes_inputfield_amp_compatibility_enable'

Tags

Settings container key to enable backlink tooltips.


    public
    string
    C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE
    = 'footnotes_inputfield_backlink_tooltip_enable'

When hard links are enabled, clicks on the backlinks are logged in the browsing history, along with clicks on the referrers. This tooltip hints to use the backbutton instead, so the history gets streamlined again. See here for more information.

Tags

Settings container key to configure the backlink tooltip.


    public
    string
    C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT
    = 'footnotes_inputfield_backlink_tooltip_text'

C_STR_FOOTNOTES_COUNTER_STYLE

Settings container key for the counter style of the footnotes.


    public
    string
    C_STR_FOOTNOTES_COUNTER_STYLE
    = 'footnote_inputfield_counter_style'

C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING

Settings container key to enable CSS smooth scrolling.


    public
    string
    C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING
    = 'footnotes_inputfield_css_smooth_scrolling'

Native smooth scrolling only works in recent browsers.

C_STR_FOOTNOTES_EXPERT_MODE

Settings container key for the Expert mode.


    public
    string
    C_STR_FOOTNOTES_EXPERT_MODE
    = 'footnote_inputfield_enable_expert_mode'

Since the removal of the the_post hook, the tab is no danger zone any longer. All users, not experts only, need to be able to control relative positioning.

C_STR_FOOTNOTES_HARD_LINKS_ENABLE

Settings container key to enable hard links.


    public
    string
    C_STR_FOOTNOTES_HARD_LINKS_ENABLE
    = 'footnotes_inputfield_hard_links_enable'

When the alternative reference container is enabled, hard links are too.

C_STR_FOOTNOTES_IN_EXCERPT

Settings container key to look for footnotes in post excerpts.


    public
    string
    C_STR_FOOTNOTES_IN_EXCERPT
    = 'footnote_inputfield_search_in_excerpt'

C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION

Settings container key to set the solution of the input element label issue.


    public
    string
    C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION
    = 'footnotes_inputfield_label_issue_solution'

If hard links are not enabled, clicking a referrer in an input element label toggles the state of the input element the label is connected to. Beside hard links, other solutions include moving footnotes off the label and append them, or disconnecting this label from the input element (discouraged). See here for more information.

C_STR_FOOTNOTES_LOVE

Settings container key for the ‘I love footnotes’ text.


    public
    string
    C_STR_FOOTNOTES_LOVE
    = 'footnote_inputfield_love'

C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE

Settings container key to enable the alternative tooltips.


    public
    string
    C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE
    = 'footnote_inputfield_custom_mouse_over_box_alternative'

These alternative tooltips work around a website-related jQuery UI outage. They are low-script but use the AMP-incompatible onmouseover and onmouseout arguments, along with CSS transitions for fade-in/out. The very small script is inserted after the plugin's internal stylesheet.

C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND

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


    public
    string
    C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND
    = 'footnote_inputfield_custom_mouse_over_box_background'

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.

C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR

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


    public
    string
    C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR
    = 'footnote_inputfield_custom_mouse_over_box_border_color'

C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR

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


    public
    string
    C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR
    = 'footnote_inputfield_custom_mouse_over_box_color'

C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED

Settings container key to enable the mouse-over box.


    public
    string
    C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED
    = 'footnote_inputfield_custom_mouse_over_box_enabled'

C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED

Settings container key to enable tooltip truncation.


    public
    string
    C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED
    = 'footnote_inputfield_custom_mouse_over_box_excerpt_enabled'

C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION

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


    public
    string
    C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION
    = 'footnote_inputfield_custom_mouse_over_box_position'

The default position should not be lateral because of the risk the box gets squeezed between note anchor at line end and window edge, and top because reading at the bottom of the window is more likely.

C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR

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


    public
    string
    C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR
    = 'footnote_inputfield_custom_mouse_over_box_shadow_color'

C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT

Settings container key for basic responsive page layout support options.


    public
    string
    C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT
    = 'footnotes_inputfield_page_layout_support'

Whether to concatenate an additional stylesheet.

C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE

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


    public
    string
    C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE
    = 'footnotes_inputfield_reference_container_script_mode'

C_STR_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS

Settings container key for the referrer element.


    public
    string
    C_STR_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS
    = 'footnotes_inputfield_referrer_superscript_tags'

C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY

Settings container key for scroll duration asymmetricity.


    public
    int
    C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY
    = 'footnotes_inputfield_scroll_duration_asymmetricity'

C_STR_FOOTNOTES_SHORT_CODE_END

Settings container key for the short code of the footnote's end.


    public
    string
    C_STR_FOOTNOTES_SHORT_CODE_END
    = 'footnote_inputfield_placeholder_end'

C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED

Settings container key for the user-defined short code of the footnotes end.


    public
    string
    C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED
    = 'footnote_inputfield_placeholder_end_user_defined'

C_STR_FOOTNOTES_SHORT_CODE_START

Settings container key for the short code of the footnote's start.


    public
    string
    C_STR_FOOTNOTES_SHORT_CODE_START
    = 'footnote_inputfield_placeholder_start'

C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED

Settings container key for the user-defined short code of the footnotes start.


    public
    string
    C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED
    = 'footnote_inputfield_placeholder_start_user_defined'

C_STR_FOOTNOTES_STYLING_AFTER

Settings container key for the string after the footnote referrer.


    public
    string
    C_STR_FOOTNOTES_STYLING_AFTER
    = 'footnote_inputfield_custom_styling_after'

C_STR_FOOTNOTES_STYLING_BEFORE

Settings container key for the string before the footnote referrer.


    public
    string
    C_STR_FOOTNOTES_STYLING_BEFORE
    = 'footnote_inputfield_custom_styling_before'

The default footnote referrer surroundings should be square brackets, as in English or US American typesetting, for better UX thanks to a more button-like appearance, as well as for stylistic consistency with the expand-collapse button.

Tags

Settings container key to configure the tooltip excerpt delimiter.


    public
    string
    C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER
    = 'footnotes_inputfield_tooltip_excerpt_delimiter'

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

Settings container key to enable mirroring the tooltip excerpt in the reference container.


    public
    string
    C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE
    = 'footnotes_inputfield_tooltip_excerpt_mirror_enable'

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

Settings container key to configure the tooltip excerpt separator in the reference container.


    public
    string
    C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR
    = 'footnotes_inputfield_tooltip_excerpt_mirror_separator'

Tags

Settings container key for the label of the Read-on button in truncated tooltips.


    public
    string
    C_STR_FOOTNOTES_TOOLTIP_READON_LABEL
    = 'footnote_inputfield_readon_label'

C_STR_HARD_LINK_IDS_SEPARATOR

Settings container key for the ID separator in fragment IDs.


    public
    string
    C_STR_HARD_LINK_IDS_SEPARATOR
    = 'footnotes_inputfield_hard_link_ids_separator'

C_STR_HYPERLINK_ARROW

Settings container key for the backlink symbol selection.


    public
    string
    C_STR_HYPERLINK_ARROW
    = 'footnote_inputfield_custom_hyperlink_symbol'

C_STR_HYPERLINK_ARROW_USER_DEFINED

Settings container key for the user-defined backlink symbol.


    public
    string
    C_STR_HYPERLINK_ARROW_USER_DEFINED
    = 'footnote_inputfield_custom_hyperlink_symbol_user'

C_STR_LINK_ELEMENT_ENABLED

Settings container key for the link element option.


    public
    string
    C_STR_LINK_ELEMENT_ENABLED
    = 'footnote_inputfield_link_element_enabled'

C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED

Settings container key to enable setting the tooltip font size.


    public
    string
    C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED
    = 'footnotes_inputfield_mouse_over_box_font_size_enabled'

C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT

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


    public
    string
    C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT
    = 'footnotes_inputfield_mouse_over_box_font_size_unit'

C_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE

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


    public
    string
    C_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE
    = 'footnotes_inputfield_reference_container_3column_layout_enable'

C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE

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


    public
    string
    C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE
    = 'footnotes_inputfield_reference_container_backlink_symbol_enable'

C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH

Settings container key to get the backlink symbol switch side.


    public
    string
    C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH
    = 'footnotes_inputfield_reference_container_backlink_symbol_switch'

C_STR_REFERENCE_CONTAINER_COLLAPSE

Settings container key to collapse the reference container by default.


    public
    string
    C_STR_REFERENCE_CONTAINER_COLLAPSE
    = 'footnote_inputfield_collapse_references'

The string is converted to Boolean false if 'no', true if 'yes'.

C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER

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


    public
    string
    C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER
    = 'footnotes_inputfield_reference_container_label_bottom_border'

C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT

Settings container key for the reference container label element.


    public
    string
    C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT
    = 'footnotes_inputfield_reference_container_label_element'

C_STR_REFERENCE_CONTAINER_NAME

Settings container key for the label of the reference container.


    public
    string
    C_STR_REFERENCE_CONTAINER_NAME
    = 'footnote_inputfield_references_label'

C_STR_REFERENCE_CONTAINER_POSITION

Settings container key for the position of the reference container.


    public
    string
    C_STR_REFERENCE_CONTAINER_POSITION
    = 'footnote_inputfield_reference_container_place'

C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE

Settings container key for reference container position shortcode.


    public
    string
    C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE
    = 'footnote_inputfield_reference_container_position_shortcode'

C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE

Settings container key to enable reference container table row borders.


    public
    string
    C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE
    = 'footnotes_inputfield_reference_container_row_borders_enable'

C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE

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


    public
    string
    C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE
    = 'footnotes_inputfield_reference_container_start_page_enable'

C_STR_REFERRER_FRAGMENT_ID_SLUG

Settings container key for the fragment ID slug in referrers.


    public
    string
    C_STR_REFERRER_FRAGMENT_ID_SLUG
    = 'footnotes_inputfield_referrer_fragment_id_slug'

$a_arr_container

Contains all Settings Container names.


    private
        array<string|int, string>
    $a_arr_container
     = array('footnotes_storage', 'footnotes_storage_custom', 'footnotes_storage_expert', 'footnotes_storage_custom_css')

These are the storage container names, one per dashboard tab.

$a_arr_default

Contains all default values for each Settings Container.


    private
        array<string|int, string|int>
    $a_arr_default
     = array(
    // General settings.
    'footnotes_storage' => array(
        // AMP compatibility.
        self::C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE => '',
        // Footnote start and end short codes.
        self::C_STR_FOOTNOTES_SHORT_CODE_START => '((',
        self::C_STR_FOOTNOTES_SHORT_CODE_END => '))',
        self::C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED => '',
        self::C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED => '',
        self::C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE => 'yes',
        // Footnotes numbering.
        self::C_STR_FOOTNOTES_COUNTER_STYLE => 'arabic_plain',
        self::C_STR_COMBINE_IDENTICAL_FOOTNOTES => 'yes',
        // Scrolling behavior.
        self::C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING => 'no',
        self::C_INT_FOOTNOTES_SCROLL_OFFSET => 20,
        self::C_INT_FOOTNOTES_SCROLL_DURATION => 380,
        self::C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY => 'no',
        self::C_INT_FOOTNOTES_SCROLL_DOWN_DURATION => 150,
        self::C_INT_FOOTNOTES_SCROLL_DOWN_DELAY => 0,
        self::C_INT_FOOTNOTES_SCROLL_UP_DELAY => 0,
        self::C_STR_FOOTNOTES_HARD_LINKS_ENABLE => 'no',
        self::C_STR_REFERRER_FRAGMENT_ID_SLUG => 'r',
        self::C_STR_FOOTNOTE_FRAGMENT_ID_SLUG => 'f',
        self::C_STR_HARD_LINK_IDS_SEPARATOR => '+',
        self::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE => 'yes',
        self::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT => 'Alt+ ←',
        // Reference container.
        self::C_STR_REFERENCE_CONTAINER_NAME => 'References',
        self::C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT => 'p',
        self::C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER => 'yes',
        self::C_STR_REFERENCE_CONTAINER_COLLAPSE => 'no',
        self::C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE => 'jquery',
        self::C_STR_REFERENCE_CONTAINER_POSITION => 'post_end',
        self::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE => '[[references]]',
        self::C_STR_FOOTNOTE_SECTION_SHORTCODE => '[[/footnotesection]]',
        self::C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE => 'yes',
        self::C_INT_REFERENCE_CONTAINER_TOP_MARGIN => 24,
        self::C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN => 0,
        self::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT => 'none',
        self::C_STR_FOOTNOTE_URL_WRAP_ENABLED => 'yes',
        self::C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE => 'yes',
        self::C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH => 'no',
        self::C_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE => 'no',
        self::C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE => 'no',
        self::C_STR_BACKLINKS_SEPARATOR_ENABLED => 'yes',
        self::C_STR_BACKLINKS_SEPARATOR_OPTION => 'comma',
        self::C_STR_BACKLINKS_SEPARATOR_CUSTOM => '',
        self::C_STR_BACKLINKS_TERMINATOR_ENABLED => 'no',
        self::C_STR_BACKLINKS_TERMINATOR_OPTION => 'full_stop',
        self::C_STR_BACKLINKS_TERMINATOR_CUSTOM => '',
        self::C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED => 'no',
        self::C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR => '50',
        self::C_STR_BACKLINKS_COLUMN_WIDTH_UNIT => 'px',
        self::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED => 'no',
        self::C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR => '140',
        self::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT => 'px',
        self::C_STR_BACKLINKS_LINE_BREAKS_ENABLED => 'no',
        self::C_STR_LINK_ELEMENT_ENABLED => 'yes',
        // Footnotes in excerpts.
        self::C_STR_FOOTNOTES_IN_EXCERPT => 'manual',
        // Footnotes love.
        self::C_STR_FOOTNOTES_LOVE => 'no',
        // Deprecated.
        self::C_STR_FOOTNOTES_EXPERT_MODE => 'yes',
    ),
    // Referrers and tooltips.
    'footnotes_storage_custom' => array(
        // Backlink symbol.
        self::C_STR_HYPERLINK_ARROW => '&#8593;',
        self::C_STR_HYPERLINK_ARROW_USER_DEFINED => '',
        // Referrers.
        self::C_STR_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS => 'yes',
        self::C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT => 'no',
        self::C_STR_FOOTNOTES_STYLING_BEFORE => '[',
        self::C_STR_FOOTNOTES_STYLING_AFTER => ']',
        // Referrers in labels.
        self::C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION => 'none',
        // Tooltips.
        self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED => 'yes',
        self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE => 'no',
        // Tooltip position.
        self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION => 'top center',
        self::C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION => 'top right',
        self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X => 0,
        self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X => -50,
        self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y => -7,
        self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y => 24,
        // Tooltip dimensions.
        self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH => 450,
        self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH => 400,
        // Tooltip timing.
        self::C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY => 0,
        self::C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION => 200,
        self::C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY => 400,
        self::C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION => 200,
        // Tooltip truncation.
        self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED => 'yes',
        self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH => 200,
        self::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL => 'Continue reading',
        // Tooltip text.
        self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER => '[[/tooltip]]',
        self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE => 'no',
        self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR => ' — ',
        // Tooltip appearance.
        self::C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED => 'yes',
        self::C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR => 13,
        self::C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT => 'px',
        self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR => '#000000',
        self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND => '#ffffff',
        self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH => 1,
        self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR => '#cccc99',
        self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS => 0,
        self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR => '#666666',
        // Your existing Custom CSS code.
        self::C_STR_CUSTOM_CSS => '',
    ),
    // Scope and priority.
    'footnotes_storage_expert' => array(
        // WordPress hooks with priority level.
        self::C_STR_EXPERT_LOOKUP_THE_TITLE => '',
        self::C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL => PHP_INT_MAX,
        self::C_STR_EXPERT_LOOKUP_THE_CONTENT => 'checked',
        self::C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL => 98,
        self::C_STR_EXPERT_LOOKUP_THE_EXCERPT => '',
        self::C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL => PHP_INT_MAX,
        self::C_STR_EXPERT_LOOKUP_WIDGET_TITLE => '',
        self::C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL => PHP_INT_MAX,
        self::C_STR_EXPERT_LOOKUP_WIDGET_TEXT => '',
        self::C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL => 98,
    ),
    // Custom CSS.
    'footnotes_storage_custom_css' => array(
        // Your existing Custom CSS code.
        self::C_STR_CUSTOM_CSS_LEGACY_ENABLE => 'yes',
        // Custom CSS.
        self::C_STR_CUSTOM_CSS_NEW => '',
    ),
)

$a_arr_settings

Contains all Settings from each Settings Container.


    private
        array<string|int, string|int>
    $a_arr_settings
     = array()

$a_obj_instance

Stores a singleton reference of this class.


    private
    static    Footnotes_Settings
    $a_obj_instance
     = 
ull

get()

Returns the value of specified Setting.


    public
                get(string $p_str_key) : string|int|null

Parameters

$p_str_key : string: Setting key.

Return values

string|int|null —

Setting value, or null if setting key is invalid.

get_container()

Returns the name of a specified Settings Container.


    public
                get_container(int $p_int_index) : str

Parameters

$p_int_index : int: Settings Container index.

Return values

str —

Settings Container name.

get_defaults()

Returns the default value(s) of a specific Settings Container.


    public
                get_defaults(int $p_int_index) : array<string|int, string|int>

Parameters

$p_int_index : int: Settings Container index.

Return values

array<string|int, string|int> —

Settings Container default value(s).

instance()

Returns a singleton of this class.


    public
            static    instance() : Footnotes_Settings

Return values

Footnotes_Settings —

register_settings()


    public
                register_settings() : mixed

The Settings Container label will be the same as the Settings Container name.

Return values

mixed —

save_options()

Updates a whole Setting Container on save.


    public
                save_options(int $p_int_index, array<string|int, mixed> $p_arr_new_values) : bool

Parameters

$p_int_index : int: Index of the Setting Container.
$p_arr_new_values : array<string|int, mixed>: The new Settings value(s).

Return values

bool —

__construct()

Loads all Settings from each WordPress Settings Container.


    private
                __construct() : mixed

Return values

mixed —

load()

Loads all settings from specified Settings Containers.


    private
                load(int $p_int_index) : array<string|int, string|int>

Parameters

$p_int_index : int: Settings container index.

Return values

array<string|int, string|int> —

Loaded settings (or defaults if specified container is empty).

load_all()

Loads all Settings from each Settings container.


    private
                load_all() : mixed

Return values

mixed —

Footnotes_Settings

Tags

Table of Contents

Constants

C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR

Tags

C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR

Tags

C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR

Tags

C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL

Tags

C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL

Tags

C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL

Tags

C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL

Tags

C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL

Tags

C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X

Tags

C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y

Tags

C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH

Tags

C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS

Tags

C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH

Tags

C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH

Tags

C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH

Tags

C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X

Tags

C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y

Tags

C_INT_FOOTNOTES_SCROLL_DOWN_DELAY

Tags

C_INT_FOOTNOTES_SCROLL_DOWN_DURATION

Tags

C_INT_FOOTNOTES_SCROLL_DURATION

Tags

C_INT_FOOTNOTES_SCROLL_OFFSET

Tags

C_INT_FOOTNOTES_SCROLL_UP_DELAY

Tags

C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY

Tags

C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION

Tags

C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY

Tags

C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION

Tags

C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN

Tags

C_INT_REFERENCE_CONTAINER_TOP_MARGIN

Tags

C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED

Tags

C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT

Tags

C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED

Tags

C_STR_BACKLINKS_COLUMN_WIDTH_UNIT

Tags

C_STR_BACKLINKS_LINE_BREAKS_ENABLED

Tags

C_STR_BACKLINKS_SEPARATOR_CUSTOM

Tags

C_STR_BACKLINKS_SEPARATOR_ENABLED

Tags

C_STR_BACKLINKS_SEPARATOR_OPTION

Tags

C_STR_BACKLINKS_TERMINATOR_CUSTOM

Tags

C_STR_BACKLINKS_TERMINATOR_ENABLED

Tags