%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
namespace WP_Rocket\Engine\Heartbeat;
use WP_Rocket\Event_Management\Subscriber_Interface;
use WP_Rocket\Admin\Options_Data as Options;
/**
* Event subscriber to control Heartbeat behavior.
*
* @since 3.7 Moved to new architecture.
* @since 3.2
*/
class HeartbeatSubscriber implements Subscriber_Interface {
/**
* Instance of the Option_Data class.
*
* @var Options
* @since 3.2
* @access private
*/
private $options;
/**
* Constructor.
*
* @since 3.2
* @access public
* @param Options $options Instance of the Option_Data class.
*/
public function __construct( Options $options ) {
$this->options = $options;
}
/**
* Return an array of events that this subscriber wants to listen to.
*
* @since 3.2
* @access public
*
* @return array
*/
public static function get_subscribed_events() {
$priority = PHP_INT_MAX - 60;
return [
'admin_enqueue_scripts' => [ 'maybe_disable', $priority ],
'wp_enqueue_scripts' => [ 'maybe_disable', $priority ],
'heartbeat_settings' => [ 'maybe_modify_period', $priority ],
];
}
/**
* Maybe disable Heartbeat.
*
* @since 3.2
* @access public
*/
public function maybe_disable() {
if ( ! $this->behavior_match_context( 'disable' ) || rocket_bypass() ) {
return;
}
wp_deregister_script( 'heartbeat' );
/**
* Enqueue an empty heartbeat script to prevent query monitor error
* Added to the footer
*/
wp_enqueue_script( 'heartbeat', WP_ROCKET_ASSETS_JS_URL . 'heartbeat.js', null, WP_ROCKET_VERSION, true );
}
/**
* Maybe modify Heartbeat periodicity.
*
* @since 3.2
* @access public
*
* @param array $settings The Heartbeat settings.
*
* @return array
*/
public function maybe_modify_period( $settings ) {
if ( ! $this->behavior_match_context( 'reduce_periodicity' ) ) {
return $settings;
}
$settings['interval'] = 120;
$settings['minimalInterval'] = 120;
return $settings;
}
/**
* Tell if we're in frontend, backend, or a post edition page.
*
* @since 3.2
* @access private
*
* @return string Either 'site' (frontend), 'admin' (backend), or 'editor'.
*/
private function get_current_context() {
$request_uri = ! empty( $_SERVER['REQUEST_URI'] ) ? wp_unslash( $_SERVER['REQUEST_URI'] ) : ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$request_uri = explode( '?', $request_uri, 2 );
$request_uri = reset( $request_uri );
if ( $request_uri && preg_match( '@/wp-admin/post(-new)?\.php$@', $request_uri ) ) {
$context = 'editor';
} elseif ( is_admin() ) {
$context = 'admin';
if ( wp_doing_ajax() && ! empty( $_POST['action'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
if ( 'wp-remove-post-lock' === sanitize_key( wp_unslash( $_POST['action'] ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
$context = 'editor';
} elseif ( ! empty( $_POST['screen_id'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
switch ( $_POST['screen_id'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
case 'post':
$context = 'editor';
break;
case 'front':
$context = 'site';
}
}
}
} else {
$context = 'site';
}
/**
* Filter the current context.
* This can be useful for ajax requests or requests to admin-post.php, as there is no easy way to tell where those requests come from.
*
* @since 3.2
*
* @param string $context string Either 'site' (frontend), 'admin' (backend), or 'editor'.
*/
$filtered_context = apply_filters( 'rocket_heartbeat_context', $context );
$contexts = [
'editor' => 1,
'admin' => 1,
'site' => 1,
];
return isset( $contexts[ $filtered_context ] ) ? $filtered_context : $context;
}
/**
* Tell if the given behavior is what is set in the addon settings, accordingly to the current context.
*
* @since 3.2
* @access private
*
* @param string $behavior Either '', 'disable', or 'reduce_periodicity'.
*
* @return bool
*/
private function behavior_match_context( $behavior ) {
if ( ! $this->options->get( 'control_heartbeat', 0 ) ) {
return false;
}
$context = $this->get_current_context();
return $behavior === $this->options->get( 'heartbeat_' . $context . '_behavior', '' );
}
}
Zerion Mini Shell 1.0