-
Notifications
You must be signed in to change notification settings - Fork 385
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add button into Site Health to reenable CSS transient caching (#4522)
* Add button into Site Health to reenable CSS transient caching * Use wp_jsonencode() instead of addslashes() Co-Authored-By: Weston Ruter <westonruter@google.com> * Remove unneeded PHPCS exception * Use wp.ajax and heredoc for JS script * Update styling * Add capability check * Use current_user_can() * Add CSS transient caching option to options manager validation * Fix code style issues * Only read Option::DISABLE_CSS_TRANSIENT_CACHING if exists * Remove <script> tags from JS code passed to wp_add_inline_script() * Remove pesky 2nd blank line Co-Authored-By: Weston Ruter <westonruter@google.com> * Rename AjaxAction to ReenableCssTransientCachingAjaxAction * Remove $access and default to authenticated users only * Remove $scope and default to admin backend only * Remove $action and hardcode as const * Remove $callback and move method into AjaxAction * Remove $selector and hardcode as const * Only register AJAX action on site-health.php screen * Use tabs instead of spaces to indent CSS * Escape button label translations * Add nonce verification * Disable button after click * Use DOMContentLoaded instead of a timeout * Indent JS code with tabs instead of spaces * Document $hook_suffix argument * Flesh out guidance for CSS transient caching * Avoid string interpolation for JS injection to better ensure late-escaping * Use nowdoc instead of heredoc Co-Authored-By: Alain Schlesser <alain.schlesser@gmail.com> Co-authored-by: Weston Ruter <westonruter@google.com>
- Loading branch information
1 parent
1868ea2
commit d1ea42f
Showing
3 changed files
with
219 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| <?php | ||
| /** | ||
| * Class ReenableCssTransientCachingAjaxAction. | ||
| * | ||
| * @package AmpProject\AmpWP | ||
| */ | ||
|
|
||
| namespace AmpProject\AmpWP\Admin; | ||
|
|
||
| use AMP_Options_Manager; | ||
| use AmpProject\AmpWP\Option; | ||
|
|
||
| /** | ||
| * Base class to define a new AJAX action. | ||
| * | ||
| * @package AmpProject\AmpWP | ||
| */ | ||
| final class ReenableCssTransientCachingAjaxAction { | ||
|
|
||
| /** | ||
| * Action to use for enqueueing the JS logic at the backend. | ||
| * | ||
| * @var string | ||
| */ | ||
| const BACKEND_ENQUEUE_ACTION = 'admin_enqueue_scripts'; | ||
|
|
||
| /** | ||
| * AJAX action name to use. | ||
| * | ||
| * @var string | ||
| */ | ||
| const AJAX_ACTION = 'amp_reenable_css_transient_caching'; | ||
|
|
||
| /** | ||
| * Selector to attach the click handler to. | ||
| * | ||
| * @var string | ||
| */ | ||
| const SELECTOR = 'a.reenable-css-transient-caching'; | ||
|
|
||
| /** | ||
| * Register the AJAX action with the WordPress system. | ||
| */ | ||
| public function register() { | ||
| add_action( static::BACKEND_ENQUEUE_ACTION, [ $this, 'register_ajax_script' ] ); | ||
| add_action( 'wp_ajax_' . self::AJAX_ACTION, [ $this, 'reenable_css_transient_caching' ] ); | ||
| } | ||
|
|
||
| /** | ||
| * Register the AJAX logic. | ||
| * | ||
| * @param string $hook_suffix Hook suffix to identify from what admin page the call is coming from. | ||
| */ | ||
| public function register_ajax_script( $hook_suffix ) { | ||
| if ( 'site-health.php' !== $hook_suffix ) { | ||
| return; | ||
| } | ||
|
|
||
| $script = <<< 'JS_SCRIPT' | ||
| ;( function () { | ||
| window.addEventListener( 'DOMContentLoaded', ( event ) => { | ||
| var selector = SELECTOR; | ||
| ( document.querySelectorAll( selector ) || [] ) | ||
| .forEach( ( element ) => { | ||
| element.addEventListener( 'click', function ( event ) { | ||
| event.preventDefault(); | ||
| if ( element.classList.contains( 'disabled' ) ) { | ||
| return; | ||
| } | ||
| wp.ajax.post( ACTION, ARGUMENTS ) | ||
| .done( function () { | ||
| element.classList.remove( 'ajax-failure' ); | ||
| element.classList.add( 'ajax-success' ) | ||
| element.classList.add( 'disabled' ) | ||
| } ) | ||
| .fail( function () { | ||
| element.classList.remove( 'ajax-success' ); | ||
| element.classList.add( 'ajax-failure' ) | ||
| element.classList.add( 'disabled' ) | ||
| } ); | ||
| } ); | ||
| } ); | ||
| } ); | ||
| } )(); | ||
| JS_SCRIPT; | ||
|
|
||
| $replacements = array_map( | ||
| 'wp_json_encode', | ||
| [ | ||
| 'SELECTOR' => self::SELECTOR, | ||
| 'ACTION' => self::AJAX_ACTION, | ||
| 'ARGUMENTS' => [ 'nonce' => wp_create_nonce( self::AJAX_ACTION ) ], | ||
| ] | ||
| ); | ||
|
|
||
| $script = str_replace( | ||
| array_keys( $replacements ), | ||
| array_values( $replacements ), | ||
| $script | ||
| ); | ||
|
|
||
| wp_enqueue_script( 'wp-util' ); | ||
| wp_add_inline_script( 'wp-util', $script ); | ||
| } | ||
|
|
||
| /** | ||
| * Re-enable the CSS Transient caching. | ||
| * | ||
| * This is triggered via an AJAX call from the Site Health panel. | ||
| */ | ||
| public function reenable_css_transient_caching() { | ||
| check_ajax_referer( self::AJAX_ACTION, 'nonce' ); | ||
|
|
||
| if ( ! current_user_can( 'manage_options' ) ) { | ||
| wp_send_json_error( 'Unauthorized.', 401 ); | ||
| } | ||
|
|
||
| $result = AMP_Options_Manager::update_option( Option::DISABLE_CSS_TRANSIENT_CACHING, false ); | ||
|
|
||
| if ( false === $result ) { | ||
| wp_send_json_error( 'CSS transient caching could not be re-enabled.', 500 ); | ||
| } | ||
|
|
||
| wp_send_json_success( 'CSS transient caching was re-enabled.', 200 ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters