486 lines
17 KiB
PHP
486 lines
17 KiB
PHP
<?php // phpcs:disable WordPress.Files.FileName.InvalidClassFileName
|
||
/**
|
||
* Includes the main Class of the Plugin.
|
||
*
|
||
* @filesource
|
||
* @package footnotes
|
||
* @since 1.5.0
|
||
*
|
||
* @since 1.6.5 Bugfix: Improve widgets registration, thanks to @felipelavinz code contribution.
|
||
* @since 1.6.5 Update: Fix for deprecated PHP function create_function(), thanks to @psykonevro @daliasued bug reports, thanks to @felipelavinz code contribution.
|
||
* @since 2.0.0 Update: Tooltips: fix disabling bug by loading jQuery UI library, thanks to @rajinderverma @ericcorbett2 @honlapdavid @mmallett bug reports, thanks to @vonpiernik code contribution.
|
||
*
|
||
* @since 2.0.3 add versioning of public.css for cache busting
|
||
* @since 2.0.4 add jQuery UI from WordPress
|
||
* @since 2.1.4 automate passing version number for cache busting
|
||
* @since 2.1.4 optionally enqueue an extra stylesheet
|
||
*
|
||
* @since 2.5.5 Update: Stylesheets: increase speed and energy efficiency by tailoring stylesheets to the needs of the instance, thanks to @docteurfitness design contribution.
|
||
* @since 2.5.5 Bugfix: Stylesheets: minify to shrink the carbon footprint, increase speed and implement best practice, thanks to @docteurfitness issue report.
|
||
* @since 2.5.5 Bugfix: Libraries: optimize processes by loading external and internal scripts only if needed, thanks to @docteurfitness issue report.
|
||
* @since 2.5.6 Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.
|
||
*/
|
||
|
||
/**
|
||
* Entry point of the Plugin. Loads the Dashboard and executes the Task.
|
||
*
|
||
* @since 1.5.0
|
||
*/
|
||
class MCI_Footnotes {
|
||
|
||
/**
|
||
* Reference to the Plugin Task object.
|
||
*
|
||
* @since 1.5.0
|
||
* @var null|MCI_Footnotes_Task
|
||
*/
|
||
public $a_obj_task = null;
|
||
|
||
/**
|
||
* Allows to determine whether tooltips are enabled.
|
||
* The actual value of these properties is configurable.
|
||
*
|
||
* - Bugfix: Templates: optimize template load and processing based on settings, thanks to @misfist code contribution.
|
||
*
|
||
* @since 2.4.0
|
||
*
|
||
* @contributor Patrizia Lutz @misfist
|
||
* @link https://wordpress.org/support/topic/template-override-filter/#post-13864301
|
||
* @link https://github.com/misfist/footnotes/releases/tag/2.4.0d3 repository
|
||
* @link https://github.com/misfist/footnotes/compare/2.4.0%E2%80%A62.4.0d3 diff
|
||
*
|
||
* @var bool
|
||
*
|
||
* Template process and script / stylesheet load optimization.
|
||
* Streamline process depending on tooltip enabled status.
|
||
* Load tooltip inline script only if jQuery tooltips are enabled.
|
||
*/
|
||
public static $a_bool_tooltips_enabled = false;
|
||
|
||
/**
|
||
* Allows to determine whether alternative tooltips are enabled.
|
||
*
|
||
* - Bugfix: Tooltips: optional alternative JS implementation with CSS transitions to fix configuration-related outage, thanks to @andreasra feedback.
|
||
*
|
||
* @since 2.1.1
|
||
*
|
||
* @reporter @andreasra
|
||
* @link https://wordpress.org/support/topic/footnotes-appearing-in-header/page/2/#post-13632566
|
||
*
|
||
* @since 2.4.0
|
||
* @contributor Patrizia Lutz @misfist
|
||
* @var bool
|
||
*/
|
||
public static $a_bool_alternative_tooltips_enabled = false;
|
||
|
||
/**
|
||
* Allows to determine whether AMP compatibility mode is enabled.
|
||
*
|
||
* - 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.
|
||
*
|
||
* @since 2.5.11 (draft)
|
||
* @since 2.6.0 (release)
|
||
*
|
||
* @contributor @milindmore22
|
||
* @link https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933
|
||
*
|
||
* @contributor @westonruter
|
||
* @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
|
||
*
|
||
* @var bool
|
||
*/
|
||
public static $a_bool_amp_enabled = false;
|
||
|
||
/**
|
||
* Allows to determine the script mode among jQuery or plain JS.
|
||
*
|
||
* - Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.
|
||
*
|
||
* @since 2.5.6
|
||
*
|
||
* @reporter @hopper87it
|
||
* @link https://wordpress.org/support/topic/footnotes-wp-rocket/
|
||
*
|
||
* @reporter @pkverma99
|
||
* @link https://wordpress.org/support/topic/footnotes-wp-rocket/#post-14076188
|
||
*
|
||
* @var str 'js' Plain JavaScript.
|
||
* 'jquery' Use jQuery libraries.
|
||
*/
|
||
public static $a_str_script_mode = 'js';
|
||
|
||
/**
|
||
* Executes the Plugin.
|
||
*
|
||
* @since 1.5.0
|
||
*
|
||
* - Bugfix: Improve widgets registration, thanks to @felipelavinz code contribution.
|
||
*
|
||
* @since 1.6.5
|
||
*
|
||
* @contributor @felipelavinz
|
||
* @link https://github.com/benleyjyc/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793
|
||
* @link https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793
|
||
*
|
||
* @see self::initialize_widgets()
|
||
*/
|
||
public function run() {
|
||
// Register language.
|
||
MCI_Footnotes_Language::register_hooks();
|
||
// Register Button hooks.
|
||
MCI_Footnotes_WYSIWYG::register_hooks();
|
||
// Register general hooks.
|
||
MCI_Footnotes_Hooks::register_hooks();
|
||
|
||
// Initialize the Plugin Dashboard.
|
||
$this->initialize_dashboard();
|
||
// Initialize the Plugin Task.
|
||
$this->initialize_task();
|
||
|
||
// Register all Public Stylesheets and Scripts.
|
||
add_action( 'init', array( $this, 'register_public' ) );
|
||
// Enqueue all Public Stylesheets and Scripts.
|
||
add_action( 'wp_enqueue_scripts', array( $this, 'register_public' ) );
|
||
// Register all Widgets of the Plugin..
|
||
add_action( 'widgets_init', array( $this, 'initialize_widgets' ) );
|
||
}
|
||
|
||
/**
|
||
* Initializes all Widgets of the Plugin.
|
||
*
|
||
* @since 1.5.0
|
||
*
|
||
* - Update: Fix for deprecated PHP function create_function(), thanks to @psykonevro @daliasued bug reports, thanks to @felipelavinz code contribution
|
||
*
|
||
* @since 1.6.5
|
||
*
|
||
* @contributor @felipelavinz
|
||
* @link https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793
|
||
*
|
||
* @reporter @psykonevro
|
||
* @link https://wordpress.org/support/topic/bug-function-create_function-is-deprecated/
|
||
* @link https://wordpress.org/support/topic/deprecated-function-create_function-14/
|
||
*
|
||
* @reporter @daliasued
|
||
* @link https://wordpress.org/support/topic/deprecated-function-create_function-14/#post-13312853
|
||
*
|
||
* create_function() was deprecated in PHP 7.2.0 and removed in PHP 8.0.0.
|
||
* @link https://www.php.net/manual/en/function.create-function.php
|
||
*
|
||
* The fix is to move add_action() above into run(),
|
||
* and use the bare register_widget() here.
|
||
* @see self::run()
|
||
*
|
||
* Also, the visibility of initialize_widgets() is not private any longer.
|
||
*/
|
||
public function initialize_widgets() {
|
||
register_widget( 'MCI_Footnotes_Widget_Reference_container' );
|
||
}
|
||
|
||
/**
|
||
* Initializes the Dashboard of the Plugin and loads them.
|
||
*
|
||
* @since 1.5.0
|
||
*/
|
||
private function initialize_dashboard() {
|
||
new MCI_Footnotes_Layout_Init();
|
||
}
|
||
|
||
/**
|
||
* Initializes the Plugin Task and registers the Task hooks.
|
||
*
|
||
* @since 1.5.0
|
||
*/
|
||
private function initialize_task() {
|
||
$this->a_obj_task = new MCI_Footnotes_Task();
|
||
$this->a_obj_task->register_hooks();
|
||
}
|
||
|
||
/**
|
||
* Registers and enqueues scripts and stylesheets to the public pages.
|
||
*
|
||
* @since 1.5.0
|
||
*
|
||
* @since 2.0.0 Update: Tooltips: fix disabling bug by loading jQuery UI library, thanks to @rajinderverma @ericcorbett2 @honlapdavid @mmallett bug reports, thanks to @vonpiernik code contribution.
|
||
* @since 2.0.3 add versioning of public.css for cache busting
|
||
* @since 2.0.4 add jQuery UI from WordPress
|
||
* @since 2.1.4 automate passing version number for cache busting
|
||
* @since 2.1.4 optionally enqueue an extra stylesheet
|
||
*/
|
||
public function register_public() {
|
||
|
||
/**
|
||
* Enqueues external scripts.
|
||
*
|
||
* - Bugfix: Libraries: optimize processes by loading external and internal scripts only if needed, thanks to @docteurfitness issue report.
|
||
*
|
||
* @since 2.5.5
|
||
* @reporter @docteurfitness
|
||
* @link https://wordpress.org/support/topic/simply-speed-optimisation/
|
||
*
|
||
* The condition about tooltips was missing, only the not-alternative-tooltips part was present.
|
||
*/
|
||
// Set conditions re-used for stylesheet enqueuing and in class/task.php.
|
||
self::$a_bool_amp_enabled = MCI_Footnotes_Convert::to_bool( MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE ) );
|
||
self::$a_bool_tooltips_enabled = MCI_Footnotes_Convert::to_bool( MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED ) );
|
||
self::$a_bool_alternative_tooltips_enabled = MCI_Footnotes_Convert::to_bool( MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE ) );
|
||
self::$a_str_script_mode = MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE );
|
||
|
||
/**
|
||
* Enqueues the jQuery library registered by WordPress.
|
||
*
|
||
* - Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.
|
||
*
|
||
* @since 2.5.6
|
||
*
|
||
* @reporter @hopper87it
|
||
* @link https://wordpress.org/support/topic/footnotes-wp-rocket/
|
||
*
|
||
* jQuery is also used for animated scrolling, so it was loaded by default.
|
||
* The function wp_enqueue_script() avoids loading the same library multiple times.
|
||
* After adding the alternative reference container, jQuery has become optional,
|
||
* but still enabled by default.
|
||
*/
|
||
if ( ! self::$a_bool_amp_enabled ) {
|
||
|
||
if ( 'jquery' === self::$a_str_script_mode || ( self::$a_bool_tooltips_enabled && ! self::$a_bool_alternative_tooltips_enabled ) ) {
|
||
|
||
wp_enqueue_script( 'jquery' );
|
||
|
||
}
|
||
|
||
if ( self::$a_bool_tooltips_enabled && ! self::$a_bool_alternative_tooltips_enabled ) {
|
||
|
||
/**
|
||
* Enqueues the jQuery Tools library shipped with the plugin.
|
||
*
|
||
* Redacted jQuery.browser, completed minification;
|
||
* see full header in js/jquery.tools.js.
|
||
*
|
||
* Add versioning.
|
||
*
|
||
* @since 2.1.2
|
||
*
|
||
* No '-js' in the handle, is appended automatically.
|
||
*
|
||
* Deferring to the footer breaks jQuery tooltip display.
|
||
*/
|
||
wp_enqueue_script(
|
||
'mci-footnotes-jquery-tools',
|
||
plugins_url( 'footnotes/js/jquery.tools.min.js' ),
|
||
array(),
|
||
'1.2.7.redacted.2',
|
||
false
|
||
);
|
||
|
||
/**
|
||
* Enqueues some jQuery UI libraries registered by WordPress.
|
||
*
|
||
* - Update: Tooltips: fix disabling bug by loading jQuery UI library, thanks to @rajinderverma @ericcorbett2 @honlapdavid @mmallett bug reports, thanks to @vonpiernik code contribution.
|
||
*
|
||
* @since 2.0.0
|
||
*
|
||
* @reporter @rajinderverma
|
||
* @link https://wordpress.org/support/topic/tooltip-hover-not-showing/
|
||
*
|
||
* @reporter @ericcorbett2
|
||
* @link https://wordpress.org/support/topic/tooltip-hover-not-showing/#post-13324142
|
||
*
|
||
* @reporter @honlapdavid
|
||
* @link https://wordpress.org/support/topic/tooltip-hover-not-showing/#post-13355421
|
||
*
|
||
* @reporter @mmallett
|
||
* @link https://wordpress.org/support/topic/tooltip-hover-not-showing/#post-13445437
|
||
*
|
||
* Fetch jQuery UI from cdnjs.cloudflare.com.
|
||
* @since 2.0.0
|
||
* @contributor @vonpiernik
|
||
* @link https://wordpress.org/support/topic/tooltip-hover-not-showing/#post-13456762
|
||
*
|
||
* jQueryUI re-enables the tooltip infobox disabled when WPv5.5 was released. * @since 2.1.2
|
||
*
|
||
* - Update: Libraries: Load jQuery UI from WordPress, thanks to @check2020de issue report.
|
||
*
|
||
* @since 2.0.4
|
||
* @reporter @check2020de
|
||
* @link https://wordpress.org/support/topic/gdpr-issue-with-jquery/
|
||
* @link https://wordpress.stackexchange.com/questions/273986/correct-way-to-enqueue-jquery-ui
|
||
*
|
||
* If alternative tooltips are enabled, these libraries are not needed.
|
||
*/
|
||
wp_enqueue_script( 'jquery-ui-core' );
|
||
wp_enqueue_script( 'jquery-ui-widget' );
|
||
wp_enqueue_script( 'jquery-ui-position' );
|
||
wp_enqueue_script( 'jquery-ui-tooltip' );
|
||
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Enables enqueuing a new-scheme stylesheet.
|
||
*
|
||
* @since 2.5.5
|
||
*
|
||
* Enables enqueuing the formatted individual stylesheets if false.
|
||
* WARNING: This facility is designed for development and must NOT be used in production.
|
||
*
|
||
* The Boolean may be set at the bottom of the plugin’s main PHP file.
|
||
* @see footnotes.php
|
||
*/
|
||
if ( PRODUCTION_ENV ) {
|
||
|
||
/**
|
||
* Enqueues a minified united external stylesheet in production.
|
||
*
|
||
* - Update: Stylesheets: increase speed and energy efficiency by tailoring stylesheets to the needs of the instance, thanks to @docteurfitness design contribution.
|
||
* - Bugfix: Stylesheets: minify to shrink the carbon footprint, increase speed and implement best practice, thanks to @docteurfitness issue report.
|
||
*
|
||
* @since 2.5.5
|
||
*
|
||
* @contributor @docteurfitness
|
||
* @link https://wordpress.org/support/topic/simply-speed-optimisation/
|
||
*
|
||
* @reporter @docteurfitness
|
||
* @link https://wordpress.org/support/topic/simply-speed-optimisation/
|
||
*
|
||
* The dashboard stylesheet is minified as-is.
|
||
* @see class/dashboard/layout.php
|
||
*
|
||
* @since 2.0.3 add versioning of public.css for cache busting.
|
||
* Plugin version number is needed for busting browser caches after each plugin update.
|
||
*
|
||
* @since 2.1.4 automate passing version number for cache busting.
|
||
* The constant C_STR_FOOTNOTES_VERSION is defined at start of footnotes.php.
|
||
*
|
||
* The media scope argument 'all' is the default.
|
||
* No need to use '-css' in the handle, as this is appended automatically.
|
||
*/
|
||
// Set tooltip mode for use in stylesheet name.
|
||
if ( self::$a_bool_tooltips_enabled ) {
|
||
|
||
if ( self::$a_bool_amp_enabled ) {
|
||
$l_str_tooltip_mode_short = 'ampt';
|
||
$l_str_tooltip_mode_long = 'amp-tooltips';
|
||
|
||
} elseif ( self::$a_bool_alternative_tooltips_enabled ) {
|
||
$l_str_tooltip_mode_short = 'altt';
|
||
$l_str_tooltip_mode_long = 'alternative-tooltips';
|
||
|
||
} else {
|
||
$l_str_tooltip_mode_short = 'jqtt';
|
||
$l_str_tooltip_mode_long = 'jquery-tooltips';
|
||
|
||
}
|
||
} else {
|
||
$l_str_tooltip_mode_short = 'nott';
|
||
$l_str_tooltip_mode_long = 'no-tooltips';
|
||
}
|
||
|
||
// Set basic responsive page layout mode for use in stylesheet name.
|
||
$l_str_page_layout_option = MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT );
|
||
switch ( $l_str_page_layout_option ) {
|
||
case 'reference-container':
|
||
$l_str_layout_mode = '1';
|
||
break;
|
||
case 'entry-content':
|
||
$l_str_layout_mode = '2';
|
||
break;
|
||
case 'main-content':
|
||
$l_str_layout_mode = '3';
|
||
break;
|
||
case 'none':
|
||
default:
|
||
$l_str_layout_mode = '0';
|
||
break;
|
||
}
|
||
|
||
// Enqueue the tailored united minified stylesheet.
|
||
wp_enqueue_style(
|
||
'mci-footnotes-' . $l_str_tooltip_mode_long . '-pagelayout-' . $l_str_page_layout_option,
|
||
plugins_url(
|
||
MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/footnotes-' . $l_str_tooltip_mode_short . 'brpl' . $l_str_layout_mode . '.min.css'
|
||
),
|
||
array(),
|
||
C_STR_FOOTNOTES_VERSION,
|
||
'all'
|
||
);
|
||
|
||
} else {
|
||
|
||
/**
|
||
* Enqueues external stylesheets, ONLY in development now.
|
||
*
|
||
* @since 2.1.4 optionally enqueue an extra stylesheet.
|
||
*
|
||
* This optional layout fix is useful by lack of layout support.
|
||
*/
|
||
wp_enqueue_style(
|
||
'mci-footnotes-common',
|
||
plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-common.css' ),
|
||
array(),
|
||
filemtime(
|
||
plugin_dir_path(
|
||
dirname( __FILE__, 1 )
|
||
) . 'css/dev-common.css'
|
||
)
|
||
);
|
||
wp_enqueue_style(
|
||
'mci-footnotes-tooltips',
|
||
plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-tooltips.css' ),
|
||
array(),
|
||
filemtime(
|
||
plugin_dir_path(
|
||
dirname( __FILE__, 1 )
|
||
) . 'css/dev-tooltips.css'
|
||
)
|
||
);
|
||
|
||
if ( self::$a_bool_amp_enabled ) {
|
||
wp_enqueue_style(
|
||
'mci-footnotes-amp',
|
||
plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-amp-tooltips.css' ),
|
||
array(),
|
||
filemtime(
|
||
plugin_dir_path(
|
||
dirname( __FILE__, 1 )
|
||
) . 'css/dev-amp-tooltips.css'
|
||
)
|
||
);
|
||
}
|
||
|
||
if ( self::$a_bool_alternative_tooltips_enabled ) {
|
||
wp_enqueue_style(
|
||
'mci-footnotes-alternative',
|
||
plugins_url( MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-tooltips-alternative.css' ),
|
||
array(),
|
||
filemtime(
|
||
plugin_dir_path(
|
||
dirname( __FILE__, 1 )
|
||
) . 'css/dev-tooltips-alternative.css'
|
||
)
|
||
);
|
||
}
|
||
|
||
$l_str_page_layout_option = MCI_Footnotes_Settings::instance()->get( MCI_Footnotes_Settings::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT );
|
||
if ( 'none' !== $l_str_page_layout_option ) {
|
||
wp_enqueue_style(
|
||
'mci-footnotes-layout-' . $l_str_page_layout_option,
|
||
plugins_url(
|
||
MCI_Footnotes_Config::C_STR_PLUGIN_NAME . '/css/dev-layout-' . $l_str_page_layout_option . '.css'
|
||
),
|
||
array(),
|
||
filemtime(
|
||
plugin_dir_path(
|
||
dirname( __FILE__, 1 )
|
||
) . 'css/dev-layout-' . $l_str_page_layout_option . '.css'
|
||
),
|
||
'all'
|
||
);
|
||
}
|
||
}
|
||
}
|
||
}
|