Documentation

MCI_Footnotes_Settings

Loads the settings values, sets to default values if undefined.

Tags
author

Stefan Herndler

since
1.5.0

Table of Contents

C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED  = "footnotes_inputfield_backlinks_column_max_width_enabled"
C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED  = "footnotes_inputfield_backlinks_column_width_enabled"
C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED  = "footnotes_inputfield_backlinks_line_breaks_enabled"
C_BOOL_BACKLINKS_SEPARATOR_ENABLED  = "footnotes_inputfield_backlinks_separator_enabled"
C_BOOL_BACKLINKS_TERMINATOR_ENABLED  = "footnotes_inputfield_backlinks_terminator_enabled"
C_BOOL_COMBINE_IDENTICAL_FOOTNOTES  = "footnote_inputfield_combine_identical"
Settings Container Key for combining identical footnotes.
C_BOOL_CUSTOM_CSS_LEGACY_ENABLE  = "footnote_inputfield_custom_css_legacy_enable"
Settings Container Key to enable display of legacy Custom CSS metaboxes.
C_BOOL_EXPERT_LOOKUP_THE_CONTENT  = "footnote_inputfield_expert_lookup_the_content"
Settings Container Key to enable the 'the_content' hook.
C_BOOL_EXPERT_LOOKUP_THE_EXCERPT  = "footnote_inputfield_expert_lookup_the_excerpt"
Settings Container Key to enable the 'the_excerpt' hook.
C_BOOL_EXPERT_LOOKUP_THE_TITLE  = "footnote_inputfield_expert_lookup_the_title"
Settings Container Key to enable the 'the_title' hook.
C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT  = "footnote_inputfield_expert_lookup_widget_text"
Settings Container Key to enable the 'widget_text' hook.
C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE  = "footnote_inputfield_expert_lookup_widget_title"
Settings Container Key to enable the 'widget_title' hook.
C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE  = "footnotes_inputfield_shortcode_syntax_validation_enable"
Settings container key for shortcode syntax validation.
C_BOOL_FOOTNOTE_URL_WRAP_ENABLED  = "footnote_inputfield_url_wrap_enabled"
Settings Container Key for URL wrap option
C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE  = "footnotes_inputfield_backlink_tooltip_enable"
Settings container key to enable backlink tooltips.
C_BOOL_FOOTNOTES_EXPERT_MODE  = "footnote_inputfield_enable_expert_mode"
Settings Container Key for the Expert mode.
C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE  = "footnotes_inputfield_hard_links_enable"
C_BOOL_FOOTNOTES_IN_EXCERPT  = "footnote_inputfield_search_in_excerpt"
Settings Container Key to look for footnotes in post excerpts.
C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE  = "footnote_inputfield_custom_mouse_over_box_alternative"
Settings Container Key to enable the alternative tooltips.
C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED  = "footnote_inputfield_custom_mouse_over_box_enabled"
Settings Container Key to enable the mouse-over box.
C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED  = "footnote_inputfield_custom_mouse_over_box_excerpt_enabled"
Settings Container Key to enable tooltip truncation.
C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS  = "footnotes_inputfield_referrer_superscript_tags"
Settings Container Key for the referrer element.
C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE  = "footnotes_inputfield_tooltip_excerpt_mirror_enable"
Settings container key to enable mirroring the tooltip excerpt in the reference container.
C_BOOL_LINK_ELEMENT_ENABLED  = "footnote_inputfield_link_element_enabled"
Settings Container Keys for the link element option Settings Container Keys for backlink typography and layout Settings Container Keys for tooltip font size Settings Container Keys for page layout support Settings Container Keys for scroll offset and duration Settings Container Keys for tooltip display durations
C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED  = "footnotes_inputfield_mouse_over_box_font_size_enabled"
C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE  = "footnotes_inputfield_reference_container_3column_layout_enable"
Settings Container Key to enable the legacy layout of the reference container.
C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE  = "footnotes_inputfield_reference_container_backlink_symbol_enable"
Settings Container Key to enable the display of a backlink symbol.
C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH  = "footnotes_inputfield_reference_container_backlink_symbol_switch"
Settings Container Key to get the backlink symbol switch side.
C_BOOL_REFERENCE_CONTAINER_COLLAPSE  = "footnote_inputfield_collapse_references"
Settings Container Key to collapse the reference container by default.
C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER  = "footnotes_inputfield_reference_container_label_bottom_border"
C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE  = "footnotes_inputfield_reference_container_row_borders_enable"
Settings Container Key for table cell borders, thanks to @noobishh
C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE  = "footnotes_inputfield_reference_container_start_page_enable"
Settings Container Key to not display the reference container on the homepage.
C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR  = "footnotes_inputfield_mouse_over_box_font_size_scalar"
C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR  = "footnotes_inputfield_backlinks_column_max_width_scalar"
C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR  = "footnotes_inputfield_backlinks_column_width_scalar"
C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL  = "footnote_inputfield_expert_lookup_the_content_priority_level"
Settings Container Key for 'the_content' hook priority level.
C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL  = "footnote_inputfield_expert_lookup_the_excerpt_priority_level"
C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL  = "footnote_inputfield_expert_lookup_the_title_priority_level"
Settings Container Key for '' hook priority level
C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL  = "footnote_inputfield_expert_lookup_widget_text_priority_level"
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  = "footnotes_inputfield_alternative_mouse_over_box_offset_x"
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  = "footnotes_inputfield_alternative_mouse_over_box_width"
C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS  = "footnote_inputfield_custom_mouse_over_box_border_radius"
Settings Container Key for the mouse-over box to define the border radius.
C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH  = "footnote_inputfield_custom_mouse_over_box_border_width"
Settings Container Key for the mouse-over box to define the border width.
C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH  = "footnote_inputfield_custom_mouse_over_box_excerpt_length"
Settings Container Key for the mouse-over box to define the max. length of the enabled excerpt.
C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH  = "footnote_inputfield_custom_mouse_over_box_max_width"
Settings Container Key for the mouse-over box to define the max. width.
C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X  = "footnote_inputfield_custom_mouse_over_box_offset_x"
Settings Container Key for the mouse-over box to define the offset (x).
C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y  = "footnote_inputfield_custom_mouse_over_box_offset_y"
Settings Container Key for the mouse-over box to define the offset (y).
C_INT_FOOTNOTES_SCROLL_DURATION  = "footnotes_inputfield_scroll_duration"
C_INT_FOOTNOTES_SCROLL_OFFSET  = "footnotes_inputfield_scroll_offset"
Scroll offset and duration
C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY  = "footnotes_inputfield_mouse_over_box_fade_in_delay"
C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION  = "footnotes_inputfield_mouse_over_box_fade_in_duration"
C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY  = "footnotes_inputfield_mouse_over_box_fade_out_delay"
C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION  = "footnotes_inputfield_mouse_over_box_fade_out_duration"
C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN  = "footnotes_inputfield_reference_container_bottom_margin"
C_INT_REFERENCE_CONTAINER_TOP_MARGIN  = "footnotes_inputfield_reference_container_top_margin"
Settings container keys for reference container top and bottom margins Settings container keys for hard link enabling Settings container keys for hard link anchors in referrers and footnotes
C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT  = "footnotes_inputfield_backlinks_column_max_width_unit"
C_STR_BACKLINKS_COLUMN_WIDTH_UNIT  = "footnotes_inputfield_backlinks_column_width_unit"
C_STR_BACKLINKS_SEPARATOR_CUSTOM  = "footnotes_inputfield_backlinks_separator_custom"
C_STR_BACKLINKS_SEPARATOR_OPTION  = "footnotes_inputfield_backlinks_separator_option"
C_STR_BACKLINKS_TERMINATOR_CUSTOM  = "footnotes_inputfield_backlinks_terminator_custom"
C_STR_BACKLINKS_TERMINATOR_OPTION  = "footnotes_inputfield_backlinks_terminator_option"
C_STR_CUSTOM_CSS  = "footnote_inputfield_custom_css"
Settings Container Key for the Custom CSS.
C_STR_CUSTOM_CSS_NEW  = "footnote_inputfield_custom_css_new"
Settings Container Key for the Custom CSS migrated to a dedicated tab.
C_STR_FOOTNOTE_FRAGMENT_ID_SLUG  = "footnotes_inputfield_footnote_fragment_id_slug"
C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT  = "footnotes_inputfield_referrers_normal_superscript"
Settings container key to enable superscript style normalization.
C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION  = "footnotes_inputfield_alternative_mouse_over_box_position"
Settings Container Keys for alternative tooltip position Settings Container Keys for reference container label element, thanks to @markhillyer
C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT  = "footnotes_inputfield_backlink_tooltip_text"
Settings container key to configure the backlink tooltip.
C_STR_FOOTNOTES_COUNTER_STYLE  = "footnote_inputfield_counter_style"
Settings Container Key for the counter style of the footnotes.
C_STR_FOOTNOTES_LOVE  = "footnote_inputfield_love"
Settings Container Key for the 'I love footnotes' text.
C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND  = "footnote_inputfield_custom_mouse_over_box_background"
Settings Container Key for the mouse-over box to define the background color.
C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR  = "footnote_inputfield_custom_mouse_over_box_border_color"
Settings Container Key for the mouse-over box to define the border color.
C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR  = "footnote_inputfield_custom_mouse_over_box_color"
Settings Container Key for the mouse-over box to define the color.
C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION  = "footnote_inputfield_custom_mouse_over_box_position"
Settings Container Key for the mouse-over box to define the position.
C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR  = "footnote_inputfield_custom_mouse_over_box_shadow_color"
Settings Container Key for the mouse-over box to define the box-shadow color.
C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT  = "footnotes_inputfield_page_layout_support"
C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE  = "footnotes_inputfield_reference_container_script_mode"
Settings container key to select the script mode for the reference container.
C_STR_FOOTNOTES_SHORT_CODE_END  = "footnote_inputfield_placeholder_end"
Settings Container Key for the short code of the footnote’s end.
C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED  = "footnote_inputfield_placeholder_end_user_defined"
Settings Container Key for the user-defined short code of the footnotes end.
C_STR_FOOTNOTES_SHORT_CODE_START  = "footnote_inputfield_placeholder_start"
Settings Container Key for the short code of the footnote’s start.
C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED  = "footnote_inputfield_placeholder_start_user_defined"
Settings Container Key for the user-defined short code of the footnotes start.
C_STR_FOOTNOTES_STYLING_AFTER  = "footnote_inputfield_custom_styling_after"
Settings Container Key for the string after the footnote referrer.
C_STR_FOOTNOTES_STYLING_BEFORE  = "footnote_inputfield_custom_styling_before"
Settings Container Key for the string before the footnote referrer.
C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER  = "footnotes_inputfield_tooltip_excerpt_delimiter"
Settings container key to configure the tooltip excerpt delimiter.
C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR  = "footnotes_inputfield_tooltip_excerpt_mirror_separator"
Settings container key to configure the tooltip excerpt separator in the reference container.
C_STR_FOOTNOTES_TOOLTIP_READON_LABEL  = "footnote_inputfield_readon_label"
Settings Container Key for the label of the Read-on button in truncated tooltips.
C_STR_HARD_LINK_IDS_SEPARATOR  = "footnotes_inputfield_hard_link_ids_separator"
C_STR_HYPERLINK_ARROW  = "footnote_inputfield_custom_hyperlink_symbol"
Settings Container Key for the backlink symbol selection.
C_STR_HYPERLINK_ARROW_USER_DEFINED  = "footnote_inputfield_custom_hyperlink_symbol_user"
Settings Container Key for the user-defined backlink symbol.
C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT  = "footnotes_inputfield_mouse_over_box_font_size_unit"
C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT  = "footnotes_inputfield_reference_container_label_element"
C_STR_REFERENCE_CONTAINER_NAME  = "footnote_inputfield_references_label"
Settings Container Key for the label of the reference container.
C_STR_REFERENCE_CONTAINER_POSITION  = "footnote_inputfield_reference_container_place"
Settings Container Key for the position of the reference container.
C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE  = "footnote_inputfield_reference_container_position_shortcode"
Settings Container Key for reference container position shortcode
C_STR_REFERRER_FRAGMENT_ID_SLUG  = "footnotes_inputfield_referrer_fragment_id_slug"
$a_arr_Container  : array<string|int, mixed>
Contains all Settings Container names.
$a_arr_Default  : array<string|int, mixed>
Contains all Default Settings for each Settings Container.
$a_arr_Settings  : array<string|int, mixed>
Contains all Settings from each Settings container as soon as this class is initialized.
$a_obj_Instance  : MCI_Footnotes_Settings
Stores a singleton reference of this class.
ClearAll()  : mixed
Deletes each Settings Container and loads the default values for each Settings Container.
get()  : mixed
Returns the value of specified Settings name.
getContainer()  : str
Returns the name of a specified Settings Container.
getDefaults()  : array<string|int, mixed>
Returns the default values of a specific Settings Container.
instance()  : MCI_Footnotes_Settings
Returns a singleton of this class.
RegisterSettings()  : mixed
Register all Settings Container for the Plugin Settings Page in the Dashboard.
saveOptions()  : bool
Updates a whole Settings container.
__construct()  : mixed
Class Constructor. Loads all Settings from each WordPress Settings container.
Load()  : array<string|int, mixed>
Loads all Settings from specified Settings Container.
loadAll()  : mixed
Loads all Settings from each Settings container.

Constants

C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED

public mixed C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED = "footnotes_inputfield_backlinks_column_max_width_enabled"

C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED

public mixed C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED = "footnotes_inputfield_backlinks_column_width_enabled"

C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED

public mixed C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED = "footnotes_inputfield_backlinks_line_breaks_enabled"

C_BOOL_BACKLINKS_SEPARATOR_ENABLED

public mixed C_BOOL_BACKLINKS_SEPARATOR_ENABLED = "footnotes_inputfield_backlinks_separator_enabled"

C_BOOL_BACKLINKS_TERMINATOR_ENABLED

public mixed C_BOOL_BACKLINKS_TERMINATOR_ENABLED = "footnotes_inputfield_backlinks_terminator_enabled"

C_BOOL_COMBINE_IDENTICAL_FOOTNOTES

Settings Container Key for combining identical footnotes.

public str C_BOOL_COMBINE_IDENTICAL_FOOTNOTES = "footnote_inputfield_combine_identical"
Tags
author

Stefan Herndler

since
1.5.0

C_BOOL_CUSTOM_CSS_LEGACY_ENABLE

Settings Container Key to enable display of legacy Custom CSS metaboxes.

public str C_BOOL_CUSTOM_CSS_LEGACY_ENABLE = "footnote_inputfield_custom_css_legacy_enable"
Tags
since
2.2.2
since
2.3.0

swap Boolean from 'migration complete' to 'show legacy'

date

2020-12-15T0520+0100

date

2020-12-27T1233+0100

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

C_BOOL_EXPERT_LOOKUP_THE_CONTENT

Settings Container Key to enable the 'the_content' hook.

public str C_BOOL_EXPERT_LOOKUP_THE_CONTENT = "footnote_inputfield_expert_lookup_the_content"
Tags
author

Stefan Herndler

since
1.5.5

C_BOOL_EXPERT_LOOKUP_THE_EXCERPT

Settings Container Key to enable the 'the_excerpt' hook.

public str C_BOOL_EXPERT_LOOKUP_THE_EXCERPT = "footnote_inputfield_expert_lookup_the_excerpt"
Tags
author

Stefan Herndler

since
1.5.5

C_BOOL_EXPERT_LOOKUP_THE_TITLE

Settings Container Key to enable the 'the_title' hook.

public str C_BOOL_EXPERT_LOOKUP_THE_TITLE = "footnote_inputfield_expert_lookup_the_title"
Tags
author

Stefan Herndler

since
1.5.5

C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT

Settings Container Key to enable the 'widget_text' hook.

public str C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT = "footnote_inputfield_expert_lookup_widget_text"
Tags
author

Stefan Herndler

since
1.5.5

C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE

Settings Container Key to enable the 'widget_title' hook.

public str C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE = "footnote_inputfield_expert_lookup_widget_title"
Tags
author

Stefan Herndler

since
1.5.5

C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE

Settings container key for shortcode syntax validation.

public str C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE = "footnotes_inputfield_shortcode_syntax_validation_enable"
Tags
since
2.4.0
date

2021-01-01T0616+0100

C_BOOL_FOOTNOTE_URL_WRAP_ENABLED

Settings Container Key for URL wrap option

public str C_BOOL_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.

Tags
since
2.1.6

C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE

Settings container key to enable backlink tooltips.

public str C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE = "footnotes_inputfield_backlink_tooltip_enable"
  • Update: Reference container: Hard backlinks (optional): optional configurable tooltip hinting to use the backbutton instead, thanks to @theroninjedi47 bug report.
Tags
since
2.5.4
reporter

@theroninjedi47

link

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.
link
https://wordpress.org/support/topic/making-it-amp-compatible/#post-13837359

C_BOOL_FOOTNOTES_EXPERT_MODE

Settings Container Key for the Expert mode.

public str C_BOOL_FOOTNOTES_EXPERT_MODE = "footnote_inputfield_enable_expert_mode"
Tags
author

Stefan Herndler

since
1.5.5
since
2.1.6

This setting removed as irrelevant since priority level settings need permanent visibility.

date

2020-12-09T2107+0100

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_BOOL_FOOTNOTES_HARD_LINKS_ENABLE

public mixed C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE = "footnotes_inputfield_hard_links_enable"

C_BOOL_FOOTNOTES_IN_EXCERPT

Settings Container Key to look for footnotes in post excerpts.

public str C_BOOL_FOOTNOTES_IN_EXCERPT = "footnote_inputfield_search_in_excerpt"
Tags
author

Stefan Herndler

since
1.5.0

C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE

Settings Container Key to enable the alternative tooltips.

public str C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE = "footnote_inputfield_custom_mouse_over_box_alternative"
  • Bugfix: Tooltips: optional alternative JS implementation with CSS transitions to fix configuration-related outage, thanks to @andreasra feedback.
Tags
since
2.1.1
date

2020-11-11T1817+0100

reporter

@andreasra

link
https://wordpress.org/support/topic/footnotes-appearing-in-header/page/2/#post-13632566

C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED

Settings Container Key to enable the mouse-over box.

public str C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED = "footnote_inputfield_custom_mouse_over_box_enabled"
Tags
author

Stefan Herndler

since
1.5.2

C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED

Settings Container Key to enable tooltip truncation.

public str C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED = "footnote_inputfield_custom_mouse_over_box_excerpt_enabled"
Tags
author

Stefan Herndler

since
1.5.4

C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS

Settings Container Key for the referrer element.

public str C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS = "footnotes_inputfield_referrer_superscript_tags"
  • Bugfix: Referrers: new setting for vertical align: superscript (default) or baseline (optional), thanks to @cwbayer bug report.
Tags
since
2.1.1
date

2020-11-16T0859+0100

reporter

@cwbayer

link
https://wordpress.org/support/topic/footnote-number-in-text-superscript-disrupts-leading/

C_BOOL_LINK_ELEMENT_ENABLED

Settings Container Keys for the link element option Settings Container Keys for backlink typography and layout Settings Container Keys for tooltip font size Settings Container Keys for page layout support Settings Container Keys for scroll offset and duration Settings Container Keys for tooltip display durations

public str|bool|int|flo C_BOOL_LINK_ELEMENT_ENABLED = "footnote_inputfield_link_element_enabled"
Tags
since
2.1.4

C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED

public mixed C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED = "footnotes_inputfield_mouse_over_box_font_size_enabled"

C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE

Settings Container Key to enable the legacy layout of the reference container.

public str C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE = "footnotes_inputfield_reference_container_3column_layout_enable"
  • Bugfix: Reference container: option to restore pre-2.0.0 layout with the backlink symbol in an extra column.
Tags
since
2.1.1

C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE

Settings Container Key to enable the display of a backlink symbol.

public str C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE = "footnotes_inputfield_reference_container_backlink_symbol_enable"
  • Bugfix: Reference container: Backlink symbol: make optional, not suggest configuring it to invisible, thanks to @spaceling feedback.
Tags
since
2.1.1
reporter

@spaceling

link
https://wordpress.org/support/topic/change-the-position-5/page/2/#post-13671138

C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH

Settings Container Key to get the backlink symbol switch side.

public str C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH = "footnotes_inputfield_reference_container_backlink_symbol_switch"
  • Bugfix: Reference container: option to append symbol (prepended by default), thanks to @spaceling code contribution.
Tags
since
2.1.1
date

2020-11-16T2024+0100

contributor

@spaceling

link
https://wordpress.org/support/topic/change-the-position-5/#post-13615994

C_BOOL_REFERENCE_CONTAINER_COLLAPSE

Settings Container Key to collapse the reference container by default.

public str C_BOOL_REFERENCE_CONTAINER_COLLAPSE = "footnote_inputfield_collapse_references"
Tags
author

Stefan Herndler

since
1.5.0
see
MCI_Footnotes_Convert::toBool()

The type in the variable name is useful to show the intention.

todo

Eventually change misleading variable names C_BOOL_… to C_STR_… (that’s how Hungarian screws things up).

C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER

public mixed C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER = "footnotes_inputfield_reference_container_label_bottom_border"

C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE

Settings Container Key for table cell borders, thanks to @noobishh

public str C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE = "footnotes_inputfield_reference_container_row_borders_enable"
Tags
link
https://wordpress.org/support/topic/borders-25/
since
2.2.10

C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE

Settings Container Key to not display the reference container on the homepage.

public str C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE = "footnotes_inputfield_reference_container_start_page_enable"
  • Bugfix: Reference container: fix start pages by making its display optional, thanks to @dragon013 bug report.
Tags
since
2.1.1
reporter

@dragon013

link
https://wordpress.org/support/topic/possible-to-hide-it-from-start-page/

C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR

public mixed C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR = "footnotes_inputfield_mouse_over_box_font_size_scalar"

C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR

public mixed C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR = "footnotes_inputfield_backlinks_column_max_width_scalar"

C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR

public mixed 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 str C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL = "footnote_inputfield_expert_lookup_the_content_priority_level"
Tags
since
2.1.1
date

2020-11-16T0859+0100

C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL

public mixed 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 '' hook priority level

public str C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL = "footnote_inputfield_expert_lookup_the_title_priority_level"
Tags
since
2.1.2
date

2020-11-20T0620+0100

C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL

public mixed C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL = "footnote_inputfield_expert_lookup_widget_text_priority_level"

C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL

public mixed 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

public mixed 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

public mixed 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

public mixed 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 str C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS = "footnote_inputfield_custom_mouse_over_box_border_radius"
Tags
author

Stefan Herndler

since
1.5.6

C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH

Settings Container Key for the mouse-over box to define the border width.

public str C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH = "footnote_inputfield_custom_mouse_over_box_border_width"
Tags
author

Stefan Herndler

since
1.5.6

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 str C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH = "footnote_inputfield_custom_mouse_over_box_excerpt_length"
Tags
author

Stefan Herndler

since
1.5.4

C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH

Settings Container Key for the mouse-over box to define the max. width.

public str C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH = "footnote_inputfield_custom_mouse_over_box_max_width"
Tags
author

Stefan Herndler

since
1.5.6

C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X

Settings Container Key for the mouse-over box to define the offset (x).

public str C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X = "footnote_inputfield_custom_mouse_over_box_offset_x"
Tags
author

Stefan Herndler

since
1.5.7

C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y

Settings Container Key for the mouse-over box to define the offset (y).

public str C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y = "footnote_inputfield_custom_mouse_over_box_offset_y"
Tags
author

Stefan Herndler

since
1.5.7

C_INT_FOOTNOTES_SCROLL_DURATION

public mixed C_INT_FOOTNOTES_SCROLL_DURATION = "footnotes_inputfield_scroll_duration"

C_INT_FOOTNOTES_SCROLL_OFFSET

Scroll offset and duration

public mixed C_INT_FOOTNOTES_SCROLL_OFFSET = "footnotes_inputfield_scroll_offset"
  • Bugfix: Scroll offset: make configurable to fix site-dependent issues related to fixed headers.
  • Bugfix: Scroll duration: make configurable to conform to website content and style requirements.
Tags
since
2.1.4
date

2020-12-05T0538+0100

C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY

public mixed C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY = "footnotes_inputfield_mouse_over_box_fade_in_delay"

C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION

public mixed C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION = "footnotes_inputfield_mouse_over_box_fade_in_duration"

C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY

public mixed C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY = "footnotes_inputfield_mouse_over_box_fade_out_delay"

C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION

public mixed C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION = "footnotes_inputfield_mouse_over_box_fade_out_duration"

C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN

public mixed C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN = "footnotes_inputfield_reference_container_bottom_margin"

C_INT_REFERENCE_CONTAINER_TOP_MARGIN

Settings container keys for reference container top and bottom margins Settings container keys for hard link enabling Settings container keys for hard link anchors in referrers and footnotes

public int|bool|str C_INT_REFERENCE_CONTAINER_TOP_MARGIN = "footnotes_inputfield_reference_container_top_margin"
Tags
since
2.3.0

C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT

public mixed C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT = "footnotes_inputfield_backlinks_column_max_width_unit"

C_STR_BACKLINKS_COLUMN_WIDTH_UNIT

public mixed C_STR_BACKLINKS_COLUMN_WIDTH_UNIT = "footnotes_inputfield_backlinks_column_width_unit"

C_STR_BACKLINKS_SEPARATOR_CUSTOM

public mixed C_STR_BACKLINKS_SEPARATOR_CUSTOM = "footnotes_inputfield_backlinks_separator_custom"

C_STR_BACKLINKS_SEPARATOR_OPTION

public mixed C_STR_BACKLINKS_SEPARATOR_OPTION = "footnotes_inputfield_backlinks_separator_option"

C_STR_BACKLINKS_TERMINATOR_CUSTOM

public mixed C_STR_BACKLINKS_TERMINATOR_CUSTOM = "footnotes_inputfield_backlinks_terminator_custom"

C_STR_BACKLINKS_TERMINATOR_OPTION

public mixed C_STR_BACKLINKS_TERMINATOR_OPTION = "footnotes_inputfield_backlinks_terminator_option"

C_STR_CUSTOM_CSS

Settings Container Key for the Custom CSS.

public str C_STR_CUSTOM_CSS = "footnote_inputfield_custom_css"
Tags
author

Stefan Herndler

since
1.5.0
since
1.3.0

Adding: new settings tab for custom CSS settings.

C_STR_CUSTOM_CSS_NEW

Settings Container Key for the Custom CSS migrated to a dedicated tab.

public str C_STR_CUSTOM_CSS_NEW = "footnote_inputfield_custom_css_new"
Tags
since
2.2.2

Bugfix: Dashboard: Custom CSS: unearth text area and migrate to dedicated tab as designed.

date

2020-12-15T0520+0100

C_STR_FOOTNOTE_FRAGMENT_ID_SLUG

public mixed 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 str C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT = "footnotes_inputfield_referrers_normal_superscript"

-Bugfix: Referrers: optional fixes to vertical alignment, font size and position (static) for in-theme consistency and cross-theme stability, thanks to @tomturowski bug report.

Tags
since
2.5.4
reporter

@tomturowski

link
https://wordpress.org/support/topic/in-line-superscript-ref-rides-to-high/

C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT

Settings container key to configure the backlink tooltip.

public str C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT = "footnotes_inputfield_backlink_tooltip_text"
  • Update: Reference container: Hard backlinks (optional): optional configurable tooltip hinting to use the backbutton instead, thanks to @theroninjedi47 bug report.
Tags
since
2.5.4
reporter

@theroninjedi47

link
https://wordpress.org/support/topic/hyperlinked-footnotes-creating-excessive-back-history/

C_STR_FOOTNOTES_COUNTER_STYLE

Settings Container Key for the counter style of the footnotes.

public str C_STR_FOOTNOTES_COUNTER_STYLE = "footnote_inputfield_counter_style"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_FOOTNOTES_LOVE

Settings Container Key for the 'I love footnotes' text.

public str C_STR_FOOTNOTES_LOVE = "footnote_inputfield_love"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND

Settings Container Key for the mouse-over box to define the background color.

public str C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND = "footnote_inputfield_custom_mouse_over_box_background"
Tags
author

Stefan Herndler

since
1.5.6

C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR

Settings Container Key for the mouse-over box to define the border color.

public str C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR = "footnote_inputfield_custom_mouse_over_box_border_color"
Tags
author

Stefan Herndler

since
1.5.6

C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR

Settings Container Key for the mouse-over box to define the color.

public str C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR = "footnote_inputfield_custom_mouse_over_box_color"
Tags
author

Stefan Herndler

since
1.5.6

C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION

Settings Container Key for the mouse-over box to define the position.

public str C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION = "footnote_inputfield_custom_mouse_over_box_position"
Tags
author

Stefan Herndler

since
1.5.7

C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR

Settings Container Key for the mouse-over box to define the box-shadow color.

public str C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR = "footnote_inputfield_custom_mouse_over_box_shadow_color"
Tags
author

Stefan Herndler

since
1.5.8

C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT

public mixed C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT = "footnotes_inputfield_page_layout_support"

C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE

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

public str C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE = "footnotes_inputfield_reference_container_script_mode"
  • Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.
Tags
since
2.5.6
reporter

@hopper87it

link
https://wordpress.org/support/topic/footnotes-wp-rocket/

C_STR_FOOTNOTES_SHORT_CODE_END

Settings Container Key for the short code of the footnote’s end.

public str C_STR_FOOTNOTES_SHORT_CODE_END = "footnote_inputfield_placeholder_end"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED

Settings Container Key for the user-defined short code of the footnotes end.

public str C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED = "footnote_inputfield_placeholder_end_user_defined"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_FOOTNOTES_SHORT_CODE_START

Settings Container Key for the short code of the footnote’s start.

public str C_STR_FOOTNOTES_SHORT_CODE_START = "footnote_inputfield_placeholder_start"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED

Settings Container Key for the user-defined short code of the footnotes start.

public str C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED = "footnote_inputfield_placeholder_start_user_defined"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_FOOTNOTES_STYLING_AFTER

Settings Container Key for the string after the footnote referrer.

public str C_STR_FOOTNOTES_STYLING_AFTER = "footnote_inputfield_custom_styling_after"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_FOOTNOTES_STYLING_BEFORE

Settings Container Key for the string before the footnote referrer.

public str C_STR_FOOTNOTES_STYLING_BEFORE = "footnote_inputfield_custom_styling_before"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER

Settings container key to configure the tooltip excerpt delimiter.

public str C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER = "footnotes_inputfield_tooltip_excerpt_delimiter"
  • Update: Tooltips: ability to display dedicated content before [[/tooltip]], thanks to @jbj2199 issue report.

The first implementation used a fixed shortcode provided in the changelog. But Footnotes’ UI design policy is to make shortcodes freely configurable.

Tags
since
2.5.4
reporter

@jbj2199

link

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.

C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR

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

public str C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR = "footnotes_inputfield_tooltip_excerpt_mirror_separator"
Tags
since
2.5.4

C_STR_HARD_LINK_IDS_SEPARATOR

public mixed 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 str C_STR_HYPERLINK_ARROW = "footnote_inputfield_custom_hyperlink_symbol"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_HYPERLINK_ARROW_USER_DEFINED

Settings Container Key for the user-defined backlink symbol.

public str C_STR_HYPERLINK_ARROW_USER_DEFINED = "footnote_inputfield_custom_hyperlink_symbol_user"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT

public mixed C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT = "footnotes_inputfield_mouse_over_box_font_size_unit"

C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT

public mixed 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 str C_STR_REFERENCE_CONTAINER_NAME = "footnote_inputfield_references_label"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_REFERENCE_CONTAINER_POSITION

Settings Container Key for the position of the reference container.

public str C_STR_REFERENCE_CONTAINER_POSITION = "footnote_inputfield_reference_container_place"
Tags
author

Stefan Herndler

since
1.5.0

C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE

Settings Container Key for reference container position shortcode

public str C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE = "footnote_inputfield_reference_container_position_shortcode"
Tags
since
2.2.0

C_STR_REFERRER_FRAGMENT_ID_SLUG

public mixed C_STR_REFERRER_FRAGMENT_ID_SLUG = "footnotes_inputfield_referrer_fragment_id_slug"

Properties

$a_arr_Container

Contains all Settings Container names.

private array<string|int, mixed> $a_arr_Container = array("footnotes_storage", "footnotes_storage_custom", "footnotes_storage_expert", "footnotes_storage_custom_css")
Tags
author

Stefan Herndler

since
1.5.0

$a_arr_Default

Contains all Default Settings for each Settings Container.

private array<string|int, mixed> $a_arr_Default = array("footnotes_storage" => array( 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_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE => 'yes', self::C_STR_FOOTNOTES_COUNTER_STYLE => 'arabic_plain', self::C_BOOL_COMBINE_IDENTICAL_FOOTNOTES => 'yes', self::C_BOOL_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_INT_FOOTNOTES_SCROLL_OFFSET => 20, self::C_INT_FOOTNOTES_SCROLL_DURATION => 380, // 2.5.4 fast-tracked: self::C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE => 'yes', self::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT => 'Alt+ ←', self::C_STR_REFERENCE_CONTAINER_NAME => 'References', self::C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT => 'p', self::C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER => 'yes', self::C_BOOL_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_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE => 'yes', // whether to enqueue additional stylesheet: self::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT => 'none', // top and bottom margins: self::C_INT_REFERENCE_CONTAINER_TOP_MARGIN => 24, self::C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN => 0, // table cell borders: self::C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE => 'no', // backlink symbol: self::C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE => 'no', self::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE => 'yes', self::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH => 'no', // backlink separators and terminators are often not preferred. // but a choice must be provided along with the ability to customize: self::C_BOOL_BACKLINKS_SEPARATOR_ENABLED => 'yes', self::C_STR_BACKLINKS_SEPARATOR_OPTION => 'comma', self::C_STR_BACKLINKS_SEPARATOR_CUSTOM => '', self::C_BOOL_BACKLINKS_TERMINATOR_ENABLED => 'no', self::C_STR_BACKLINKS_TERMINATOR_OPTION => 'full_stop', self::C_STR_BACKLINKS_TERMINATOR_CUSTOM => '', // set backlinks column width: self::C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED => 'no', self::C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR => '50', self::C_STR_BACKLINKS_COLUMN_WIDTH_UNIT => 'px', // set backlinks column max. width: self::C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED => 'no', self::C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR => '140', self::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT => 'px', // whether a <br /> tag is inserted: self::C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED => 'no', // whether to enable URL line wrapping: self::C_BOOL_FOOTNOTE_URL_WRAP_ENABLED => 'yes', // whether to use link elements: self::C_BOOL_LINK_ELEMENT_ENABLED => 'yes', // excerpt should be disabled: self::C_BOOL_FOOTNOTES_IN_EXCERPT => 'no', self::C_BOOL_FOOTNOTES_EXPERT_MODE => 'yes', self::C_STR_FOOTNOTES_LOVE => 'no', ), "footnotes_storage_custom" => array( self::C_STR_HYPERLINK_ARROW => '&#8593;', self::C_STR_HYPERLINK_ARROW_USER_DEFINED => '', self::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL => 'Continue reading', self::C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS => 'yes', self::C_STR_FOOTNOTES_STYLING_BEFORE => '[', self::C_STR_FOOTNOTES_STYLING_AFTER => ']', self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED => 'yes', self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE => 'no', // The mouse over content truncation should be enabled by default // to raise awareness of the functionality and to prevent the screen // from being filled at mouse-over, and to allow the Continue reading: self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED => 'yes', // The truncation length is raised from 150 to 200 chars: self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH => 200, // 2.5.4 fast-tracked: self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER => '[[/tooltip]]', self::C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE => 'no', self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR => ' — ', self::C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT => 'no', // 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: self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION => 'top center', self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X => 0, // The vertical offset must be negative for the box not to cover // the current line of text (web coordinates origin is top left): self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y => -7, // The width should be limited to start with, for the box to have shape: self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH => 450, // fixed width is for alternative tooltips, cannot reuse max-width nor offsets: self::C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION => 'top right', self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X => -50, self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y => 24, self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH => 400, // tooltip display durations: // called mouse over box not tooltip for consistency 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 font size reset to legacy by default since 2.1.4; // was set to inherit since 2.1.1 as it overrode custom CSS, // is moved to settings since 2.1.4 2020-12-04T1023+0100 self::C_BOOL_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 => '', // The mouse over box shouldn’t feature a colored background // by default, due to diverging user preferences. White is neutral: 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', // The mouse over box corners mustn’t be rounded as that is outdated: self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS => 0, self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR => '#666666', // Custom CSS migrates to a dedicated tab: self::C_STR_CUSTOM_CSS => '', ), "footnotes_storage_expert" => array( // These are checkboxes; keyword 'checked' is converted to Boolean true, // empty string to false (default): // Titles should all be enabled by default to prevent users from // thinking at first that the feature is broken in post titles. // See <https://wordpress.org/support/topic/more-feature-ideas/> // Yet in titles, footnotes are still buggy, because WordPress // uses the title string in menus and in the title element. self::C_BOOL_EXPERT_LOOKUP_THE_TITLE => '', self::C_BOOL_EXPERT_LOOKUP_THE_CONTENT => 'checked', // And the_excerpt is disabled by default following @nikelaos in // <https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/#post-13110879> // <https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068> self::C_BOOL_EXPERT_LOOKUP_THE_EXCERPT => '', self::C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE => '', // 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. self::C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT => '', // initially hard-coded default // shows "9223372036854780000" instead of 9223372036854775807 in the numbox // empty should be interpreted as PHP_INT_MAX, but a numbox cannot be set to empty: // <https://github.com/Modernizr/Modernizr/issues/171> // interpret -1 as PHP_INT_MAX instead self::C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL => PHP_INT_MAX, // 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 short codes, causing issues with fake footnotes. self::C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL => 98, self::C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL => PHP_INT_MAX, self::C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL => PHP_INT_MAX, self::C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL => 98, ), "footnotes_storage_custom_css" => array(self::C_BOOL_CUSTOM_CSS_LEGACY_ENABLE => 'yes', self::C_STR_CUSTOM_CSS_NEW => ''))
Tags
author

Stefan Herndler

since
1.5.0
since
2.1.3

excerpt hook: disable by default, thanks to @nikelaos

link
https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068

$a_arr_Settings

Contains all Settings from each Settings container as soon as this class is initialized.

private array<string|int, mixed> $a_arr_Settings = array()
Tags
author

Stefan Herndler

since
1.5.0

$a_obj_Instance

Stores a singleton reference of this class.

private static MCI_Footnotes_Settings $a_obj_Instance = ull
Tags
author

Stefan Herndler

since
1.5.0

Methods

ClearAll()

Deletes each Settings Container and loads the default values for each Settings Container.

public ClearAll() : mixed
Tags
author

Stefan Herndler

since
1.5.0

Edit: This didn’t actually work.

since
2.2.0

this function is not called any longer when deleting the plugin, to protect user data against loss, since manually updating a plugin is safer done by deleting and reinstalling (see the warning about database backup). 2020-12-13T1353+0100

Return values
mixed —

get()

Returns the value of specified Settings name.

public get(string $p_str_Key) : mixed
Parameters
$p_str_Key : string

Settings Array Key name.

Tags
author

Stefan Herndler

since
1.5.0
Return values
mixed —

Value of the Setting on Success or Null in Settings name is invalid.

getContainer()

Returns the name of a specified Settings Container.

public getContainer(int $p_int_Index) : str
Parameters
$p_int_Index : int

Settings Container Array Key Index.

Tags
author

Stefan Herndler

since
1.5.0
Return values
str —

Settings Container name.

getDefaults()

Returns the default values of a specific Settings Container.

public getDefaults(int $p_int_Index) : array<string|int, mixed>
Parameters
$p_int_Index : int

Settings Container Aray Key Index.

Tags
author

Stefan Herndler

since
1.5.6
Return values
array<string|int, mixed> —

RegisterSettings()

Register all Settings Container for the Plugin Settings Page in the Dashboard.

public RegisterSettings() : mixed

Settings Container Label will be the same as the Settings Container Name.

Tags
author

Stefan Herndler

since
1.5.0
Return values
mixed —

saveOptions()

Updates a whole Settings container.

public saveOptions(int $p_int_Index, array<string|int, mixed> $p_arr_newValues) : bool
Parameters
$p_int_Index : int

Index of the Settings container.

$p_arr_newValues : array<string|int, mixed>

new Settings.

Tags
author

Stefan Herndler

since
1.5.0
Return values
bool —

__construct()

Class Constructor. Loads all Settings from each WordPress Settings container.

private __construct() : mixed
Tags
author

Stefan Herndler

since
1.5.0
Return values
mixed —

Load()

Loads all Settings from specified Settings Container.

private Load(int $p_int_Index) : array<string|int, mixed>
Parameters
$p_int_Index : int

Settings Container Array Key Index.

Tags
author

Stefan Herndler

since
1.5.0
since

ditched trimming whitespace from text box content in response to user request.

link
https://wordpress.org/support/topic/leading-space-in-footnotes-tag/#post-5347966
Return values
array<string|int, mixed> —

Settings loaded from Container of Default Settings if Settings Container is empty (first usage).

loadAll()

Loads all Settings from each Settings container.

private loadAll() : mixed
Tags
author

Stefan Herndler

since
1.5.0
Return values
mixed —

Search results