Documentation

Footnotes_Settings
in package

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

Tags
since
1.5.0

Table of Contents

C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR  = 'footnotes_inputfield_mouse_over_box_font_size_scalar'
Settings container key for the scalar value of the tooltip font size.
C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR  = 'footnotes_inputfield_backlinks_column_max_width_scalar'
Settings container key for the backlinks column max width scalar.
C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR  = 'footnotes_inputfield_backlinks_column_width_scalar'
Settings container key for the 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'
Settings container key for 'the_excerpt' hook priority level.
C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL  = 'footnote_inputfield_expert_lookup_the_title_priority_level'
Settings container key for 'the_title' hook priority level.
C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL  = 'footnote_inputfield_expert_lookup_widget_text_priority_level'
Settings container key for 'widget_text' hook priority level.
C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL  = 'footnote_inputfield_expert_lookup_widget_title_priority_level'
Settings container key for 'widget_title' hook priority level.
C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X  = 'footnotes_inputfield_alternative_mouse_over_box_offset_x'
Settings container key for alternative tooltip x offset.
C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y  = 'footnotes_inputfield_alternative_mouse_over_box_offset_y'
Settings container key for alternative tooltip y offset.
C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH  = 'footnotes_inputfield_alternative_mouse_over_box_width'
Settings container key for alternative tooltip 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_DOWN_DELAY  = 'footnotes_inputfield_scroll_down_delay'
Settings container key for scroll down delay.
C_INT_FOOTNOTES_SCROLL_DOWN_DURATION  = 'footnotes_inputfield_scroll_down_duration'
Settings container key for scroll down duration.
C_INT_FOOTNOTES_SCROLL_DURATION  = 'footnotes_inputfield_scroll_duration'
Settings container key for scroll duration.
C_INT_FOOTNOTES_SCROLL_OFFSET  = 'footnotes_inputfield_scroll_offset'
Settings container key for scroll offset.
C_INT_FOOTNOTES_SCROLL_UP_DELAY  = 'footnotes_inputfield_scroll_up_delay'
Settings container key for scroll up delay.
C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY  = 'footnotes_inputfield_mouse_over_box_fade_in_delay'
Settings container key for tooltip display fade-in delay.
C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION  = 'footnotes_inputfield_mouse_over_box_fade_in_duration'
Settings container key for tooltip display fade-in duration.
C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY  = 'footnotes_inputfield_mouse_over_box_fade_out_delay'
Settings container key for tooltip display fade-out delay.
C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION  = 'footnotes_inputfield_mouse_over_box_fade_out_duration'
Settings container key for tooltip display fade-out duration.
C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN  = 'footnotes_inputfield_reference_container_bottom_margin'
Settings container key for reference container bottom margin.
C_INT_REFERENCE_CONTAINER_TOP_MARGIN  = 'footnotes_inputfield_reference_container_top_margin'
Settings container key for reference container top margin.
C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED  = 'footnotes_inputfield_backlinks_column_max_width_enabled'
Settings container key to enable a max width for the backlinks column.
C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT  = 'footnotes_inputfield_backlinks_column_max_width_unit'
Settings container key for the backlinks column max width unit.
C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED  = 'footnotes_inputfield_backlinks_column_width_enabled'
Settings container key to enable the backlinks column width.
C_STR_BACKLINKS_COLUMN_WIDTH_UNIT  = 'footnotes_inputfield_backlinks_column_width_unit'
Settings container key for the backlinks column width unit.
C_STR_BACKLINKS_LINE_BREAKS_ENABLED  = 'footnotes_inputfield_backlinks_line_breaks_enabled'
Settings container key to enable line breaks between backlinks.
C_STR_BACKLINKS_SEPARATOR_CUSTOM  = 'footnotes_inputfield_backlinks_separator_custom'
Settings container key for a custom backlink separator.
C_STR_BACKLINKS_SEPARATOR_ENABLED  = 'footnotes_inputfield_backlinks_separator_enabled'
Settings container key to enable the presence of a backlink separator.
C_STR_BACKLINKS_SEPARATOR_OPTION  = 'footnotes_inputfield_backlinks_separator_option'
Settings container key for the backlink separator options.
C_STR_BACKLINKS_TERMINATOR_CUSTOM  = 'footnotes_inputfield_backlinks_terminator_custom'
Settings container key for a custom backlink terminator.
C_STR_BACKLINKS_TERMINATOR_ENABLED  = 'footnotes_inputfield_backlinks_terminator_enabled'
Settings container key to enable the presence of a backlink terminator.
C_STR_BACKLINKS_TERMINATOR_OPTION  = 'footnotes_inputfield_backlinks_terminator_option'
Settings container key for the backlink terminator options.
C_STR_COMBINE_IDENTICAL_FOOTNOTES  = 'footnote_inputfield_combine_identical'
Settings container key for combining identical footnotes.
C_STR_CUSTOM_CSS  = 'footnote_inputfield_custom_css'
Settings container key for the Custom CSS.
C_STR_CUSTOM_CSS_LEGACY_ENABLE  = 'footnote_inputfield_custom_css_legacy_enable'
Settings container key to enable display of legacy Custom CSS metaboxes.
C_STR_CUSTOM_CSS_NEW  = 'footnote_inputfield_custom_css_new'
Settings container key for the Custom CSS migrated to a dedicated tab.
C_STR_EXPERT_LOOKUP_THE_CONTENT  = 'footnote_inputfield_expert_lookup_the_content'
Settings container key to enable the 'the_content' hook.
C_STR_EXPERT_LOOKUP_THE_EXCERPT  = 'footnote_inputfield_expert_lookup_the_excerpt'
Settings container key to enable the 'the_excerpt' hook.
C_STR_EXPERT_LOOKUP_THE_TITLE  = 'footnote_inputfield_expert_lookup_the_title'
Settings container key to enable the 'the_title' hook.
C_STR_EXPERT_LOOKUP_WIDGET_TEXT  = 'footnote_inputfield_expert_lookup_widget_text'
Settings container key to enable the 'widget_text' hook.
C_STR_EXPERT_LOOKUP_WIDGET_TITLE  = 'footnote_inputfield_expert_lookup_widget_title'
Settings container key to enable the 'widget_title' hook.
C_STR_FOOTNOTE_FRAGMENT_ID_SLUG  = 'footnotes_inputfield_footnote_fragment_id_slug'
Settings container key for the fragment ID slug in footnotes.
C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT  = 'footnotes_inputfield_referrers_normal_superscript'
Settings container key to enable superscript style normalization.
C_STR_FOOTNOTE_SECTION_SHORTCODE  = 'footnotes_inputfield_section_shortcode'
Settings container key for the footnote section shortcode.
C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE  = 'footnotes_inputfield_shortcode_syntax_validation_enable'
Settings container key to enable shortcode syntax validation.
C_STR_FOOTNOTE_URL_WRAP_ENABLED  = 'footnote_inputfield_url_wrap_enabled'
Settings container key for URL wrap option.
C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION  = 'footnotes_inputfield_alternative_mouse_over_box_position'
Settings container key for alternative tooltip position.
C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE  = 'footnotes_inputfield_amp_compatibility_enable'
Settings container key to enable AMP compatibility mode.
C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE  = 'footnotes_inputfield_backlink_tooltip_enable'
Settings container key to enable backlink tooltips.
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_CSS_SMOOTH_SCROLLING  = 'footnotes_inputfield_css_smooth_scrolling'
Settings container key to enable CSS smooth scrolling.
C_STR_FOOTNOTES_EXPERT_MODE  = 'footnote_inputfield_enable_expert_mode'
Settings container key for the Expert mode.
C_STR_FOOTNOTES_HARD_LINKS_ENABLE  = 'footnotes_inputfield_hard_links_enable'
Settings container key to enable hard links.
C_STR_FOOTNOTES_IN_EXCERPT  = 'footnote_inputfield_search_in_excerpt'
Settings container key to look for footnotes in post excerpts.
C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION  = 'footnotes_inputfield_label_issue_solution'
Settings container key to set the solution of the input element label issue.
C_STR_FOOTNOTES_LOVE  = 'footnote_inputfield_love'
Settings container key for the 'I love footnotes' text.
C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE  = 'footnote_inputfield_custom_mouse_over_box_alternative'
Settings container key to enable the alternative tooltips.
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_ENABLED  = 'footnote_inputfield_custom_mouse_over_box_enabled'
Settings container key to enable the mouse-over box.
C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED  = 'footnote_inputfield_custom_mouse_over_box_excerpt_enabled'
Settings container key to enable tooltip truncation.
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'
Settings container key for basic responsive page layout support options.
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_REFERRER_SUPERSCRIPT_TAGS  = 'footnotes_inputfield_referrer_superscript_tags'
Settings container key for the referrer element.
C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY  = 'footnotes_inputfield_scroll_duration_asymmetricity'
Settings container key for scroll duration asymmetricity.
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_ENABLE  = 'footnotes_inputfield_tooltip_excerpt_mirror_enable'
Settings container key to enable mirroring the tooltip excerpt in the reference container.
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'
Settings container key for the ID separator in fragment IDs.
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_LINK_ELEMENT_ENABLED  = 'footnote_inputfield_link_element_enabled'
Settings container key for the link element option.
C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED  = 'footnotes_inputfield_mouse_over_box_font_size_enabled'
Settings container key to enable setting the tooltip font size.
C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT  = 'footnotes_inputfield_mouse_over_box_font_size_unit'
Settings container key for the unit of the tooltip font size.
C_STR_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_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE  = 'footnotes_inputfield_reference_container_backlink_symbol_enable'
Settings container key to enable the display of a backlink symbol.
C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH  = 'footnotes_inputfield_reference_container_backlink_symbol_switch'
Settings container key to get the backlink symbol switch side.
C_STR_REFERENCE_CONTAINER_COLLAPSE  = 'footnote_inputfield_collapse_references'
Settings container key to collapse the reference container by default.
C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER  = 'footnotes_inputfield_reference_container_label_bottom_border'
Settings container key to enable the reference container label bottom border.
C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT  = 'footnotes_inputfield_reference_container_label_element'
Settings container key for the 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_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE  = 'footnotes_inputfield_reference_container_row_borders_enable'
Settings container key to enable reference container table row borders.
C_STR_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_STR_REFERRER_FRAGMENT_ID_SLUG  = 'footnotes_inputfield_referrer_fragment_id_slug'
Settings container key for the fragment ID slug in referrers.
$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  : Footnotes_Settings
Stores a singleton reference of this class.
clear_all()  : mixed
Deletes each Settings Container and loads the default values for each Settings Container.
get()  : mixed
Returns the value of specified Settings name.
get_container()  : str
Returns the name of a specified Settings Container.
get_defaults()  : array<string|int, mixed>
Returns the default values of a specific Settings Container.
instance()  : Footnotes_Settings
Returns a singleton of this class.
register_settings()  : mixed
Register all Settings Container for the Plugin Settings Page in the Dashboard.
save_options()  : 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.
load_all()  : mixed
Loads all Settings from each Settings container.

Constants

C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR

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

public flo C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR = 'footnotes_inputfield_mouse_over_box_font_size_scalar'
Tags
since
2.1.4

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'
Tags
since
2.1.4

Settings container key for the backlinks column width scalar.

public int C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR = 'footnotes_inputfield_backlinks_column_width_scalar'
Tags
since
2.1.4

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'
  • Bugfix: Reference container: fix relative position through priority level, thanks to @june01 @imeson @spaceling bug reports, thanks to @spaceling code contribution.
Tags
contributor

@spaceling

link
https://wordpress.org/support/topic/change-the-position-5/#post-13608594
link
https://wordpress.org/support/topic/change-the-position-5/
link
https://wordpress.org/support/topic/change-the-position-5/#post-13538345
link
  • Bugfix: Dashboard: priority level setting for the_content hook, thanks to @imeson bug report.
link
https://wordpress.org/support/topic/change-the-position-5/#post-13538345
link
https://wordpress.org/support/topic/code-showing-up-in-references/
link
https://github.com/Modernizr/Modernizr/issues/171
reporter

@june01

reporter

@imeson

reporter

@imeson

reporter

@marthalindeman

since
2.0.5
since
2.1.1
  • Bugfix: Priority levels: set the_content priority level to 98 to prevent plugin conflict, thanks to @marthalindeman bug report.
since
2.1.6

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.

Setting the_content priority to 10 instead of PHP_INT_MAX i.e. 9223372036854775807 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 YARPP to display related posts below the Footnotes reference container, priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =< 1200).

PHP_INT_MAX cannot be reset by leaving the number box empty. because browsers (WebKit) 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'
Tags
since
2.1.2

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'
Tags
since
2.1.2

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'
Tags
since
2.1.2

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'
Tags
since
2.2.5

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'
Tags
since
2.2.5

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'
Tags
since
2.2.5

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'
Tags
since
1.5.6
since
2.0.7

The mouse over box corners mustn’t be rounded as that is outdated.

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'
Tags
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 int C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH = 'footnote_inputfield_custom_mouse_over_box_excerpt_length'
Tags
since
1.5.4
since
2.0.7

Increase default truncation length from 150 to 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'
Tags
since
1.5.6
since
2.0.7

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

C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X

Settings container key for the mouse-over box to define the offset (x).

public int C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X = 'footnote_inputfield_custom_mouse_over_box_offset_x'
Tags
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 int C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y = 'footnote_inputfield_custom_mouse_over_box_offset_y'
Tags
since
1.5.7

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'
Tags
since
2.5.11

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'
Tags
since
2.5.11

C_INT_FOOTNOTES_SCROLL_DURATION

Settings container key for scroll duration.

public int C_INT_FOOTNOTES_SCROLL_DURATION = 'footnotes_inputfield_scroll_duration'
  • Bugfix: Scroll duration: make configurable to conform to website content and style requirements.
Tags
since
2.1.4

C_INT_FOOTNOTES_SCROLL_OFFSET

Settings container key for scroll offset.

public int C_INT_FOOTNOTES_SCROLL_OFFSET = 'footnotes_inputfield_scroll_offset'
  • Bugfix: Scroll offset: make configurable to fix site-dependent issues related to fixed headers.
Tags
since
2.1.4

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'
Tags
since
2.5.11

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'
Tags
since
2.1.4

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'
Tags
since
2.1.4

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'
Tags
since
2.1.4

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'
Tags
since
2.1.4

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

public str C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED = 'footnotes_inputfield_backlinks_column_max_width_enabled'
Tags
since
2.1.4

Settings container key for the backlinks column max width unit.

public str C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT = 'footnotes_inputfield_backlinks_column_max_width_unit'
Tags
since
2.1.4

Settings container key to enable the backlinks column width.

public str C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED = 'footnotes_inputfield_backlinks_column_width_enabled'
Tags
since
2.1.4

Settings container key for the backlinks column width unit.

public str C_STR_BACKLINKS_COLUMN_WIDTH_UNIT = 'footnotes_inputfield_backlinks_column_width_unit'
Tags
since
2.1.4

Settings container key to enable line breaks between backlinks.

public str C_STR_BACKLINKS_LINE_BREAKS_ENABLED = 'footnotes_inputfield_backlinks_line_breaks_enabled'
Tags
since
2.1.4

Settings container key for a custom backlink separator.

public str C_STR_BACKLINKS_SEPARATOR_CUSTOM = 'footnotes_inputfield_backlinks_separator_custom'
Tags
since
2.1.4

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

public str C_STR_BACKLINKS_SEPARATOR_ENABLED = 'footnotes_inputfield_backlinks_separator_enabled'
  • Bugfix: Reference container: make separating and terminating punctuation optional and configurable, thanks to @docteurfitness issue report and code contribution.
Tags
contributor

@docteurfitness

link
https://wordpress.org/support/topic/update-2-1-3/#post-13704194
since
2.1.4

Settings container key for the backlink separator options.

public str C_STR_BACKLINKS_SEPARATOR_OPTION = 'footnotes_inputfield_backlinks_separator_option'
Tags
since
2.1.4

Settings container key for a custom backlink terminator.

public str C_STR_BACKLINKS_TERMINATOR_CUSTOM = 'footnotes_inputfield_backlinks_terminator_custom'
Tags
since
2.1.4

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

public str C_STR_BACKLINKS_TERMINATOR_ENABLED = 'footnotes_inputfield_backlinks_terminator_enabled'
Tags
since
2.1.4

Settings container key for the backlink terminator options.

public str C_STR_BACKLINKS_TERMINATOR_OPTION = 'footnotes_inputfield_backlinks_terminator_option'
Tags
since
2.1.4

C_STR_COMBINE_IDENTICAL_FOOTNOTES

Settings container key for combining identical footnotes.

public str C_STR_COMBINE_IDENTICAL_FOOTNOTES = 'footnote_inputfield_combine_identical'
Tags
since
1.5.0

C_STR_CUSTOM_CSS

Settings container key for the Custom CSS.

public str C_STR_CUSTOM_CSS = 'footnote_inputfield_custom_css'
Tags
since
1.5.0
since
1.3.0

Adding: new settings tab for custom CSS settings.

C_STR_CUSTOM_CSS_LEGACY_ENABLE

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

public str C_STR_CUSTOM_CSS_LEGACY_ENABLE = 'footnote_inputfield_custom_css_legacy_enable'
Tags
since
2.2.2
since
2.3.0

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 to_bool() converts empty to false.

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'
  • Update: Dashboard: Custom CSS: unearth text area and migrate to dedicated tab as designed.
Tags
since
2.2.2

C_STR_EXPERT_LOOKUP_THE_CONTENT

Settings container key to enable the 'the_content' hook.

public str C_STR_EXPERT_LOOKUP_THE_CONTENT = 'footnote_inputfield_expert_lookup_the_content'
Tags
since
1.5.5

C_STR_EXPERT_LOOKUP_THE_EXCERPT

Settings container key to enable the 'the_excerpt' hook.

public str C_STR_EXPERT_LOOKUP_THE_EXCERPT = 'footnote_inputfield_expert_lookup_the_excerpt'
Tags
since
1.5.5
  • Bugfix: Hooks: disable the_excerpt hook by default to fix issues, thanks to @nikelaos bug report.
since
2.1.3
since
2.6.3

Enable by default after debugging the 'Footnotes in excerpts' setting.

  • Bugfix: Hooks: default-disable the_excerpt hook with respect to theme-specific excerpt handling, thanks to @mmallett bug reports.
since
2.6.5
reporter

@nikelaos

reporter

@mmallett

link
https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068
link
https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/#post-13110879
link
https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068
link
https://wordpress.org/support/topic/broken-662/
link
https://wordpress.org/support/topic/update-crashed-my-website-3/#post-14260969
see
C_STR_FOOTNOTES_IN_EXCERPT

C_STR_EXPERT_LOOKUP_WIDGET_TEXT

Settings container key to enable the 'widget_text' hook.

public str C_STR_EXPERT_LOOKUP_WIDGET_TEXT = 'footnote_inputfield_expert_lookup_widget_text'
Tags
since
1.5.5

C_STR_EXPERT_LOOKUP_WIDGET_TITLE

Settings container key to enable the 'widget_title' hook.

public str C_STR_EXPERT_LOOKUP_WIDGET_TITLE = 'footnote_inputfield_expert_lookup_widget_title'
Tags
since
1.5.5

C_STR_FOOTNOTE_FRAGMENT_ID_SLUG

Settings container key for the fragment ID slug in footnotes.

public str C_STR_FOOTNOTE_FRAGMENT_ID_SLUG = 'footnotes_inputfield_footnote_fragment_id_slug'
Tags
since
2.3.0

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
reporter

@tomturowski

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

C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE

Settings container key to enable shortcode syntax validation.

public str C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE = 'footnotes_inputfield_shortcode_syntax_validation_enable'
Tags
since
2.4.0

C_STR_FOOTNOTE_URL_WRAP_ENABLED

Settings container key for URL wrap option.

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

Tags
since
2.1.6

C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION

Settings container key for alternative tooltip position.

public str C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION = 'footnotes_inputfield_alternative_mouse_over_box_position'
Tags
since
2.2.5

C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE

Settings container key to enable AMP compatibility mode.

public str C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE = 'footnotes_inputfield_amp_compatibility_enable'
  • Adding: Tooltips: make display work purely by style rules for AMP compatibility, thanks to @milindmore22 code contribution.
  • Bugfix: Tooltips: enable accessibility by keyboard navigation, thanks to @westonruter code contribution.
  • Adding: Reference container: get expanding and collapsing to work also in AMP compatibility mode, thanks to @westonruter code contribution.
Tags
contributor

@milindmore22

contributor

@westonruter

link
https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933
link
https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785419655
link
https://github.com/markcheret/footnotes/issues/48#issuecomment-799580854
link
https://github.com/markcheret/footnotes/issues/48#issuecomment-799582394
since
2.5.11

(draft)

since
2.6.0

(release)

Settings container key to enable backlink tooltips.

public str C_STR_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
reporter

@theroninjedi47

link
https://wordpress.org/support/topic/hyperlinked-footnotes-creating-excessive-back-history/
link
https://wordpress.org/support/topic/making-it-amp-compatible/#post-13837359
since
2.5.4

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
reporter

@theroninjedi47

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

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
since
1.5.0

C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING

Settings container key to enable CSS smooth scrolling.

public str C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING = 'footnotes_inputfield_css_smooth_scrolling'
  • Update: Scrolling: CSS-based smooth scroll behavior (optional), thanks to @paulgpetty and @bogosavljev issue reports.
Tags
reporter

@paulgpetty

reporter

@bogosavljev

link
https://wordpress.org/support/topic/functionally-great/#post-13607795
link
https://wordpress.org/support/topic/compatibility-issue-with-wpforms/#post-14214720
since
2.5.12

C_STR_FOOTNOTES_EXPERT_MODE

Settings container key for the Expert mode.

public str C_STR_FOOTNOTES_EXPERT_MODE = 'footnote_inputfield_enable_expert_mode'
Tags
since
1.5.5
since
2.1.6

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

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.

Settings container key to enable hard links.

public str C_STR_FOOTNOTES_HARD_LINKS_ENABLE = 'footnotes_inputfield_hard_links_enable'
  • Adding: Referrers and backlinks: optional hard links for AMP compatibility, thanks to @psykonevro issue report, thanks to @martinneumannat issue report and code contribution.
Tags
contributor

@martinneumannat

link
https://wordpress.org/support/topic/making-it-amp-compatible/
link
https://wordpress.org/support/topic/footnotes-is-not-amp-compatible/
reporter

@psykonevro

since
2.3.0

C_STR_FOOTNOTES_IN_EXCERPT

Settings container key to look for footnotes in post excerpts.

public str C_STR_FOOTNOTES_IN_EXCERPT = 'footnote_inputfield_search_in_excerpt'
Tags
since
1.5.0
since
2.6.2

Debug No option.

since
2.6.3

Enable by default after debugging both Yes and No options.

  • Bugfix: Excerpts: make excerpt handling backward compatible, thanks to @mfessler bug report.
since
2.7.0
reporter

@mfessler

link
https://github.com/markcheret/footnotes/issues/65
see
C_STR_EXPERT_LOOKUP_THE_EXCERPT

C_STR_FOOTNOTES_LOVE

Settings container key for the 'I love footnotes' text.

public str C_STR_FOOTNOTES_LOVE = 'footnote_inputfield_love'
Tags
since
1.5.0

C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE

Settings container key to enable the alternative tooltips.

public str C_STR_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
reporter

@andreasra

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

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
since
1.5.6
since
1.2.5..1.5.5

#fff7a7 hard-coded.

since
1.5.6..2.0.6

#fff7a7 setting default. The mouse over box shouldn’t feature a colored background. By default, due to diverging user preferences. White is neutral.

since
2.0.7..2.5.10

#ffffff setting default.

  • Bugfix: Tooltips: Styling: Background color: empty default value to adopt theme background, thanks to 4msc bug report.
since
2.5.11

Theme default background color is best. But theme default background color doesn’t seem to exist.

since
2.6.1

default #ffffff again along with #000000 as font color.

reporter

@4msc

link
https://wordpress.org/support/topic/tooltip-not-showing-on-dark-theme-with-white-text/
link
https://wordpress.org/support/topic/problem-with-footnotes-in-excerpts-of-the-blog-page/#post-14241849
see
C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR

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
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
since
1.5.6
  • Bugfix: Tooltips: Styling: Font color: set to black for maximum contrast with respect to white default background, thanks to 4msc bug report.
since
2.6.1
reporter

@4msc

link
https://wordpress.org/support/topic/tooltip-not-showing-on-dark-theme-with-white-text/
see
C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND

C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED

Settings container key to enable the mouse-over box.

public str C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED = 'footnote_inputfield_custom_mouse_over_box_enabled'
Tags
since
1.5.2

C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED

Settings container key to enable tooltip truncation.

public str C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED = 'footnote_inputfield_custom_mouse_over_box_excerpt_enabled'
Tags
since
1.5.4

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
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
since
1.5.8

C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT

Settings container key for basic responsive page layout support options.

public str C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT = 'footnotes_inputfield_page_layout_support'
Tags
since
2.1.4

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
reporter

@hopper87it

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

C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY

Settings container key for scroll duration asymmetricity.

public str C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY = 'footnotes_inputfield_scroll_duration_asymmetricity'
Tags
since
2.5.11

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
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
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
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
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
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
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
reporter

@jbj2199

link
https://wordpress.org/support/topic/change-tooltip-text/
since
2.5.4

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

Settings container key for the ID separator in fragment IDs.

public str C_STR_HARD_LINK_IDS_SEPARATOR = 'footnotes_inputfield_hard_link_ids_separator'
Tags
since
2.3.0

Settings container key for the user-defined backlink symbol.

public str C_STR_HYPERLINK_ARROW_USER_DEFINED = 'footnote_inputfield_custom_hyperlink_symbol_user'
Tags
since
1.5.0

C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED

Settings container key to enable setting the tooltip font size.

public str C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED = 'footnotes_inputfield_mouse_over_box_font_size_enabled'
Tags
since
2.1.4

C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT

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

public str C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT = 'footnotes_inputfield_mouse_over_box_font_size_unit'
Tags
since
2.1.4

C_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE

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

public str C_STR_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

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

public str C_STR_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
reporter

@spaceling

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

Settings container key to get the backlink symbol switch side.

public str C_STR_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
contributor

@spaceling

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

C_STR_REFERENCE_CONTAINER_COLLAPSE

Settings container key to collapse the reference container by default.

public str C_STR_REFERENCE_CONTAINER_COLLAPSE = 'footnote_inputfield_collapse_references'
Tags
since
1.5.0
see
Footnotes_Convert::to_bool()

C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER

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

public str C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER = 'footnotes_inputfield_reference_container_label_bottom_border'
  • Bugfix: Reference container: Label: make bottom border an option, thanks to @markhillyer issue report.
Tags
reporter

@markhillyer

link
https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/
since
2.2.5

C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT

Settings container key for the reference container label element.

public str C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT = 'footnotes_inputfield_reference_container_label_element'
  • Bugfix: Reference container: Label: option to select paragraph or heading element, thanks to @markhillyer issue report.
Tags
reporter

@markhillyer

link
https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/
since
2.2.5

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
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
since
1.5.0

C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE

Settings container key to enable reference container table row borders.

public str C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE = 'footnotes_inputfield_reference_container_row_borders_enable'
  • Bugfix: Reference container: add option for table borders to restore pre-2.0.0 design, thanks to @noobishh issue report.
Tags
reporter

@noobishh

link
https://wordpress.org/support/topic/borders-25/
since
2.2.10

C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE

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

public str C_STR_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
reporter

@dragon013

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

C_STR_REFERRER_FRAGMENT_ID_SLUG

Settings container key for the fragment ID slug in referrers.

public str C_STR_REFERRER_FRAGMENT_ID_SLUG = 'footnotes_inputfield_referrer_fragment_id_slug'
Tags
since
2.3.0

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
since
1.5.0

$a_arr_default

Contains all Default Settings for each Settings Container.

private array<string|int, mixed> $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 => '', ), )
Tags
since
1.5.0

$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
since
1.5.0

Methods

clear_all()

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

public clear_all() : mixed
Tags
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).

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
since
1.5.0
Return values
mixed

Value of the Setting on Success or Null in Settings name 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 Array Key Index.

Tags
since
1.5.0
Return values
str

Settings Container name.

get_defaults()

Returns the default values of a specific Settings Container.

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

Settings Container Aray Key Index.

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

register_settings()

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

public register_settings() : mixed

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

Tags
since
1.5.0
Return values
mixed

save_options()

Updates a whole Settings container.

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

Index of the Settings container.

$p_arr_new_values : array<string|int, mixed>

new Settings.

Tags
since
1.5.0
Return values
bool

__construct()

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

private __construct() : mixed
Tags
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
since
1.5.0
  • Bugfix: Removed the 'trim' function to allow leading and trailing whitespace in settings text boxes, thanks to @compasscare bug report.
since
1.5.2
reporter

@compasscare

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

Settings loaded from defaults if container is empty (first usage).

load_all()

Loads all Settings from each Settings container.

private load_all() : mixed
Tags
since
1.5.0
Return values
mixed

Search results