Ben Goldsworthy
1284544556
I had to use some RegEx-fu for this. Specifically:
```bash
find ./{footnotes.php,includes.php,class/} -type f -name "*.php" -exec sed -i 's/\(p\|l\|a\)_\(str\|bool\|int\|obj\|flo\|arr\)_//g' {} \;
find ./{footnotes.php,includes.php,class/} -type f -name "*.php" -exec sed -i 's/MCI_Footnotes/Footnotes/g' {} \;
find ./{footnotes.php,includes.php,class/} -type f -name "*.php" -exec sed -i 's/C_\(INT\|STR\|FLO\)_//g' {} \;
```
This should have covered all the bases.
In my testing I encountered one error caused by these changes.
In the `add_select_box` function in `/class/dashboard/layout.php`,
there was a function parameter called `$p_arr_options` and a variable
called `$l_str_options`. Removing the Hungarian notation caused an
error as these two variables were both now called `$options`.
This has been fixed, and I like to think that that will have been
the only naming conflict, but I think it is more likely that there
maybe others. Further testing is required before I am happy calling
this release-ready.
Close #34, progress #36
104 lines
3.3 KiB
PHP
104 lines
3.3 KiB
PHP
<?php // phpcs:disable WordPress.Files.FileName.InvalidClassFileName
|
|
/**
|
|
* Includes the Class to handle the WYSIWYG-Buttons.
|
|
*
|
|
* @filesource
|
|
* @package footnotes
|
|
* @since 1.5.0
|
|
*/
|
|
|
|
/**
|
|
* Handles the WSYIWYG-Buttons.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
class Footnotes_WYSIWYG {
|
|
|
|
/**
|
|
* Registers Button hooks.
|
|
*
|
|
* @since 1.5.0
|
|
*
|
|
* - Bugfix: Editor buttons: debug button by reverting name change in PHP file while JS file and HTML template remained unsynced, thanks to @gova bug report.
|
|
*
|
|
* @reporter @gova
|
|
* @link https://wordpress.org/support/topic/back-end-footnotes-not-working-400-bad-erro/
|
|
*
|
|
* @since 2.6.5
|
|
* @return void
|
|
*/
|
|
public static function register_hooks() {
|
|
add_filter( 'mce_buttons', array( 'Footnotes_WYSIWYG', 'new_visual_editor_button' ) );
|
|
add_action( 'admin_print_footer_scripts', array( 'Footnotes_WYSIWYG', 'new_plain_text_editor_button' ) );
|
|
|
|
add_filter( 'mce_external_plugins', array( 'Footnotes_WYSIWYG', 'include_scripts' ) );
|
|
|
|
// phpcs:disable
|
|
// 'footnotes_getTags' must match its instance in wysiwyg-editor.js.
|
|
// 'footnotes_getTags' must match its instance in editor-button.html.
|
|
add_action( 'wp_ajax_nopriv_footnotes_getTags', array( 'Footnotes_WYSIWYG', 'ajax_callback' ) );
|
|
add_action( 'wp_ajax_footnotes_getTags', array( 'Footnotes_WYSIWYG', 'ajax_callback' ) );
|
|
// phpcs:enable
|
|
}
|
|
|
|
|
|
/**
|
|
* Append a new Button to the WYSIWYG editor of Posts and Pages.
|
|
*
|
|
* @since 1.5.0
|
|
* @param array $buttons pre defined Buttons from WordPress.
|
|
* @return array
|
|
*/
|
|
public static function new_visual_editor_button( $buttons ) {
|
|
array_push( $buttons, Footnotes_Config::PLUGIN_NAME );
|
|
return $buttons;
|
|
}
|
|
|
|
/**
|
|
* Add a new button to the plain text editor.
|
|
*
|
|
* @since 1.5.0
|
|
*/
|
|
public static function new_plain_text_editor_button() {
|
|
$template = new Footnotes_Template( Footnotes_Template::DASHBOARD, 'editor-button' );
|
|
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo $template->get_content();
|
|
// phpcs:enable
|
|
}
|
|
|
|
/**
|
|
* Includes the Plugins WYSIWYG editor script.
|
|
*
|
|
* @since 1.5.0
|
|
* @param array $plugins Scripts to be included to the editor.
|
|
* @return array
|
|
*/
|
|
public static function include_scripts( $plugins ) {
|
|
$plugins[ Footnotes_Config::PLUGIN_NAME ] = plugins_url( '/../js/wysiwyg-editor.js', __FILE__ );
|
|
return $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.
|
|
$starting_tag = Footnotes_Settings::instance()->get( Footnotes_Settings::FOOTNOTES_SHORT_CODE_START );
|
|
$ending_tag = Footnotes_Settings::instance()->get( Footnotes_Settings::FOOTNOTES_SHORT_CODE_END );
|
|
if ( 'userdefined' === $starting_tag || 'userdefined' === $ending_tag ) {
|
|
$starting_tag = Footnotes_Settings::instance()->get( Footnotes_Settings::FOOTNOTES_SHORT_CODE_START_USER_DEFINED );
|
|
$ending_tag = Footnotes_Settings::instance()->get( Footnotes_Settings::FOOTNOTES_SHORT_CODE_END_USER_DEFINED );
|
|
}
|
|
echo json_encode(
|
|
array(
|
|
'start' => htmlspecialchars( $starting_tag ),
|
|
'end' => htmlspecialchars( $ending_tag ),
|
|
)
|
|
);
|
|
exit;
|
|
}
|
|
}
|