get(MCI_Footnotes_Settings::C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL)); $p_int_TheContentPriority = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL)); $p_int_TheExcerptPriority = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL)); $p_int_WidgetTitlePriority = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL)); $p_int_WidgetTextPriority = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL)); // PHP_INT_MAX can be set by -1: $p_int_TheTitlePriority = ($p_int_TheTitlePriority == -1) ? PHP_INT_MAX : $p_int_TheTitlePriority ; $p_int_TheContentPriority = ($p_int_TheContentPriority == -1) ? PHP_INT_MAX : $p_int_TheContentPriority ; $p_int_TheExcerptPriority = ($p_int_TheExcerptPriority == -1) ? PHP_INT_MAX : $p_int_TheExcerptPriority ; $p_int_WidgetTitlePriority = ($p_int_WidgetTitlePriority == -1) ? PHP_INT_MAX : $p_int_WidgetTitlePriority; $p_int_WidgetTextPriority = ($p_int_WidgetTextPriority == -1) ? PHP_INT_MAX : $p_int_WidgetTextPriority ; // append custom css to the header add_filter('wp_head', array($this, "wp_head"), PHP_INT_MAX); // append the love and share me slug to the footer add_filter('wp_footer', array($this, "wp_footer"), PHP_INT_MAX); if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_EXPERT_LOOKUP_THE_TITLE))) { add_filter('the_title', array($this, "the_title"), $p_int_TheTitlePriority); } // configurable priority level for reference container relative positioning; default 98: if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_EXPERT_LOOKUP_THE_CONTENT))) { add_filter('the_content', array($this, "the_content"), $p_int_TheContentPriority); /** * HOOK FOR CATEGORY PAGES * * Hooks: support footnotes on category pages, thanks to @vitaefit bug report, thanks to @misfist code contribution * @datestamp 2021-01-05T1402+0100 * @since 2.5.0 * * @reporter @vitaefit * @bugreport https://wordpress.org/support/topic/footnote-doesntwork-on-category-page/ * * @contributor @misfist * @source https://wordpress.org/support/topic/footnote-doesntwork-on-category-page/#post-13864859 * * Category pages can have rich HTML content in a term description with article status. * For this to happen, WordPress’ built-in partial HTML blocker needs to be disabled. * @link https://docs.woocommerce.com/document/allow-html-in-term-category-tag-descriptions/ */ add_filter('term_description', array($this, "the_content"), $p_int_TheContentPriority); /** * HOOK FOR POPUP MAKER POPUPS * * Hooks: support footnotes in Popup Maker popups, thanks to @squatcher bug report * @since 2.5.1 * @datestamp 2021-01-18T2038+0100 * * @reporter @squatcher * @bugreport https://wordpress.org/support/topic/footnotes-use-in-popup-maker/ */ add_filter('pum_popup_content', array($this, "the_content"), $p_int_TheContentPriority); } if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_EXPERT_LOOKUP_THE_EXCERPT))) { add_filter('the_excerpt', array($this, "the_excerpt"), $p_int_TheExcerptPriority); } if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE))) { add_filter('widget_title', array($this, "widget_title"), $p_int_WidgetTitlePriority); } if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT))) { add_filter('widget_text', array($this, "widget_text"), $p_int_WidgetTextPriority); } /** * THE the_post HOOK * * support the_post hook in response to user request for custom post types * @since 1.5.4 * @accountable @aricura * @link https://wordpress.org/support/topic/doesnt-work-in-custon-post-types/#post-5339110 * * remove the_post hook after its default enabling caused multiple issues * @edit 2.0.9 * @accountable @pewgeuges * @datestamp 2020-11-08T1839+0100 * @link https://wordpress.org/support/topic/change-the-position-5/page/2/#post-13630114 * @link https://wordpress.org/support/topic/footnotes-appearing-in-header/#post-13630303 * @link https://wordpress.org/support/topic/footnotes-appearing-in-header/page/2/#post-13630799 * @link https://wordpress.org/support/topic/no-footnotes-anymore/#post-13813233 */ // reset stored footnotes when displaying the header self::$a_arr_Footnotes = array(); self::$a_bool_AllowLoveMe = true; } /** * Outputs the custom css to the header of the public page. * * @author Stefan Herndler * @since 1.5.0 * * @edited * * @since 2.1.1 Reference container: fix start pages by making its display optional, thanks to @dragon013 bug report * @since 2.1.1 option to hide ref container from start page * @since 2.1.1 script for alternative tooltips * @since 2.1.3 raise settings priority to override theme style sheets * @since 2.1.4 tootip font size and backlink column width settings * @since 2.2.5 options for label element and label bottom border, thanks to @markhillyer 2020-12-18T1447+0100 * @link https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/ * @since 2.3.0 Reference container: convert top padding to margin and make it a setting, thanks to @hamshe * @link https://wordpress.org/support/topic/reference-container-in-elementor/#post-13786635 */ public function wp_head() { // insert start tag without switching out of PHP: echo "\r\n\r\n"; // alternative tooltip script printed formatted not minified: if (self::$a_bool_AlternativeTooltipsEnabled) { ?> get(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION) == "footer") { echo $this->ReferenceContainer(); } // get setting for love and share this plugin $l_str_LoveMeIndex = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_LOVE); // check if the admin allows to add a link to the footer if (empty($l_str_LoveMeIndex) || strtolower($l_str_LoveMeIndex) == "no" || !self::$a_bool_AllowLoveMe) { return; } // set a hyperlink to the word "footnotes" in the Love slug $l_str_LinkedName = sprintf('%s', MCI_Footnotes_Config::C_STR_PLUGIN_PUBLIC_NAME); // get random love me text if (strtolower($l_str_LoveMeIndex) == "random") { $l_str_LoveMeIndex = "text-" . rand(1,7); } switch ($l_str_LoveMeIndex) { // options named wrt backcompat, simplest is default: case "text-1": $l_str_LoveMeText = sprintf(__('I %2$s %1$s', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), $l_str_LinkedName, MCI_Footnotes_Config::C_STR_LOVE_SYMBOL); break; case "text-2": $l_str_LoveMeText = sprintf(__('This website uses the awesome %s plugin.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), $l_str_LinkedName); break; case "text-4": $l_str_LoveMeText = sprintf('%s %s', $l_str_LinkedName, MCI_Footnotes_Config::C_STR_LOVE_SYMBOL); break; case "text-5": $l_str_LoveMeText = sprintf('%s %s', MCI_Footnotes_Config::C_STR_LOVE_SYMBOL, $l_str_LinkedName); break; case "text-6": $l_str_LoveMeText = sprintf(__('This website uses %s.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), $l_str_LinkedName); break; case "text-7": $l_str_LoveMeText = sprintf(__('This website uses the %s plugin.', MCI_Footnotes_Config::C_STR_PLUGIN_NAME), $l_str_LinkedName); break; case "text-3": default: $l_str_LoveMeText = sprintf('%s', $l_str_LinkedName); break; } echo sprintf('
%s
', $l_str_LoveMeText); } /** * Replaces footnotes in the post/page title. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Widget content. * @return string Content with replaced footnotes. */ public function the_title($p_str_Content) { // appends the reference container if set to "post_end" return $this->exec($p_str_Content, false); } /** * Replaces footnotes in the content of the current page/post. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Page/Post content. * @return string Content with replaced footnotes. */ public function the_content($p_str_Content) { // appends the reference container if set to "post_end" return $this->exec($p_str_Content, MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION) == "post_end" ? true : false); } /** * Replaces footnotes in the excerpt of the current page/post. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Page/Post content. * @return string Content with replaced footnotes. */ public function the_excerpt($p_str_Content) { return $this->exec($p_str_Content, false, !MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_IN_EXCERPT))); } /** * Replaces footnotes in the widget title. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Widget content. * @return string Content with replaced footnotes. */ public function widget_title($p_str_Content) { // appends the reference container if set to "post_end" return $this->exec($p_str_Content, false); } /** * Replaces footnotes in the content of the current widget. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Widget content. * @return string Content with replaced footnotes. */ public function widget_text($p_str_Content) { // appends the reference container if set to "post_end" return $this->exec($p_str_Content, MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION) == "post_end" ? true : false); } /** * Replaces footnotes in each Content var of the current Post object. * * @author Stefan Herndler * @since 1.5.4 * @param array|WP_Post $p_mixed_Posts */ public function the_post(&$p_mixed_Posts) { // single WP_Post object received if (!is_array($p_mixed_Posts)) { $p_mixed_Posts = $this->replacePostObject($p_mixed_Posts); return; } // array of WP_Post objects received for($l_int_Index = 0; $l_int_Index < count($p_mixed_Posts); $l_int_Index++) { $p_mixed_Posts[$l_int_Index] = $this->replacePostObject($p_mixed_Posts[$l_int_Index]); } } /** * Replace all Footnotes in a WP_Post object. * * @author Stefan Herndler * @since 1.5.6 * @param WP_Post $p_obj_Post * @return WP_Post */ private function replacePostObject($p_obj_Post) { //MCI_Footnotes_Convert::debug($p_obj_Post); $p_obj_Post->post_content = $this->exec($p_obj_Post->post_content); $p_obj_Post->post_content_filtered = $this->exec($p_obj_Post->post_content_filtered); $p_obj_Post->post_excerpt = $this->exec($p_obj_Post->post_excerpt); return $p_obj_Post; } /** * Replaces all footnotes that occur in the given content. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Any string that may contain footnotes to be replaced. * @param bool $p_bool_OutputReferences Appends the Reference Container to the output if set to true, default true. * @param bool $p_bool_HideFootnotesText Hide footnotes found in the string. * @return string * * Edited: * @since 2.2.0 insert reference container at shortcode, thanks to @hamshe 2020-12-13T2057+0100 * @link https://wordpress.org/support/topic/reference-container-in-elementor/ * * @since 2.2.5 delete unused position shortcode, when position is widget or footer, thanks to @hamshe 2020-12-18T1434+0100 * @link https://wordpress.org/support/topic/reference-container-in-elementor/#post-13784126 */ public function exec($p_str_Content, $p_bool_OutputReferences = false, $p_bool_HideFootnotesText = false) { // replace all footnotes in the content, settings are converted to html characters $p_str_Content = $this->search($p_str_Content, true, $p_bool_HideFootnotesText); // replace all footnotes in the content, settings are NOT converted to html characters $p_str_Content = $this->search($p_str_Content, false, $p_bool_HideFootnotesText); // append the reference container or insert at shortcode: $l_str_ReferenceContainerPositionShortcode = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE); if ( empty( $l_str_ReferenceContainerPositionShortcode ) ) { $l_str_ReferenceContainerPositionShortcode = '[[references]]'; } if ( $p_bool_OutputReferences ) { if ( strpos( $p_str_Content, $l_str_ReferenceContainerPositionShortcode ) !== false ) { $p_str_Content = str_replace( $l_str_ReferenceContainerPositionShortcode, $this->ReferenceContainer(), $p_str_Content ); } else { $p_str_Content .= $this->ReferenceContainer(); } // increment the container ID: self::$a_int_ReferenceContainerId++; } // delete position shortcode should any remain e.g. when ref container is in footer, thanks to @hamshe: $p_str_Content = str_replace( $l_str_ReferenceContainerPositionShortcode, '', $p_str_Content ); // take a look if the LOVE ME slug should NOT be displayed on this page/post, remove the short code if found if (strpos($p_str_Content, MCI_Footnotes_Config::C_STR_NO_LOVE_SLUG) !== false) { self::$a_bool_AllowLoveMe = false; $p_str_Content = str_replace(MCI_Footnotes_Config::C_STR_NO_LOVE_SLUG, "", $p_str_Content); } // return the content with replaced footnotes and optional reference container appended: return $p_str_Content; } /** * Replaces all footnotes in the given content and appends them to the static property. * * @author Stefan Herndler * @since 1.5.0 * @param string $p_str_Content Content to be searched for footnotes. * @param bool $p_bool_ConvertHtmlChars html encode settings, default true. * @param bool $p_bool_HideFootnotesText Hide footnotes found in the string. * @return string * * Edited since 2.0.0 * * @since 2.4.0 footnote shortcode syntax validation * @since 2.5.0 Shortcode syntax validation: exclude certain cases involving scripts, thanks to @andreasra 2021-01-07T0824+0100 * @since 2.5.0 Shortcode syntax validation: complete message with hint about setting, thanks to @andreasra * @since 2.5.0 Shortcode syntax validation: limit length of quoted string to 300 characters, thanks to @andreasra * @link https://wordpress.org/support/topic/warning-unbalanced-footnote-start-tag-short-code-before/ */ public function search($p_str_Content, $p_bool_ConvertHtmlChars, $p_bool_HideFootnotesText) { // post ID to make everything unique wrt infinite scroll and archive view self::$a_int_PostId = get_the_id(); // contains the index for the next footnote on this page $l_int_FootnoteIndex = count(self::$a_arr_Footnotes) + 1; // contains the starting position for the lookup of a footnote $l_int_PosStart = 0; // get start and end tag for the footnotes short code $l_str_StartingTag = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START); $l_str_EndingTag = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END); if ($l_str_StartingTag == "userdefined" || $l_str_EndingTag == "userdefined") { $l_str_StartingTag = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED); $l_str_EndingTag = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED); } // decode html special chars if ($p_bool_ConvertHtmlChars) { $l_str_StartingTag = htmlspecialchars($l_str_StartingTag); $l_str_EndingTag = htmlspecialchars($l_str_EndingTag); } // if footnotes short code is empty, return the content without changes if (empty($l_str_StartingTag) || empty($l_str_EndingTag)) { return $p_str_Content; } // if footnotes short codes are unbalanced, and syntax validation is not disabled, // return content with prepended warning: if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE))) { // convert the shortcodes to regex syntax conformant: $l_str_StartTagRegex = preg_replace( '#([\(\)\{\}\[\]\*\.\?\!])#', '\\\\$1', $l_str_StartingTag ); $l_str_EndTagRegex = preg_replace( '#([\(\)\{\}\[\]\*\.\?\!])#', '\\\\$1', $l_str_EndingTag ); // apply different regex depending on whether start shortcode is double/triple opening parenthesis: if ( $l_str_StartingTag == '((' || $l_str_StartingTag == '(((' ) { // this prevents from catching a script containing e.g. a double opening parenthesis: $l_str_ValidationRegex = '#' . $l_str_StartTagRegex . '(((?!' . $l_str_EndTagRegex . ')[^\{\}])*?)(' . $l_str_StartTagRegex . '|$)#s'; } else { // catch all only if the start shortcode is not double/triple opening parenthesis, i.e. is unlikely to occur in scripts: $l_str_ValidationRegex = '#' . $l_str_StartTagRegex . '(((?!' . $l_str_EndTagRegex . ').)*?)(' . $l_str_StartTagRegex . '|$)#s'; } // check syntax and get error locations: preg_match( $l_str_ValidationRegex, $p_str_Content, $p_arr_ErrorLocation ); if ( empty( $p_arr_ErrorLocation ) ) { self::$a_bool_SyntaxErrorFlag = false; } // prevent generating and inserting the warning multiple times: if ( self::$a_bool_SyntaxErrorFlag ) { // get plain text string for error location: $l_str_ErrorSpotString = strip_tags( $p_arr_ErrorLocation[1] ); // limit string length to 300 characters: if ( strlen( $l_str_ErrorSpotString ) > 300 ) { $l_str_ErrorSpotString = substr( $l_str_ErrorSpotString, 0, 299 ) . '…'; } // compose warning box: $l_str_SyntaxErrorWarning = '

'; $l_str_SyntaxErrorWarning .= __("WARNING: unbalanced footnote start tag short code found.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME); $l_str_SyntaxErrorWarning .= '

'; // syntax validation setting in the dashboard under the General settings tab: $l_str_SyntaxErrorWarning .= sprintf( __("If this warning is irrelevant, please disable the syntax validation feature in the dashboard under %s > %s > %s.", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), __("General settings", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), __("Footnote start and end short codes", MCI_Footnotes_Config::C_STR_PLUGIN_NAME), __("Check for balanced shortcodes", MCI_Footnotes_Config::C_STR_PLUGIN_NAME) ); $l_str_SyntaxErrorWarning .= '

'; $l_str_SyntaxErrorWarning .= __("Unbalanced start tag short code found before:", MCI_Footnotes_Config::C_STR_PLUGIN_NAME); $l_str_SyntaxErrorWarning .= '

“'; $l_str_SyntaxErrorWarning .= $l_str_ErrorSpotString; $l_str_SyntaxErrorWarning .= '”

'; // prepend the warning box to the content: $p_str_Content = $l_str_SyntaxErrorWarning . $p_str_Content; // checked, set flag to false to prevent duplicate warning: self::$a_bool_SyntaxErrorFlag = false; return $p_str_Content; } } // load referrer templates if footnotes text not hidden: if (!$p_bool_HideFootnotesText) { // load footnote referrer template file: if (self::$a_bool_AlternativeTooltipsEnabled) { $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "footnote-alternative"); } else { $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "footnote"); } // call again for robustness when priority levels don’t match any longer: self::$a_bool_TooltipsEnabled = MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED)); self::$a_bool_AlternativeTooltipsEnabled = MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE)); // load tooltip inline script if jQuery tooltips are enabled: if (self::$a_bool_TooltipsEnabled && ! self::$a_bool_AlternativeTooltipsEnabled) { $l_obj_TemplateTooltip = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "tooltip"); } } else { $l_obj_Template = null; $l_obj_TemplateTooltip = null; } // search footnotes short codes in the content do { // get first occurrence of the footnote start tag short code: $i_int_LenContent = strlen($p_str_Content); if ($l_int_PosStart > $i_int_LenContent) $l_int_PosStart = $i_int_LenContent; $l_int_PosStart = strpos($p_str_Content, $l_str_StartingTag, $l_int_PosStart); // no short code found, stop here if ($l_int_PosStart === false) { break; } // get first occurrence of the footnote end tag short code: $l_int_PosEnd = strpos($p_str_Content, $l_str_EndingTag, $l_int_PosStart); // no short code found, stop here if ($l_int_PosEnd === false) { break; } // calculate the length of the footnote $l_int_Length = $l_int_PosEnd - $l_int_PosStart; // get footnote text $l_str_FootnoteText = substr($p_str_Content, $l_int_PosStart + strlen($l_str_StartingTag), $l_int_Length - strlen($l_str_StartingTag)); // get tooltip text if present: self::$a_str_TooltipShortcode = '[[/tooltip]]'; // grab from DB self::$a_int_TooltipShortcodeLength = strlen( self::$a_str_TooltipShortcode ); $l_int_TooltipTextLength = strpos( $l_str_FootnoteText, self::$a_str_TooltipShortcode ); $l_bool_HasTooltipText = $l_int_TooltipTextLength === false ? false : true; if ( $l_bool_HasTooltipText ) { $l_str_TooltipText = substr( $l_str_FootnoteText, 0, $l_int_TooltipTextLength ); } else { $l_str_TooltipText = ''; } /** * URL line wrap * * Fix line wrapping of URLs (hyperlinked or not) based on pattern, not link element, * to prevent them from hanging out of the tooltip in non-Unicode-compliant user agents. * @see public.css * * spare however values of the href and the src arguments! * @since 2.1.5 exclude image source too, thanks to @bjrnet21 * @link https://wordpress.org/support/topic/2-1-4-breaks-on-my-site-images-dont-show/ * * Even ARIA labels may take a URL as value, so use \w=[\'"] as a catch-all 2020-12-10T1005+0100 * @since 2.1.6 add catch-all exclusion to fix URL line wrapping, thanks to @a223123131 2020-12-09T1921+0100 * @link https://wordpress.org/support/topic/broken-layout-starting-version-2-1-4/ * * @since 2.1.6 option to disable URL line wrapping 2020-12-09T1606+0100 * * URLs may be a query string in a URL: * @since 2.2.6 make the quotation mark optional in the exclusion regex, thanks to @spiralofhope2 2020-12-23T0409+0100 * @link https://wordpress.org/support/topic/two-links-now-breaks-footnotes-with-blogtext/ * * @since 2.2.7 revert that change in the exclusion regex, thanks to @rjl20, @spaceling, @friedrichnorth, @bernardzit 2020-12-23T1046+0100 * @link https://wordpress.org/support/topic/two-links-now-breaks-footnotes-with-blogtext/ * * @link https://wordpress.org/support/topic/footnotes-dont-show-after-update-to-2-2-6/ * @since 2.2.8 correct lookbehind by duplicating it with and without quotation mark class 2020-12-23T1107+0100 * * @since 2.2.9 account for RFC 2396 allowed characters in parameter names 2020-12-24T1956+0100 * @link https://stackoverflow.com/questions/814700/http-url-allowed-characters-in-parameter-names * * @since 2.2.9 exclude URLs also where the equals sign is preceded by an entity or character reference 2020-12-25T1234+0100 * * @since 2.2.10 support also file transfer protocol URLs 2020-12-25T2220+0100 * * URL pattern may be part of a Wayback Machine URL * @thanksto @rumperuu bug report * @link https://wordpress.org/support/topic/line-wrap-href-regex-bug/ * @since 2.5.3 * exclude protocols with prepended slash hinting it’s in a Wayback Machine URL */ if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTE_URL_WRAP_ENABLED))) { $l_str_FootnoteText = preg_replace( '#(?$1', $l_str_FootnoteText ); } // Text to be displayed instead of the footnote $l_str_FootnoteReplaceText = ""; // whether hard links are enabled; relevant also below in ReferenceContainer(): if (self::$a_bool_HardLinksEnable) { // get the configurable parts: self::$a_str_ReferrerLinkSlug = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_REFERRER_FRAGMENT_ID_SLUG); self::$a_str_FootnoteLinkSlug = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTE_FRAGMENT_ID_SLUG); self::$a_str_LinkIdsSeparator = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_HARD_LINK_IDS_SEPARATOR); // streamline ID concatenation: self::$a_str_PostContainerIdCompound = self::$a_str_LinkIdsSeparator; self::$a_str_PostContainerIdCompound .= self::$a_int_PostId; self::$a_str_PostContainerIdCompound .= self::$a_str_LinkIdsSeparator; self::$a_str_PostContainerIdCompound .= self::$a_int_ReferenceContainerId; self::$a_str_PostContainerIdCompound .= self::$a_str_LinkIdsSeparator; } // display the footnote referrers and the tooltips: if (!$p_bool_HideFootnotesText) { $l_int_Index = MCI_Footnotes_Convert::Index($l_int_FootnoteIndex, MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)); // display only a truncated footnote text if option enabled: $l_bool_EnableExcerpt = MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED)); $l_int_MaxLength = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH)); // define excerpt text as footnote text by default: $l_str_ExcerptText = $l_str_FootnoteText; /** * TOOLTIP TRUNCATION * * If the option is enabled, the tooltip text is truncated based on character count. * This is equivalent to the WordPress default excerpt generation, i.e. without a * custom excerpt and without a delimiter. But WordPress does word count, usually 55. * * Tooltips: Read-on button: Label: configurable instead of localizable * @since 2.1.0 * @datestamp 2020-11-08T2146+0100 * @thanksto @rovanov * @triggeredby https://wordpress.org/support/topic/offset-x-axis-and-offset-y-axis-does-not-working/ * (The feature was not requested but it fixes an apparent design flaw of the plugin * appearing when looking at a longer tooltip on the web page linked from this topic.) */ if (self::$a_bool_TooltipsEnabled && $l_bool_EnableExcerpt) { $l_str_DummyText = strip_tags($l_str_FootnoteText); if (is_int($l_int_MaxLength) && strlen($l_str_DummyText) > $l_int_MaxLength) { $l_str_ExcerptText = substr($l_str_DummyText, 0, $l_int_MaxLength); $l_str_ExcerptText = substr($l_str_ExcerptText, 0, strrpos($l_str_ExcerptText, ' ')); $l_str_ExcerptText .= ' … <'; $l_str_ExcerptText .= self::$a_bool_HardLinksEnable ? 'a' : 'span'; $l_str_ExcerptText .= ' class="footnote_tooltip_continue" '; $l_str_ExcerptText .= 'onclick="footnote_moveToAnchor_' . self::$a_int_PostId; $l_str_ExcerptText .= '_' . self::$a_int_ReferenceContainerId; $l_str_ExcerptText .= '(\'footnote_plugin_reference_' . self::$a_int_PostId; $l_str_ExcerptText .= '_' . self::$a_int_ReferenceContainerId; $l_str_ExcerptText .= "_$l_int_Index');\""; // if enabled, add the hard link fragment ID: if (self::$a_bool_HardLinksEnable) { $l_str_ExcerptText .= ' href="#'; $l_str_ExcerptText .= self::$a_str_FootnoteLinkSlug; $l_str_ExcerptText .= self::$a_str_PostContainerIdCompound; $l_str_ExcerptText .= $l_int_Index; $l_str_ExcerptText .= '"'; } $l_str_ExcerptText .= '>'; $l_str_ExcerptText .= MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL); $l_str_ExcerptText .= self::$a_bool_HardLinksEnable ? '' : ''; } } /** * REFERRERS ELEMENT SUPERSCRIPT OR BASELINE * * Referrers: new setting for vertical align: superscript (default) or baseline (optional), thanks to @cwbayer bug report * @since 2.1.1 * * @reporter @cwbayer * @bugreport https://wordpress.org/support/topic/footnote-number-in-text-superscript-disrupts-leading/ * * define the HTML element to use for the referrers: */ if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS))) { $l_str_SupSpan = 'sup'; } else { $l_str_SupSpan = 'span'; } // whether hard links are enabled; relevant also below in ReferenceContainer(): if (self::$a_bool_HardLinksEnable) { self::$a_str_LinkSpan = 'a'; self::$a_str_LinkCloseTag = ''; // self::$a_str_LinkOpenTag will be defined as needed // compose hyperlink address (leading space is in template): $l_str_FootnoteLinkArgument = 'href="#'; $l_str_FootnoteLinkArgument .= self::$a_str_FootnoteLinkSlug; $l_str_FootnoteLinkArgument .= self::$a_str_PostContainerIdCompound; $l_str_FootnoteLinkArgument .= $l_int_Index; $l_str_FootnoteLinkArgument .= '" class="footnote_hard_link"'; // compose offset anchor, an empty span child of empty span // to prevent browsers from drawing tall dotted rectangles: $l_str_ReferrerAnchorElement = ''; } else { // no hyperlink nor offset anchor needed: $l_str_FootnoteLinkArgument = ''; $l_str_ReferrerAnchorElement = ''; // whether the link element is used nevertheless for styling: if ( MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_LINK_ELEMENT_ENABLED)) ) { self::$a_str_LinkSpan = 'a'; self::$a_str_LinkOpenTag = ''; self::$a_str_LinkCloseTag = ''; } } // determine tooltip content: if ( self::$a_bool_TooltipsEnabled ) { $l_str_TooltipContent = $l_bool_HasTooltipText ? $l_str_TooltipText : $l_str_ExcerptText; } else { $l_str_TooltipContent = ''; } // fill in 'templates/public/footnote.html': $l_obj_Template->replace( array( "link-span" => self::$a_str_LinkSpan, "post_id" => self::$a_int_PostId, "container_id" => self::$a_int_ReferenceContainerId, "note_id" => $l_int_Index, "hard-link" => $l_str_FootnoteLinkArgument, "sup-span" => $l_str_SupSpan, "before" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_BEFORE), "index" => $l_int_Index, "after" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_STYLING_AFTER), "anchor-element" => $l_str_ReferrerAnchorElement, "text" => $l_str_TooltipContent, ) ); $l_str_FootnoteReplaceText = $l_obj_Template->getContent(); // reset the template $l_obj_Template->reload(); // if standard tooltips are enabled but alternative are not: if (self::$a_bool_TooltipsEnabled && ! self::$a_bool_AlternativeTooltipsEnabled) { $l_int_OffsetY = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y)); $l_int_OffsetX = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X)); $l_int_FadeInDelay = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY )); $l_int_FadeInDuration = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION )); $l_int_FadeOutDelay = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY )); $l_int_FadeOutDuration = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION)); // fill in 'templates/public/tooltip.html': $l_obj_TemplateTooltip->replace( array( "post_id" => self::$a_int_PostId, "container_id" => self::$a_int_ReferenceContainerId, "note_id" => $l_int_Index, "position" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION), "offset-y" => !empty($l_int_OffsetY) ? $l_int_OffsetY : 0, "offset-x" => !empty($l_int_OffsetX) ? $l_int_OffsetX : 0, "fade-in-delay" => !empty($l_int_FadeInDelay ) ? $l_int_FadeInDelay : 0, "fade-in-duration" => !empty($l_int_FadeInDuration ) ? $l_int_FadeInDuration : 0, "fade-out-delay" => !empty($l_int_FadeOutDelay ) ? $l_int_FadeOutDelay : 0, "fade-out-duration" => !empty($l_int_FadeOutDuration) ? $l_int_FadeOutDuration : 0, ) ); $l_str_FootnoteReplaceText .= $l_obj_TemplateTooltip->getContent(); $l_obj_TemplateTooltip->reload(); } } // replace the footnote with the template $p_str_Content = substr_replace($p_str_Content, $l_str_FootnoteReplaceText, $l_int_PosStart, $l_int_Length + strlen($l_str_EndingTag)); // add footnote only if not empty if (!empty($l_str_FootnoteText)) { // set footnote to the output box at the end self::$a_arr_Footnotes[] = $l_str_FootnoteText; // increase footnote index $l_int_FootnoteIndex++; } // add offset to the new starting position $l_int_PosStart += $l_int_Length + strlen($l_str_EndingTag); $l_int_PosStart = $l_int_Length + strlen($l_str_FootnoteReplaceText); } while (true); // return content return $p_str_Content; } /** * Generates the reference container. * * @author Stefan Herndler * @since 1.5.0 * @return string * * @edit 2.0.6 fix line breaking behavior in footnote number clusters * @edit 2.1.1 fix fragment IDs and backlinks with combine identical turned on 2020-11-14T1808+0100 */ public function ReferenceContainer() { // no footnotes have been replaced on this page: if (empty(self::$a_arr_Footnotes)) { return ""; } /** * FOOTNOTE INDEX BACKLINK SYMBOL * * @since 2.0.0 removed backlink symbol along with column 2 of the reference container * @since 2.0.3 prepended an arrow on user request * @since 2.0.4 restored the arrow select & symbol input setting * @since 2.1.1 made the symbol optional instead of configuring it to invisible */ if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE))) { // get html arrow $l_str_Arrow = MCI_Footnotes_Convert::getArrow(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_HYPERLINK_ARROW)); // set html arrow to the first one if invalid index defined if (is_array($l_str_Arrow)) { $l_str_Arrow = MCI_Footnotes_Convert::getArrow(0); } // get user defined arrow $l_str_ArrowUserDefined = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_HYPERLINK_ARROW_USER_DEFINED); if (!empty($l_str_ArrowUserDefined)) { $l_str_Arrow = $l_str_ArrowUserDefined; } // wrap the arrow in a @media print { display:hidden } span: $l_str_FootnoteArrow = ''; $l_str_FootnoteArrow .= $l_str_Arrow . ''; } else { // if it is not, set arrow to empty: $l_str_Arrow = ''; $l_str_FootnoteArrow = ''; } /** * BACKLINK SEPARATOR * * Initially a comma was appended in this algorithm for enumerations. * The comma in enumerations is not generally preferred. * @since 2.1.4 the separator is optional, has options, and is configurable: */ // check if it is even enabled: if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_BACKLINKS_SEPARATOR_ENABLED))) { // if so, check if it is freely configured: $l_str_Separator = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_BACKLINKS_SEPARATOR_CUSTOM); if (empty($l_str_Separator)) { // if it is not, check which option is on: $l_str_SeparatorOption = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_BACKLINKS_SEPARATOR_OPTION); switch ($l_str_SeparatorOption) { case 'comma' : $l_str_Separator = ','; break; case 'semicolon': $l_str_Separator = ';'; break; case 'en_dash' : $l_str_Separator = ' –'; break; } } } else { $l_str_Separator = ''; } /** * BACKLINK TERMINATOR * * Initially a dot was appended in the table row template. * @since 2.0.6 a dot after footnote numbers is discarded as not localizable; * making it optional was envisaged. * @since 2.1.4 the terminator is optional, has options, and is configurable: */ // check if it is even enabled: if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_BACKLINKS_TERMINATOR_ENABLED))) { // if so, check if it is input-configured: $l_str_Terminator = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_BACKLINKS_TERMINATOR_CUSTOM); if (empty($l_str_Terminator)) { // if it is not, check which option is on: $l_str_TerminatorOption = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_BACKLINKS_TERMINATOR_OPTION); switch ($l_str_TerminatorOption) { case 'period' : $l_str_Terminator = '.'; break; case 'parenthesis': $l_str_Terminator = ')'; break; case 'colon' : $l_str_Terminator = ':'; break; } } } else { $l_str_Terminator = ''; } /** * LINE BREAKS * * The backlinks of combined footnotes are generally preferred in an enumeration. * But when few footnotes are identical, stacking the items in list form is better. * Variable number length and proportional character width require explicit line breaks. * Otherwise, an ordinary space character offering a line break opportunity is inserted. */ $l_str_LineBreak = MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED)) ? '
' : ' '; /** * For maintenance and support, table rows in the reference container should be * separated by an empty line. So we add these line breaks for source readability. * Before the first table row (breaks between rows are ~200 lines below): */ $l_str_Body = "\r\n\r\n"; /** * REFERENCE CONTAINER TABLE ROW TEMPLATE LOAD * * Reference container: option to restore 3-column layout (combining identicals turned off) * @since 2.1.1 * @datestamp 2020-11-16T2024+0100 */ // when combining identical footnotes is turned on, another template is needed: if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_COMBINE_IDENTICAL_FOOTNOTES))) { // the combining template allows for backlink clusters and supports cell clicking for single notes: $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "reference-container-body-combi"); } else { // when 3-column layout is turned on (only available if combining is turned off): if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE))) { $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "reference-container-body-3column"); } else { // when switch symbol and index is turned on, and combining and 3-columns are off: if (MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH))) { $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "reference-container-body-switch"); } else { // default is the standard template: $l_obj_Template = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "reference-container-body"); } } } /** * SWITCH BACKLINK SYMBOL AND FOOTNOTE NUMBER * * Reference container: option to append symbol (prepended by default) (combining identicals turned off) * @since 2.1.1 * @datestamp 2020-11-16T2024+0100 */ $l_bool_SymbolSwitch = MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH)); // FILL IN THE TEMPLATE // loop through all footnotes found in the page for ($l_int_Index = 0; $l_int_Index < count(self::$a_arr_Footnotes); $l_int_Index++) { // TEXT COLUMN // get footnote text $l_str_FootnoteText = self::$a_arr_Footnotes[$l_int_Index]; // if footnote is empty, go to the next one; // With combine identicals turned on, identicals will be deleted and are skipped: if (empty($l_str_FootnoteText)) { continue; } // generate content of footnote index cell $l_int_FirstFootnoteIndex = ($l_int_Index + 1); // get the footnote index string and // keep supporting legacy index placeholder: $l_str_FootnoteId = MCI_Footnotes_Convert::Index(($l_int_Index + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)); // INDEX COLUMN WITH ONE BACKLINK PER TABLE ROW // if enabled, and for the case the footnote is single, compose hard link: // define variable as empty for the reference container if not enabled: $l_str_HardLinkAddress = ''; if (self::$a_bool_HardLinksEnable) { // compose fragment ID anchor with offset, for use in reference container, an // empty span child of empty span to avoid tall dotted rectangles in browser: $l_str_FootnoteAnchorElement = ''; // compose optional hard link address: $l_str_HardLinkAddress = ' href="#'; $l_str_HardLinkAddress .= self::$a_str_ReferrerLinkSlug; $l_str_HardLinkAddress .= self::$a_str_PostContainerIdCompound; $l_str_HardLinkAddress .= $l_str_FootnoteId . '"'; // compose optional opening link tag with optional hard link, mandatory for instance: self::$a_str_LinkOpenTag = 'get(MCI_Footnotes_Settings::C_BOOL_COMBINE_IDENTICAL_FOOTNOTES))) { // ID, optional hard link address, and class: $l_str_FootnoteReference = '<' . self::$a_str_LinkSpan; $l_str_FootnoteReference .= ' id="footnote_plugin_reference_'; $l_str_FootnoteReference .= self::$a_int_PostId; $l_str_FootnoteReference .= '_' . self::$a_int_ReferenceContainerId; $l_str_FootnoteReference .= "_$l_str_FootnoteId\""; if (self::$a_bool_HardLinksEnable) { $l_str_FootnoteReference .= ' href="#'; $l_str_FootnoteReference .= self::$a_str_ReferrerLinkSlug; $l_str_FootnoteReference .= self::$a_str_PostContainerIdCompound; $l_str_FootnoteReference .= $l_str_FootnoteId . '"'; } $l_str_FootnoteReference .= ' class="footnote_backlink"'; // the click event goes in the table cell if footnote remains single: $l_str_BacklinkEvent = ' onclick="footnote_moveToAnchor_'; $l_str_BacklinkEvent .= self::$a_int_PostId; $l_str_BacklinkEvent .= '_' . self::$a_int_ReferenceContainerId; $l_str_BacklinkEvent .= "('footnote_plugin_tooltip_"; $l_str_BacklinkEvent .= self::$a_int_PostId; $l_str_BacklinkEvent .= '_' . self::$a_int_ReferenceContainerId; $l_str_BacklinkEvent .= "_$l_str_FootnoteId');\""; // the dedicated template enumerating backlinks uses another variable: $l_str_FootnoteBacklinks = $l_str_FootnoteReference; // append the click event right to the backlink item for enumerations; // else it goes in the table cell: $l_str_FootnoteBacklinks .= $l_str_BacklinkEvent . '>'; $l_str_FootnoteReference .= '>'; // append the optional offset anchor for hard links: if (self::$a_bool_HardLinksEnable) { $l_str_FootnoteReference .= $l_str_FootnoteAnchorElement; $l_str_FootnoteBacklinks .= $l_str_FootnoteAnchorElement; } // continue both single note and notes cluster, depending on switch option status: if ($l_bool_SymbolSwitch) { $l_str_FootnoteReference .= "$l_str_FootnoteId$l_str_FootnoteArrow"; $l_str_FootnoteBacklinks .= "$l_str_FootnoteId$l_str_FootnoteArrow"; } else { $l_str_FootnoteReference .= "$l_str_FootnoteArrow$l_str_FootnoteId"; $l_str_FootnoteBacklinks .= "$l_str_FootnoteArrow$l_str_FootnoteId"; } // If that is the only footnote with this text, we’re almost done. // check if it isn't the last footnote in the array: if ($l_int_FirstFootnoteIndex < count(self::$a_arr_Footnotes)) { // get all footnotes that haven't passed yet: for ($l_int_CheckIndex = $l_int_FirstFootnoteIndex; $l_int_CheckIndex < count(self::$a_arr_Footnotes); $l_int_CheckIndex++) { // check if a further footnote is the same as the actual one: if ($l_str_FootnoteText == self::$a_arr_Footnotes[$l_int_CheckIndex]) { // if so, set the further footnote as empty so it won't be displayed later: self::$a_arr_Footnotes[$l_int_CheckIndex] = ""; // set the flag to true for the combined status: $l_bool_FlagCombined = true; // update the footnote ID: $l_str_FootnoteId = MCI_Footnotes_Convert::Index(($l_int_CheckIndex + 1), MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)); // resume composing the backlinks enumeration: $l_str_FootnoteBacklinks .= "$l_str_Separator'; $l_str_FootnoteBacklinks .= $l_str_LineBreak; $l_str_FootnoteBacklinks .= '<' . self::$a_str_LinkSpan; $l_str_FootnoteBacklinks .= ' id="footnote_plugin_reference_'; $l_str_FootnoteBacklinks .= self::$a_int_PostId; $l_str_FootnoteBacklinks .= '_' . self::$a_int_ReferenceContainerId; $l_str_FootnoteBacklinks .= "_$l_str_FootnoteId\""; // insert the optional hard link address: if (self::$a_bool_HardLinksEnable) { $l_str_FootnoteBacklinks .= ' href="#'; $l_str_FootnoteBacklinks .= self::$a_str_ReferrerLinkSlug; $l_str_FootnoteBacklinks .= self::$a_str_PostContainerIdCompound; $l_str_FootnoteBacklinks .= $l_str_FootnoteId . '"'; } $l_str_FootnoteBacklinks .= ' class="footnote_backlink"'; $l_str_FootnoteBacklinks .= ' onclick="footnote_moveToAnchor_'; $l_str_FootnoteBacklinks .= self::$a_int_PostId; $l_str_FootnoteBacklinks .= '_' . self::$a_int_ReferenceContainerId; $l_str_FootnoteBacklinks .= "('footnote_plugin_tooltip_"; $l_str_FootnoteBacklinks .= self::$a_int_PostId; $l_str_FootnoteBacklinks .= '_' . self::$a_int_ReferenceContainerId; $l_str_FootnoteBacklinks .= "_$l_str_FootnoteId');\">"; // append the offset anchor for optional hard links: if (self::$a_bool_HardLinksEnable) { $l_str_FootnoteBacklinks .= ''; } $l_str_FootnoteBacklinks .= $l_bool_SymbolSwitch ? '' : $l_str_FootnoteArrow; $l_str_FootnoteBacklinks .= $l_str_FootnoteId; $l_str_FootnoteBacklinks .= $l_bool_SymbolSwitch ? $l_str_FootnoteArrow : ''; } } } // append terminator and end tag: $l_str_FootnoteReference .= $l_str_Terminator . ''; $l_str_FootnoteBacklinks .= $l_str_Terminator . ''; } // line wrapping of URLs already fixed, see above // get reference container item text if tooltip text goes separate: $l_int_TooltipTextLength = strpos( $l_str_FootnoteText, self::$a_str_TooltipShortcode ); $l_bool_HasTooltipText = $l_int_TooltipTextLength === false ? false : true; if ( $l_bool_HasTooltipText ) { $l_str_NotTooltipText = substr( $l_str_FootnoteText, ( $l_int_TooltipTextLength + self::$a_int_TooltipShortcodeLength ) ); self::$a_bool_MirrorTooltipText = false; // grab from settings! if ( self::$a_bool_MirrorTooltipText ) { $l_str_TooltipText = substr( $l_str_FootnoteText, 0, $l_int_TooltipTextLength ); $l_str_ReferenceTextIntroducer = ' '; // grab from settings! $l_str_ReferenceText = $l_str_TooltipText . $l_str_ReferenceTextIntroducer . $l_str_NotTooltipText; } else { $l_str_ReferenceText = $l_str_NotTooltipText; } } else { $l_str_ReferenceText = $l_str_FootnoteText; } // replace all placeholders in 'templates/public/reference-container-body.html' // or in 'templates/public/reference-container-body-combi.html' // or in 'templates/public/reference-container-body-3column.html' // or in 'templates/public/reference-container-body-switch.html' $l_obj_Template->replace( array( // placeholder used in all templates: "text" => $l_str_ReferenceText, // used in standard layout W/O COMBINED FOOTNOTES: "post_id" => self::$a_int_PostId, "container_id" => self::$a_int_ReferenceContainerId, "note_id" => MCI_Footnotes_Convert::Index($l_int_FirstFootnoteIndex, MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_FOOTNOTES_COUNTER_STYLE)), "link-start" => self::$a_str_LinkOpenTag, "link-end" => self::$a_str_LinkCloseTag, "link-span" => self::$a_str_LinkSpan, "terminator" => $l_str_Terminator, "anchor-element" => $l_str_FootnoteAnchorElement, "hard-link" => $l_str_HardLinkAddress, // used in standard layout WITH COMBINED IDENTICALS TURNED ON: "pointer" => $l_bool_FlagCombined ? '' : ' pointer', "event" => $l_bool_FlagCombined ? '' : $l_str_BacklinkEvent, "backlinks" => $l_bool_FlagCombined ? $l_str_FootnoteBacklinks : $l_str_FootnoteReference, // Legacy placeholders for use in legacy layout templates: "arrow" => $l_str_FootnoteArrow, "index" => $l_str_FootnoteId, ) ); $l_str_Body .= $l_obj_Template->getContent(); // extra line breaks for page source readability: $l_str_Body .= "\r\n\r\n"; $l_obj_Template->reload(); } // call again for robustness when priority levels don’t match any longer: self::$a_int_ScrollOffset = intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_OFFSET)); // streamline: $l_bool_CollapseDefault = MCI_Footnotes_Convert::toBool(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_BOOL_REFERENCE_CONTAINER_COLLAPSE)); // prevent empty from being less robust: $l_str_ReferenceContainerLabel = MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_NAME); // load 'templates/public/reference-container.html': $l_obj_TemplateContainer = new MCI_Footnotes_Template(MCI_Footnotes_Template::C_STR_PUBLIC, "reference-container"); $l_obj_TemplateContainer->replace( array( "post_id" => self::$a_int_PostId, "container_id" => self::$a_int_ReferenceContainerId, "element" => MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT), "name" => empty($l_str_ReferenceContainerLabel) ? ' ' : $l_str_ReferenceContainerLabel, "button-style" => !$l_bool_CollapseDefault ? 'display: none;' : '', "style" => $l_bool_CollapseDefault ? 'display: none;' : '', "content" => $l_str_Body, "scroll-offset" => (self::$a_int_ScrollOffset / 100), "scroll-duration" => intval(MCI_Footnotes_Settings::instance()->get(MCI_Footnotes_Settings::C_INT_FOOTNOTES_SCROLL_DURATION)), ) ); // free all found footnotes if reference container will be displayed self::$a_arr_Footnotes = array(); return $l_obj_TemplateContainer->getContent(); } }