easy-footnotes / easy-footnotes.php

easy-footnotes.php in Easy Footnotes 1.1.0, at easy-footnotes.php

246 lines 8.3 KB

Raw Download Zip

1	<?php
2	/**
3	* Plugin Name: Easy Footnotes
4	* Plugin URI: https://jasonyingling.me/easy-footnotes-wordpress/
5	* Description: Easily add footnotes to your posts with a simple shortcode.
6	* Version: 1.1.0
7	* Author: Jason Yingling
8	* Author URI: https://jasonyingling.me
9	* License: GPL2
10	*
11	* @package easy-footnotes
12	*/
13
14	/*
15	Copyright 2018 Jason Yingling (email : yingling017@gmail.com)
16
17	This program is free software; you can redistribute it and/or modify
18	it under the terms of the GNU General Public License, version 2, as
19	published by the Free Software Foundation.
20
21	This program is distributed in the hope that it will be useful,
22	but WITHOUT ANY WARRANTY; without even the implied warranty of
23	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24	GNU General Public License for more details.
25
26	You should have received a copy of the GNU General Public License
27	along with this program; if not, write to the Free Software
28	Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
29	*/
30	/**
31	* The Easy Footnotes class. In camel case. Because I didn't follow WPCS way back when.
32	*/
33	class easyFootnotes {
34
35	/**
36	* Add label option using add_option if it does not already exist.
37	*
38	* @var array $footnotes An array for the footnotes to be stored.
39	*/
40	public $footnotes = array();
41	public $footnoteCount = 0;
42	public $prevPost;
43	public $footnoteOptions;
44
45	private $footnoteSettings;
46
47	/**
48	* Constructing the initial plugin options, shortcodes, and hooks.
49	*/
50	public function __construct() {
51	$footnoteSettings = array(
52	'footnoteLabel' => __( 'Footnotes', 'easy-footnotes' ),
53	'useLabel' => false,
54	'hide_easy_footnote_after_posts' => false,
55	'show_easy_footnote_on_front' => false,
56	);
57
58	add_option( 'easy_footnotes_options', $this->footnoteSettings );
59	add_shortcode( 'note', array( $this, 'easy_footnote_shortcode' ) );
60	add_shortcode( 'efn_note', array( $this, 'easy_footnote_shortcode' ) );
61	add_filter( 'the_content', array( $this, 'easy_footnote_after_content' ), 20 );
62	add_filter( 'the_content', array( $this, 'easy_footnote_reset' ), 999 );
63	add_action( 'wp_enqueue_scripts', array( $this, 'register_qtip_scripts' ) );
64	add_action( 'admin_menu', array( $this, 'easy_footnotes_admin_actions' ) );
65	add_action( 'admin_enqueue_scripts', array( $this, 'easy_footnotes_admin_scripts' ) );
66
67	$this->footnoteOptions = get_option( 'easy_footnotes_options' );
68	}
69
70	/**
71	* Registering the scripts and styles used by jQuery qTip.
72	*/
73	public function register_qtip_scripts() {
74	wp_register_script( 'imagesloaded', plugins_url( '/assets/qtip/imagesloaded.pkgd.min.js', __FILE__ ), array(), '3.1.8', true );
75	wp_register_script( 'qtip', plugins_url( '/assets/qtip/jquery.qtip.min.js', __FILE__ ), array( 'jquery', 'imagesloaded' ), '3.0.3', true );
76	wp_register_script( 'qtipcall', plugins_url( '/assets/qtip/jquery.qtipcall.js', __FILE__ ), array( 'jquery', 'qtip' ), '1.1.0', true );
77	wp_register_style( 'qtipstyles', plugins_url( '/assets/qtip/jquery.qtip.min.css', __FILE__ ), array(), '3.0.3', false );
78	wp_register_style( 'easyfootnotescss', plugins_url( '/assets/easy-footnotes.css', __FILE__ ), array(), '1.1.0', false );
79	}
80
81	/**
82	* Create the Easy Footnotes shortcode.
83	*
84	* @param array $atts Shortcode attributes.
85	* @param string $content Content within the shortcode.
86	*/
87	public function easy_footnote_shortcode( $atts, $content = null ) {
88	if ( isset( $this->footnoteOptions['show_easy_footnote_on_front'] ) && $this->footnoteOptions['show_easy_footnote_on_front'] ) {
89	$efn_show_on_front = is_front_page();
90	} else {
91	$efn_show_on_front = false;
92	}
93
94	wp_enqueue_style( 'qtipstyles' );
95	wp_enqueue_style( 'easyfootnotescss' );
96	wp_enqueue_script( 'imagesloaded' );
97	wp_enqueue_script( 'qtip' );
98	wp_enqueue_script( 'qtipcall' );
99	wp_enqueue_style( 'dashicons' );
100
101	$atts = shortcode_atts(
102	array(
103	// Future home of shortcode atts.
104	),
105	$atts
106	);
107
108	$post_id = get_the_ID();
109
110	$content = do_shortcode( $content );
111
112	$count = $this->footnoteCount;
113
114	// Increment the counter.
115	$count++;
116
117	// Set the footnoteCount (This whole process needs reworked).
118	$this->footnoteCount = $count;
119
120	$this->easy_footnote_content( $content );
121
122	if ( ( is_singular() \|\| $efn_show_on_front ) && is_main_query() ) {
123	$footnoteLink = '#easy-footnote-bottom-' . $this->footnoteCount . '-' . $post_id;
124	} else {
125	$footnoteLink = get_permalink( get_the_ID() ) . '#easy-footnote-bottom-' . $this->footnoteCount . '-' . $post_id;
126	}
127
128	$footnoteContent = "<span id='easy-footnote-" . esc_attr( $this->footnoteCount ) . '-' . $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( $this->footnoteCount ) . "</sup></a></span>";
129
130	return $footnoteContent;
131	}
132
133	/**
134	* The content of a particular footnote.
135	*
136	* @param string $content The content from a particular call of the shortcode.
137	*/
138	public function easy_footnote_content( $content ) {
139	$this->footnotes[ $this->footnoteCount ] = $content;
140
141	return $this->footnotes;
142	}
143
144	/**
145	* Display the list of footnotes after the post content.
146	*
147	* @param string $content The content of the current post.
148	*/
149	public function easy_footnote_after_content( $content ) {
150	if ( isset( $this->footnoteOptions['hide_easy_footnote_after_posts'] ) && $this->footnoteOptions['hide_easy_footnote_after_posts'] ) {
151	return $content;
152	}
153
154	if ( isset( $this->footnoteOptions['show_easy_footnote_on_front'] ) && $this->footnoteOptions['show_easy_footnote_on_front'] ) {
155	$efn_show_on_front = is_front_page();
156	} else {
157	$efn_show_on_front = false;
158	}
159
160	if ( ( is_singular() \|\| $efn_show_on_front ) && is_main_query() ) {
161	$footnotesInsert = $this->footnotes;
162
163	$footnoteCopy = '';
164
165	$useLabel = $this->footnoteOptions['useLabel'];
166	$efLabel = $this->footnoteOptions['footnoteLabel'];
167
168	$post_id = get_the_ID();
169
170	foreach ( $footnotesInsert as $count => $footnote ) {
171	$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>';
172	}
173	if ( ! empty( $footnotesInsert ) ) {
174	if ( true === $useLabel ) {
175	$footnote_label = '<h4>' . esc_html( $efLabel ) . '</h4>';
176	// Filter for editing footnote label markup and output.
177	$footnote_label = apply_filters( 'efn_footnote_label', $footnote_label, $efLabel );
178
179	$content .= sprintf(
180	'<div class="easy-footnote-title">
181	%s
182	</div>',
183	$footnote_label
184	);
185	}
186
187	$footnote_content = '';
188
189	// Add filter before footnote list.
190	$footnote_content = apply_filters( 'before_footnote', $footnote_content );
191	$footnote_content .= '<ol class="easy-footnotes-wrapper">' . $footnoteCopy . '</ol>';
192
193	// Add filter after footnote list.
194	$footnote_content = apply_filters( 'after_footnote', $footnote_content );
195
196	$content .= do_shortcode( $footnote_content );
197	}
198	}
199
200	return $content;
201	}
202
203	/**
204	* Reset the footnote count and footnote array each time the_content has been run.
205	*
206	* @param string $content The content of the post from the_content filter.
207	*/
208	public function easy_footnote_reset( $content ) {
209	$this->footnoteCount = 0;
210
211	$this->footnotes = array();
212
213	return $content;
214	}
215
216	/**
217	* Include the easy-footnotes-admin.php file.
218	*/
219	public function easy_footnotes_admin() {
220	include 'easy-footnotes-admin.php';
221	}
222
223	/**
224	* Function to add options page for Easy Footnote Settings.
225	*/
226	public function easy_footnotes_admin_actions() {
227	add_options_page(
228	__( 'Easy Footnotes Settings', 'easy-footnotes' ),
229	__( 'Easy Footnotes', 'easy-footnotes' ),
230	'manage_options',
231	'easy-footnotes-settings',
232	array( $this, 'easy_footnotes_admin' )
233	);
234	}
235
236	/**
237	* Function for enqueuring EAsy Footnotes admin scripts.
238	*/
239	public function easy_footnotes_admin_scripts() {
240	wp_enqueue_style( 'easy-footnotes-admin-styles', plugins_url( '/assets/easy-footnotes-admin.css', __FILE__ ), '', '1.0.13' );
241	wp_enqueue_script( 'easy-footnotes-admin-scripts', plugins_url( '/assets/js/easy-footnotes-admin.js', __FILE__ ), array( 'jquery' ), '1.0.1', true );
242	}
243	}
244
245	$easyFootnotes = new easyFootnotes();
246