Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/mets-rebuild.corals.io/wp-content/plugins/easy-footnotes/ |
<?php
/**
* Plugin Name: Easy Footnotes
* Plugin URI: https://jasonyingling.me/easy-footnotes-wordpress/
* Description: Easily add footnotes to your posts with a simple shortcode.
* Text Domain: easy-footnotes
* Version: 1.1.12
* Author: Jason Yingling
* Author URI: https://jasonyingling.me
* License: GPL2
*
* @package easy-footnotes
*/
/*
Copyright 2018 Jason Yingling (email : [email protected])
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2, as
published by the Free Software Foundation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* The Easy Footnotes class. In camel case. Because I didn't follow WPCS way back when.
*/
class easyFootnotes {
/**
* Add label option using add_option if it does not already exist.
*
* @var array $footnotes An array for the footnotes to be stored.
*/
public $footnotes = array();
public $footnoteCount = 0;
public $prevPost;
public $footnoteOptions;
public $footnoteLookup = array();
public $usedFootnoteNumbers = array();
private $footnoteSettings;
private $version = '1.1.12';
/**
* Constructing the initial plugin options, shortcodes, and hooks.
*/
public function __construct() {
$this->footnoteSettings = array(
'footnoteLabel' => __( 'Footnotes', 'easy-footnotes' ),
'useLabel' => false,
'hide_easy_footnote_after_posts' => false,
'show_easy_footnote_on_front' => false,
'reset_footnotes' => false,
'combine_duplicate_footnotes' => false,
);
add_option( 'easy_footnotes_options', $this->footnoteSettings );
add_shortcode( 'note', array( $this, 'easy_footnote_shortcode' ) );
add_shortcode( 'efn_note', array( $this, 'easy_footnote_shortcode' ) );
add_shortcode( 'efn_reset', array( $this, 'short_code_reset' ) );
add_filter( 'the_content', array( $this, 'easy_footnote_after_content' ), 20 );
$this->footnoteOptions = get_option( 'easy_footnotes_options' );
if ( isset( $this->footnoteOptions['reset_footnotes'] ) && $this->footnoteOptions['reset_footnotes'] || ( ! isset( $this->footnoteOptions[ 'combine_duplicate_footnotes' ] ) || $this->footnoteOptions[ 'combine_duplicate_footnotes' ] === false ) ) {
add_filter( 'the_content', array( $this, 'easy_footnote_reset' ), 999 );
}
add_action( 'wp_enqueue_scripts', array( $this, 'register_qtip_scripts' ) );
add_action( 'admin_menu', array( $this, 'easy_footnotes_admin_actions' ) );
add_action( 'admin_enqueue_scripts', array( $this, 'easy_footnotes_admin_scripts' ) );
add_action( 'init', array($this, 'efn_load_textdomain') );
$this->footnoteOptions = get_option( 'easy_footnotes_options' );
}
/**
* Registering the scripts and styles used by jQuery qTip.
*/
public function register_qtip_scripts() {
wp_register_script( 'imagesloaded', plugins_url( '/assets/qtip/imagesloaded.pkgd.min.js', __FILE__ ), array(), $this->version, true );
wp_register_script( 'qtip', plugins_url( '/assets/qtip/jquery.qtip.min.js', __FILE__ ), array( 'jquery', 'imagesloaded' ), $this->version, true );
wp_register_script( 'qtipcall', plugins_url( '/assets/qtip/jquery.qtipcall.js', __FILE__ ), array( 'jquery', 'qtip' ), $this->version, true );
wp_register_style( 'qtipstyles', plugins_url( '/assets/qtip/jquery.qtip.min.css', __FILE__ ), array(), $this->version, false );
wp_register_style( 'easyfootnotescss', plugins_url( '/assets/easy-footnotes.css', __FILE__ ), array(), $this->version, false );
}
/**
* Create the Easy Footnotes shortcode.
*
* @param array $atts Shortcode attributes.
* @param string $content Content within the shortcode.
*/
public function easy_footnote_shortcode( $atts, $content = null ) {
if ( isset( $this->footnoteOptions['show_easy_footnote_on_front'] ) && $this->footnoteOptions['show_easy_footnote_on_front'] ) {
$efn_show_on_front = is_front_page();
} else {
$efn_show_on_front = false;
}
wp_enqueue_style( 'qtipstyles' );
wp_enqueue_style( 'easyfootnotescss' );
wp_enqueue_script( 'imagesloaded' );
wp_enqueue_script( 'qtip' );
wp_enqueue_script( 'qtipcall' );
wp_enqueue_style( 'dashicons' );
// Accept optional custom number attribute
$atts = shortcode_atts(
array(
'num' => null
),
$atts
);
$post_id = get_the_ID();
$content = do_shortcode( $content );
$content_id = md5( preg_replace("/[^A-Za-z0-9 ]/", '', wp_strip_all_tags( html_entity_decode( $content ) ) ) );
if ( isset( $this->footnoteOptions[ 'combine_duplicate_footnotes' ] ) && $this->footnoteOptions[ 'combine_duplicate_footnotes' ] === true ) {
/**
* Search for existing footnote for removing duplicate
* Also add the same numbers to duplicate footnotes
*/
if (!isset($this->usedFootnoteNumbers) ) {
$this->usedFootnoteNumbers = array();
}
if (!isset($this->footnoteLookup)) {
$this->footnoteLookup = array();
}
}
// If a custom number is provided, use that number and mark it as used
if ( ! empty( $atts['num'] ) ) {
$footnote_number = intval( $atts['num'] );
$this->usedFootnoteNumbers[] = $footnote_number; // Track custom number
$this->footnoteLookup[$content_id] = $footnote_number;
$this->footnotes[$footnote_number] = $content;
} elseif ( isset( $this->footnoteLookup[$content_id] ) ) {
if ( isset( $this->footnoteOptions[ 'combine_duplicate_footnotes' ] ) && $this->footnoteOptions[ 'combine_duplicate_footnotes' ] === true ) {
// Use existing footnote number for duplicate content
$footnote_number = $this->footnoteLookup[$content_id];
} else {
$this->footnoteCount++;
$footnote_number = $this->footnoteCount;
$this->footnotes[$footnote_number] = $content;
}
} else {
// Auto-increment for new footnotes, skipping used numbers
do {
$this->footnoteCount++;
} while ( in_array( $this->footnoteCount, $this->usedFootnoteNumbers ) );
$footnote_number = $this->footnoteCount;
$this->footnoteLookup[$content_id] = $footnote_number;
$this->usedFootnoteNumbers[] = $footnote_number; // Mark as used
$this->footnotes[$footnote_number] = $content;
}
// Generate the correct footnote link with the correct number
$footnoteLink = (is_singular() || $efn_show_on_front) && is_main_query()
? '#easy-footnote-bottom-' . $footnote_number . '-' . $post_id
: get_permalink($post_id) . '#easy-footnote-bottom-' . $footnote_number . '-' . $post_id;
// Now generate the footnote markup with the correct number and link
$footnoteContent = "<span id='easy-footnote-" . esc_attr($footnote_number) . '-' . $post_id
. "' class='easy-footnote-margin-adjust'></span><span class='easy-footnote'>"
. "<a href='" . esc_url($footnoteLink) . "' title='" . htmlspecialchars($content, ENT_QUOTES)
. "'><sup>" . esc_html($footnote_number) . "</sup></a></span>";
return $footnoteContent;
}
/**
* The content of a particular footnote.
*
* @param string $content The content from a particular call of the shortcode.
*/
public function easy_footnote_content( $content ) {
$this->footnotes[ $this->footnoteCount ] = $content;
return $this->footnotes;
}
/**
* Display the list of footnotes after the post content.
*
* @param string $content The content of the current post.
*/
public function easy_footnote_after_content( $content ) {
if ( isset( $this->footnoteOptions['hide_easy_footnote_after_posts'] ) && $this->footnoteOptions['hide_easy_footnote_after_posts'] ) {
return $content;
}
if ( isset( $this->footnoteOptions['show_easy_footnote_on_front'] ) && $this->footnoteOptions['show_easy_footnote_on_front'] ) {
$efn_show_on_front = is_front_page() || is_home();
} else {
$efn_show_on_front = false;
}
if ( ( is_singular() || $efn_show_on_front ) && is_main_query() ) {
$footnotesInsert = $this->footnotes;
$footnoteCopy = '';
$efn_output = '';
$useLabel = isset( $this->footnoteOptions['useLabel'] ) ? $this->footnoteOptions['useLabel'] : false;
$efLabel = isset($this->footnoteOptions['footnoteLabel'] ) ? $this->footnoteOptions['footnoteLabel'] : __( 'Footnotes', 'easy-footnotes' );
$post_id = get_the_ID();
// Create a new array to track used footnotes and their numbers
$footnote_number = 1;
// sort footnotes according to numbers
ksort($footnotesInsert);
foreach ( $footnotesInsert as $count => $footnote ) {
if ( isset( $this->footnoteOptions[ 'combine_duplicate_footnotes' ] ) && $this->footnoteOptions[ 'combine_duplicate_footnotes' ] === true ) {
// If the footnote is already in the lookup, use its number
if ( isset( $this->footnoteLookup[$footnote] ) ) {
$count = $this->footnoteLookup[$footnote];
} else {
// Skip custom numbers that were already used
while ( in_array( $footnote_number, $this->usedFootnoteNumbers ) ) {
$footnote_number++;
}
}
}
// Generate back-to-top link and the footnote item
$footnoteCopy .= '<li class="easy-footnote-single"><span id="easy-footnote-bottom-' . esc_attr( $count ) . '-' . $post_id . '" class="easy-footnote-margin-adjust"></span>' . wp_kses_post( $footnote ) . '<a class="easy-footnote-to-top" href="' . esc_url( '#easy-footnote-' . $count . '-' . $post_id ) . '"></a></li>';
}
if ( ! empty( $footnotesInsert ) ) {
if ( true === $useLabel ) {
$footnote_label = '<div class="easy-footnote-title"><h4>' . esc_html( $efLabel ) . '</h4></div>';
// Filter for editing footnote label markup and output.
$footnote_label = apply_filters( 'efn_footnote_label', $footnote_label, $efLabel );
$efn_output .= $footnote_label;
}
$footnote_content = '';
// Add filter before footnote list.
$footnote_content = apply_filters( 'before_footnote', $footnote_content );
$footnote_content .= '<ol class="easy-footnotes-wrapper">' . $footnoteCopy . '</ol>';
// Add filter after footnote list.
$footnote_content = apply_filters( 'after_footnote', $footnote_content );
$efn_output .= $footnote_content;
// Add filters for the entire footnote list output.
$efn_output = apply_filters( 'efn_footnote_list_output', $efn_output );
$content .= do_shortcode( $efn_output );
}
}
return $content;
}
/**
* Reset the footnote count and footnote array each time the_content has been run.
*
* @param string $content The content of the post from the_content filter.
*/
public function easy_footnote_reset( $content ) {
$this->footnoteCount = 0;
$this->footnotes = array();
return $content;
}
/**
* Include the easy-footnotes-admin.php file.
*/
public function easy_footnotes_admin() {
include 'easy-footnotes-admin.php';
}
/**
* Function to add options page for Easy Footnote Settings.
*/
public function easy_footnotes_admin_actions() {
add_options_page(
__( 'Easy Footnotes Settings', 'easy-footnotes' ),
__( 'Easy Footnotes', 'easy-footnotes' ),
'manage_options',
'easy-footnotes-settings',
array( $this, 'easy_footnotes_admin' )
);
}
/**
* Function for enqueuring EAsy Footnotes admin scripts.
*/
public function easy_footnotes_admin_scripts() {
wp_enqueue_style( 'easy-footnotes-admin-styles', plugins_url( '/assets/easy-footnotes-admin.css', __FILE__ ), '', $this->version );
wp_enqueue_script( 'easy-footnotes-admin-scripts', plugins_url( '/assets/js/easy-footnotes-admin.js', __FILE__ ), array( 'jquery' ), $this->version, true );
}
/**
* Load plugin textdomain easy-footnotes
*/
public function efn_load_textdomain() {
load_plugin_textdomain( 'easy-footnotes', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );
}
/**
* Manually reset footnotes and counter
*/
public function short_code_reset() {
$this->footnoteCount = 0;
$this->footnotes = array();
return "";
}
}
$easyFootnotes = new easyFootnotes();