109 lines
3.2 KiB
PHP
109 lines
3.2 KiB
PHP
<?php
|
|
/**
|
|
* Admin: Footnotes_WYSIWYG class
|
|
*
|
|
* The Admin. subpackage is initialised at runtime by the {@see Footnotes_Admin}
|
|
* class, which draws in the {@see Footnotes_WYSIWYG} class for WYSIWYG editor
|
|
* integration and the {@see footnotes\admin_layout} subpackage for rendering
|
|
* dashboard pages.
|
|
*
|
|
* @package footnotes\admin
|
|
* @since 1.5.0
|
|
* @since 2.8.0 Rename file from `wysiwyg.php` to `class-footnotes-wysiwyg.php`,
|
|
* move from `class/` sub-directory to `admin/`.
|
|
*/
|
|
|
|
/**
|
|
* Class providing WYSIWYG editor intergration for the plugin.
|
|
*
|
|
* @package footnotes\admin
|
|
* @since 1.5.0
|
|
*/
|
|
class Footnotes_WYSIWYG {
|
|
|
|
/**
|
|
* The ID of this plugin.
|
|
*
|
|
* @access private
|
|
* @var string $plugin_name The ID of this plugin.
|
|
*
|
|
* @since 2.8.0
|
|
*/
|
|
private $plugin_name;
|
|
|
|
/**
|
|
* Initialize the class and set its properties.
|
|
*
|
|
* @param string $plugin_name The name of this plugin.
|
|
*
|
|
* @since 2.8.0
|
|
*/
|
|
public function __construct( $plugin_name ) {
|
|
|
|
$this->plugin_name = $plugin_name;
|
|
|
|
}
|
|
|
|
/**
|
|
* Append a new Button to the WYSIWYG editor of Posts and Pages.
|
|
*
|
|
* @param string[] $p_arr_buttons Already-defined editor buttons.
|
|
* @return string[]
|
|
*
|
|
* @since 1.5.0
|
|
* @todo Should this be `static`?
|
|
*/
|
|
public static function new_visual_editor_button( $p_arr_buttons ) {
|
|
array_push( $p_arr_buttons, 'footnotes' );
|
|
return $p_arr_buttons;
|
|
}
|
|
|
|
/**
|
|
* Add a new button to the plain text editor.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
public static function new_plain_text_editor_button() {
|
|
$l_obj_template = new Footnotes_Template( Footnotes_Template::C_STR_DASHBOARD, 'editor-button' );
|
|
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo $l_obj_template->get_content();
|
|
// phpcs:enable
|
|
}
|
|
|
|
/**
|
|
* Includes the Plugins WYSIWYG editor script.
|
|
*
|
|
* @param string[] $p_arr_plugins Scripts to be included by the editor.
|
|
* @return string[]
|
|
*
|
|
* @since 1.5.0
|
|
* @todo Should this be `static`?
|
|
*/
|
|
public static function include_scripts( $p_arr_plugins ) {
|
|
$p_arr_plugins['footnotes'] = plugins_url( '/../admin/js/wysiwyg-editor' . ( ( PRODUCTION_ENV ) ? '.min' : '' ) . '.js', __FILE__ );
|
|
return $p_arr_plugins;
|
|
}
|
|
|
|
/**
|
|
* AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.
|
|
* Returns an JSON encoded array with the Footnotes start and end short code.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
public static function ajax_callback() {
|
|
// Get start and end tag for the footnotes short code.
|
|
$l_str_starting_tag = Footnotes_Settings::instance()->get( Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START );
|
|
$l_str_ending_tag = Footnotes_Settings::instance()->get( Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END );
|
|
if ( 'userdefined' === $l_str_starting_tag || 'userdefined' === $l_str_ending_tag ) {
|
|
$l_str_starting_tag = Footnotes_Settings::instance()->get( Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED );
|
|
$l_str_ending_tag = Footnotes_Settings::instance()->get( Footnotes_Settings::C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED );
|
|
}
|
|
echo wp_json_encode(
|
|
array(
|
|
'start' => htmlspecialchars( $l_str_starting_tag ),
|
|
'end' => htmlspecialchars( $l_str_ending_tag ),
|
|
)
|
|
);
|
|
exit;
|
|
}
|
|
}
|