File: /home/mirz4654/www/wp-content/plugins/wp-rocket/inc/classes/admin/settings/class-page.php
<?php
namespace WP_Rocket\Admin\Settings;
use \WP_Rocket\Interfaces\Render_Interface;
use WP_Rocket\Admin\Database\Optimization;
defined( 'ABSPATH' ) || die( 'Cheatin’ uh?' );
/**
* Registers the admin page and WP Rocket settings
*
* @since 3.0
* @author Remy Perona
*/
class Page {
/**
* Plugin slug
*
* @since 3.0
* @author Remy Perona
*
* @var string
*/
private $slug;
/**
* Plugin page title
*
* @since 3.0
* @author Remy Perona
*
* @var string
*/
private $title;
/**
* Required capability to access the page
*
* @since 3.0
* @author Remy Perona
*
* @var string
*/
private $capability;
/**
* Settings instance
*
* @since 3.0
* @author Remy Perona
*
* @var Settings
*/
private $settings;
/**
* Render implementation
*
* @since 3.0
* @author Remy Perona
*
* @var Render_Interface
*/
private $render;
/**
* Beacon instance
*
* @since 3.2
* @author Remy Perona
*
* @var Beacon
*/
private $beacon;
/**
* Database optimization instance
*
* @since 3.3
* @author Remy Perona
*
* @var Optimization
*/
private $optimize;
/**
* Constructor
*
* @since 3.0
* @author Remy Perona
*
* @param array $args Array of required arguments to add the admin page.
* @param Settings $settings Instance of Settings class.
* @param Render_Interface $render Implementation of Render interface.
* @param Beacon $beacon Beacon instance.
* @param Optimization $optimize Database optimization instance.
*/
public function __construct( $args, Settings $settings, Render_Interface $render, Beacon $beacon, Optimization $optimize ) {
$this->slug = $args['slug'];
$this->title = $args['title'];
$this->capability = $args['capability'];
$this->settings = $settings;
$this->render = $render;
$this->beacon = $beacon;
$this->optimize = $optimize;
}
/**
* Returns the settings page title
*
* @since 3.3
* @author Remy Perona
*
* @return string
*/
public function get_title() {
return $this->title;
}
/**
* Returns the settings page slug
*
* @since 3.3
* @author Remy Perona
*
* @return string
*/
public function get_slug() {
return $this->slug;
}
/**
* Returns the settings page capability
*
* @since 3.3
* @author Remy Perona
*
* @return string
*/
public function get_capability() {
return $this->capability;
}
/**
* Registers the settings, page sections, fields sections and fields.
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
public function configure() {
register_setting( $this->slug, WP_ROCKET_SLUG, [ $this->settings, 'sanitize_callback' ] );
}
/**
* Renders the settings page
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
public function render_page() {
if ( rocket_valid_key() ) {
$this->dashboard_section();
$this->cache_section();
$this->assets_section();
$this->media_section();
$this->preload_section();
$this->advanced_cache_section();
$this->database_section();
$this->cdn_section();
$this->heartbeat_section();
$this->addons_section();
$this->cloudflare_section();
$this->sucuri_section();
} else {
$this->license_section();
}
$this->render->set_settings( $this->settings->get_settings() );
$this->hidden_fields();
$this->render->set_hidden_settings( $this->settings->get_hidden_settings() );
echo $this->render->generate( 'page', [ 'slug' => $this->slug ] );
}
/**
* Gets customer data from WP Rocket website to display it in the dashboard
*
* @since 3.0
* @author Remy Perona
*
* @return object
*/
private function get_customer_data() {
$customer_key = defined( 'WP_ROCKET_KEY' ) ? WP_ROCKET_KEY : get_rocket_option( 'consumer_key', '' );
$customer_email = defined( 'WP_ROCKET_EMAIL' ) ? WP_ROCKET_EMAIL : get_rocket_option( 'consumer_email', '' );
$response = wp_safe_remote_post(
WP_ROCKET_WEB_MAIN . 'stat/1.0/wp-rocket/user.php',
[
'body' => 'user_id=' . rawurlencode( $customer_email ) . '&consumer_key=' . $customer_key,
]
);
if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
return (object) [
'licence_account' => __( 'Unavailable', 'rocket' ),
'licence_expiration' => __( 'Unavailable', 'rocket' ),
'class' => 'wpr-isInvalid',
];
}
$customer_data = json_decode( wp_remote_retrieve_body( $response ) );
if ( 1 <= $customer_data->licence_account && $customer_data->licence_account < 3 ) {
$customer_data->licence_account = 'Single';
} elseif ( '-1' === $customer_data->licence_account ) {
$customer_data->licence_account = 'Infinite';
} else {
$customer_data->licence_account = 'Plus';
}
$customer_data->class = time() < $customer_data->licence_expiration ? 'wpr-isValid' : 'wpr-isInvalid';
$customer_data->licence_expiration = date_i18n( get_option( 'date_format' ), $customer_data->licence_expiration );
return $customer_data;
}
/**
* Returns customer data from transient or request and save it if not cached
*
* @since 3.0
* @author Remy Perona
*
* @return object
*/
public function customer_data() {
if ( false !== get_transient( 'wp_rocket_customer_data' ) ) {
return get_transient( 'wp_rocket_customer_data' );
}
$customer_data = $this->get_customer_data();
set_transient( 'wp_rocket_customer_data', $customer_data, DAY_IN_SECONDS );
return $customer_data;
}
/**
* Toggle sliding checkboxes option value
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
public function toggle_option() {
check_ajax_referer( 'rocket-ajax' );
if ( ! current_user_can( 'rocket_manage_options' ) ) {
wp_die();
}
$whitelist = [
'do_beta' => 1,
'analytics_enabled' => 1,
'debug_enabled' => 1,
'varnish_auto_purge' => 1,
'do_cloudflare' => 1,
'cloudflare_devmode' => 1,
'cloudflare_protocol_rewrite' => 1,
'cloudflare_auto_settings' => 1,
'google_analytics_cache' => 1,
'facebook_pixel_cache' => 1,
'sucury_waf_cache_sync' => 1,
'sucury_waf_api_key' => 1,
];
if ( ! isset( $_POST['option']['name'] ) || ! isset( $whitelist[ $_POST['option']['name'] ] ) ) {
wp_die();
}
$value = (int) ! empty( $_POST['option']['value'] );
update_rocket_option( sanitize_key( $_POST['option']['name'] ), $value );
wp_die();
}
/**
* Forces the value for the mobile options if a mobile plugin is active.
*
* @since 3.0
* @since 3.2 Not used anymore.
* @see \WP_Rocket\Subscriber\Third_Party\Plugins\Mobile_Subscriber::is_mobile_plugin_active_callback()
* @author Remy Perona
*
* @param mixed $value Option value.
*
* @return mixed
*/
public function is_mobile_plugin_active( $value ) {
if ( rocket_is_mobile_plugin_active() ) {
return 1;
}
return $value;
}
/**
* Registers License section
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function license_section() {
$this->settings->add_page_section(
'license',
[
'title' => __( 'License', 'rocket' ),
]
);
$this->settings->add_settings_sections(
[
'license_section' => [
'type' => 'nocontainer',
'page' => 'license',
],
]
);
$this->settings->add_settings_fields(
[
'consumer_key' => [
'type' => 'text',
'label' => __( 'API key', 'rocket' ),
'default' => '',
'container_class' => [
'wpr-field--split',
'wpr-isDisabled',
],
'section' => 'license_section',
'page' => 'license',
'sanitize_callback' => 'sanitize_text_field',
'input_attr' => [
'disabled' => 1,
],
],
'consumer_email' => [
'type' => 'text',
'label' => __( 'Email address', 'rocket' ),
'default' => '',
'container_class' => [
'wpr-field--split',
'wpr-isDisabled',
],
'section' => 'license_section',
'page' => 'license',
'sanitize_callback' => 'sanitize_email',
'input_attr' => [
'disabled' => 1,
],
],
]
);
}
/**
* Registers Dashboard section
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function dashboard_section() {
$this->settings->add_page_section(
'dashboard',
[
'title' => __( 'Dashboard', 'rocket' ),
'menu_description' => __( 'Get help, account info', 'rocket' ),
'faq' => $this->beacon->get_suggest( 'faq' ),
'customer_data' => $this->customer_data(),
]
);
$this->settings->add_settings_sections(
[
'status' => [
'title' => __( 'My Status', 'rocket' ),
'page' => 'dashboard',
],
]
);
$this->settings->add_settings_fields(
[
'do_beta' => [
'type' => 'sliding_checkbox',
'label' => __( 'Rocket Tester', 'rocket' ),
'description' => __( 'I am part of the WP Rocket Beta Testing Program.', 'rocket' ),
'section' => 'status',
'page' => 'dashboard',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'analytics_enabled' => [
'type' => 'sliding_checkbox',
'label' => __( 'Rocket Analytics', 'rocket' ),
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'I agree to share anonymous data with the development team to help improve WP Rocket. %1$sWhat info will we collect?%2$s', 'rocket' ), '<button class="wpr-js-popin">', '</button>' ),
'section' => 'status',
'page' => 'dashboard',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
]
);
}
/**
* Registers Cache section
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function cache_section() {
$mobile_cache_beacon = $this->beacon->get_suggest( 'mobile_cache' );
$user_cache_beacon = $this->beacon->get_suggest( 'user_cache' );
$nonce_beacon = $this->beacon->get_suggest( 'nonce' );
$cache_life_beacon = $this->beacon->get_suggest( 'cache_lifespan' );
$this->settings->add_page_section(
'cache',
[
'title' => __( 'Cache', 'rocket' ),
'menu_description' => __( 'Basic cache options', 'rocket' ),
]
);
$this->settings->add_settings_sections(
[
'mobile_cache_section' => [
'title' => __( 'Mobile Cache', 'rocket' ),
'type' => 'fields_container',
'description' => __( 'Speed up your site for mobile visitors.', 'rocket' ),
'help' => [
'url' => $mobile_cache_beacon['url'],
'id' => $this->beacon->get_suggest( 'mobile_cache_section' ),
],
'helper' => rocket_is_mobile_plugin_active() ? __( 'We detected you use a plugin that requires a separate cache for mobile, and automatically enabled this option for compatibility.', 'rocket' ) : '',
'page' => 'cache',
],
'user_cache_section' => [
'title' => __( 'User Cache', 'rocket' ),
'type' => 'fields_container',
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( '%1$sUser cache%2$s is great when you have user-specific or restricted content on your website.', 'rocket' ), '<a href="' . esc_url( $user_cache_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $user_cache_beacon['id'] ) . '" target="_blank">', '</a>' ),
'help' => [
'url' => $user_cache_beacon['url'],
'id' => $this->beacon->get_suggest( 'user_cache_section' ),
],
'page' => 'cache',
],
'cache_lifespan' => [
'title' => __( 'Cache Lifespan', 'rocket' ),
'type' => 'fields_container',
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'Cache files older than the specified lifespan will be deleted.<br>Enable %1$spreloading%2$s for the cache to be rebuilt automatically after lifespan expiration.', 'rocket' ), '<a href="#preload">', '</a>' ),
'help' => [
'url' => $cache_life_beacon['url'],
'id' => $this->beacon->get_suggest( 'cache_lifespan_section' ),
],
'page' => 'cache',
],
]
);
$this->settings->add_settings_fields(
[
'cache_logged_user' => [
'type' => 'checkbox',
'label' => __( 'Enable caching for logged-in WordPress users', 'rocket' ),
'section' => 'user_cache_section',
'page' => 'cache',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'cache_mobile' => [
'type' => 'checkbox',
'label' => __( 'Enable caching for mobile devices', 'rocket' ),
'container_class' => [
rocket_is_mobile_plugin_active() ? 'wpr-isDisabled' : '',
'wpr-isParent',
],
'section' => 'mobile_cache_section',
'page' => 'cache',
'default' => 1,
'sanitize_callback' => 'sanitize_checkbox',
'input_attr' => [
'disabled' => rocket_is_mobile_plugin_active() ? 1 : 0,
],
],
'do_caching_mobile_files' => [
'type' => 'checkbox',
'label' => __( 'Separate cache files for mobile devices', 'rocket' ),
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( '%1$sMobile cache%2$s works safest with both options enabled. When in doubt, keep both.', 'rocket' ), '<a href="' . esc_url( $mobile_cache_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $mobile_cache_beacon['id'] ) . '" target="_blank">', '</a>' ),
'container_class' => [
rocket_is_mobile_plugin_active() ? 'wpr-isDisabled' : '',
'wpr-field--children',
],
'parent' => 'cache_mobile',
'section' => 'mobile_cache_section',
'page' => 'cache',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
'input_attr' => [
'disabled' => rocket_is_mobile_plugin_active() ? 1 : 0,
],
],
'purge_cron_interval' => [
'type' => 'cache_lifespan',
'label' => __( 'Specify time after which the global cache is cleared<br>(0 = unlimited )', 'rocket' ),
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'Reduce lifespan to 10 hours or less if you notice issues that seem to appear periodically. %1$sWhy?%2$s', 'rocket' ), '<a href="' . esc_url( $nonce_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $nonce_beacon['id'] ) . '" target="_blank">', '</a>' ),
'section' => 'cache_lifespan',
'page' => 'cache',
'default' => 10,
'sanitize_callback' => 'sanitize_cache_lifespan',
'choices' => [
'MINUTE_IN_SECONDS' => __( 'Minutes', 'rocket' ),
'HOUR_IN_SECONDS' => __( 'Hours', 'rocket' ),
'DAY_IN_SECONDS' => __( 'Days', 'rocket' ),
],
],
]
);
}
/**
* Registers CSS & Javascript section
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function assets_section() {
$remove_qs_beacon = $this->beacon->get_suggest( 'remove_query_strings' );
$combine_beacon = $this->beacon->get_suggest( 'combine' );
$defer_js_beacon = $this->beacon->get_suggest( 'defer_js' );
$async_beacon = $this->beacon->get_suggest( 'async' );
$files_beacon = $this->beacon->get_suggest( 'file_optimization' );
$inline_js_beacon = $this->beacon->get_suggest( 'exclude_inline_js' );
$exclude_js_beacon = $this->beacon->get_suggest( 'exclude_js' );
$this->settings->add_page_section(
'file_optimization',
[
'title' => __( 'File Optimization', 'rocket' ),
'menu_description' => __( 'Optimize CSS & JS', 'rocket' ),
]
);
$this->settings->add_settings_sections(
[
'basic' => [
'title' => __( 'Basic Settings', 'rocket' ),
'help' => [
'url' => $remove_qs_beacon['url'],
'id' => $this->beacon->get_suggest( 'basic_section' ),
],
'page' => 'file_optimization',
// translators: %1$s = type of minification (HTML, CSS or JS), %2$s = “WP Rocket”.
'helper' => rocket_maybe_disable_minify_html() ? sprintf( __( '%1$s Minification is currently activated in <strong>Autoptimize</strong>. If you want to use %2$s’s minification, disable those options in Autoptimize.', 'rocket' ), 'HTML', WP_ROCKET_PLUGIN_NAME ) : '',
],
'css' => [
'title' => __( 'CSS Files', 'rocket' ),
'help' => [
'id' => $this->beacon->get_suggest( 'css_section' ),
'url' => $files_beacon['url'],
],
'page' => 'file_optimization',
// translators: %1$s = type of minification (HTML, CSS or JS), %2$s = “WP Rocket”.
'helper' => rocket_maybe_disable_minify_css() ? sprintf( __( '%1$s Minification is currently activated in <strong>Autoptimize</strong>. If you want to use %2$s’s minification, disable those options in Autoptimize.', 'rocket' ), 'CSS', WP_ROCKET_PLUGIN_NAME ) : '',
],
'js' => [
'title' => __( 'JavaScript Files', 'rocket' ),
'help' => [
'id' => $this->beacon->get_suggest( 'js_section' ),
'url' => $files_beacon['url'],
],
'page' => 'file_optimization',
// translators: %1$s = type of minification (HTML, CSS or JS), %2$s = “WP Rocket”.
'helper' => rocket_maybe_disable_minify_js() ? sprintf( __( '%1$s Minification is currently activated in <strong>Autoptimize</strong>. If you want to use %2$s’s minification, disable those options in Autoptimize.', 'rocket' ), 'JS', WP_ROCKET_PLUGIN_NAME ) : '',
],
]
);
$this->settings->add_settings_fields(
[
'minify_html' => [
'type' => 'checkbox',
'label' => __( 'Minify HTML', 'rocket' ),
'container_class' => [
rocket_maybe_disable_minify_html() ? 'wpr-isDisabled' : '',
],
'description' => __( 'Minifying HTML removes whitespace and comments to reduce the size.', 'rocket' ),
'section' => 'basic',
'page' => 'file_optimization',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
'input_attr' => [
'disabled' => rocket_maybe_disable_minify_html() ? 1 : 0,
],
],
'minify_google_fonts' => [
'type' => 'checkbox',
'label' => __( 'Combine Google Fonts files', 'rocket' ),
'description' => __( 'Combining Google Fonts will reduce the number of HTTP requests.', 'rocket' ),
'section' => 'basic',
'page' => 'file_optimization',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'remove_query_strings' => [
'type' => 'checkbox',
'label' => __( 'Remove query strings from static resources', 'rocket' ),
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'Removes the version query string from static files (e.g. style.css?ver=1.0) and encodes it into the filename instead (e.g. style-1.0.css). Can improve your GTMetrix score. %1$sMore info%2$s', 'rocket' ), '<a href="' . esc_url( $remove_qs_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $remove_qs_beacon['id'] ) . '" target="_blank">', '</a>' ),
'section' => 'basic',
'page' => 'file_optimization',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'minify_css' => [
'type' => 'checkbox',
'label' => __( 'Minify CSS files', 'rocket' ),
'description' => __( 'Minify CSS removes whitespace and comments to reduce the file size.', 'rocket' ),
'container_class' => [
rocket_maybe_disable_minify_css() ? 'wpr-isDisabled' : '',
'wpr-field--parent',
],
'section' => 'css',
'page' => 'file_optimization',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
'input_attr' => [
'disabled' => rocket_maybe_disable_minify_css() ? 1 : 0,
],
'warning' => [
'title' => __( 'This could break things!', 'rocket' ),
'description' => __( 'If you notice any errors on your website after having activated this setting, just deactivate it again, and your site will be back to normal.', 'rocket' ),
'button_label' => __( 'Activate minify CSS', 'rocket' ),
],
],
'minify_concatenate_css' => [
'type' => 'checkbox',
'label' => __( 'Combine CSS files <em>(Enable Minify CSS files to select)</em>', 'rocket' ),
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'Combine CSS merges all your files into 1, reducing HTTP requests. Not recommended if your site uses HTTP/2. %1$sMore info%2$s', 'rocket' ), '<a href="' . esc_url( $combine_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $combine_beacon['id'] ) . '" target="_blank">', '</a>' ),
'container_class' => [
get_rocket_option( 'minify_css' ) ? '' : 'wpr-isDisabled',
'wpr-field--parent',
],
'section' => 'css',
'page' => 'file_optimization',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
'input_attr' => [
'disabled' => get_rocket_option( 'minify_css' ) ? 0 : 1,
],
'warning' => [
'title' => __( 'This could break things!', 'rocket' ),
'description' => __( 'If you notice any errors on your website after having activated this setting, just deactivate it again, and your site will be back to normal.', 'rocket' ),
'button_label' => __( 'Activate combine CSS', 'rocket' ),
],
],
'exclude_css' => [
'type' => 'textarea',
'label' => __( 'Excluded CSS Files', 'rocket' ),
'description' => __( 'Specify URLs of CSS files to be excluded from minification and concatenation (one per line).', 'rocket' ),
'helper' => __( 'The domain part of the URL will be stripped automatically.<br>Use (.*).css wildcards to exclude all CSS files located at a specific path.', 'rocket' ),
'container_class' => [
'wpr-field--children',
],
'placeholder' => '/wp-content/plugins/some-plugin/(.*).css',
'parent' => 'minify_css',
'section' => 'css',
'page' => 'file_optimization',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
],
'async_css' => [
'type' => 'checkbox',
'label' => __( 'Optimize CSS delivery', 'rocket' ),
'container_class' => [
is_plugin_active( 'wp-criticalcss/wp-criticalcss.php' ) ? 'wpr-isDisabled' : '',
'wpr-isParent',
],
'description' => is_plugin_active( 'wp-criticalcss/wp-criticalcss.php' ) ?
// translators: %1$s = plugin name.
sprintf( _x( 'Optimize CSS Delivery is currently handled by the %1$s plugin. If you want to use WP Rocket’s Optimize CSS Delivery option, disable the %1$s plugin.', 'WP Critical CSS compatibility', 'rocket' ), 'WP Critical CSS' ) :
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
sprintf( __( 'Optimize CSS delivery eliminates render-blocking CSS on your website for faster perceived load time. %1$sMore info%2$s', 'rocket' ), '<a href="' . esc_url( $async_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $async_beacon['id'] ) . '" target="_blank">', '</a>' ),
'section' => 'css',
'page' => 'file_optimization',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
'input_attr' => [
'disabled' => is_plugin_active( 'wp-criticalcss/wp-criticalcss.php' ) ? 1 : 0,
],
],
'critical_css' => [
'type' => 'textarea',
'label' => __( 'Fallback critical CSS', 'rocket' ),
'container_class' => [
'wpr-field--children',
],
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'helper' => sprintf( __( 'Provides a fallback if auto-generated critical path CSS is incomplete. %1$sMore info%2$s', 'rocket' ), '<a href="' . esc_url( $async_beacon['url'] ) . '#fallback" data-beacon-article="' . esc_attr( $async_beacon['id'] ) . '" target="_blank">', '</a>' ),
'parent' => 'async_css',
'section' => 'css',
'page' => 'file_optimization',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
],
'minify_js' => [
'type' => 'checkbox',
'label' => __( 'Minify JavaScript files', 'rocket' ),
'description' => __( 'Minify JavaScript removes whitespace and comments to reduce the file size.', 'rocket' ),
'container_class' => [
rocket_maybe_disable_minify_js() ? 'wpr-isDisabled' : '',
'wpr-field--parent',
],
'section' => 'js',
'page' => 'file_optimization',
'default' => 0,
'input_attr' => [
'disabled' => rocket_maybe_disable_minify_js() ? 1 : 0,
],
'sanitize_callback' => 'sanitize_checkbox',
'warning' => [
'title' => __( 'This could break things!', 'rocket' ),
'description' => __( 'If you notice any errors on your website after having activated this setting, just deactivate it again, and your site will be back to normal.', 'rocket' ),
'button_label' => __( 'Activate minify JavaScript', 'rocket' ),
],
],
'minify_concatenate_js' => [
'type' => 'checkbox',
'label' => __( 'Combine JavaScript files <em>(Enable Minify JavaScript files to select)</em>', 'rocket' ),
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'Combine JavaScript files combines your site’s internal, 3rd party and inline JS reducing HTTP requests. Not recommended if your site uses HTTP/2. %1$sMore info%2$s', 'rocket' ), '<a href="' . esc_url( $combine_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $combine_beacon['id'] ) . '" target="_blank">', '</a>' ),
'container_class' => [
get_rocket_option( 'minify_js' ) ? '' : 'wpr-isDisabled',
'wpr-field--parent',
],
'section' => 'js',
'page' => 'file_optimization',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
'input_attr' => [
'disabled' => get_rocket_option( 'minify_js' ) ? 0 : 1,
],
'warning' => [
'title' => __( 'This could break things!', 'rocket' ),
'description' => __( 'If you notice any errors on your website after having activated this setting, just deactivate it again, and your site will be back to normal.', 'rocket' ),
'button_label' => __( 'Activate combine JavaScript', 'rocket' ),
],
],
'exclude_inline_js' => [
'type' => 'textarea',
'label' => __( 'Excluded Inline JavaScript', 'rocket' ),
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'Specify patterns of inline JavaScript to be excluded from concatenation (one per line). %1$sMore info%2$s', 'rocket' ), '<a href="' . esc_url( $inline_js_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $inline_js_beacon['id'] ) . '" rel="noopener noreferrer" target="_blank">', '</a>' ),
'container_class' => [
'wpr-field--children',
],
'placeholder' => 'recaptcha',
'parent' => 'minify_concatenate_js',
'section' => 'js',
'page' => 'file_optimization',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
'input_attr' => [
'disabled' => get_rocket_option( 'minify_concatenate_js' ) ? 0 : 1,
],
],
'exclude_js' => [
'type' => 'textarea',
'label' => __( 'Excluded JavaScript Files', 'rocket' ),
'description' => __( 'Specify URLs of JavaScript files to be excluded from minification and concatenation (one per line).', 'rocket' ),
'helper' => __( '<strong>Internal:</strong> The domain part of the URL will be stripped automatically. Use (.*).js wildcards to exclude all JS files located at a specific path.', 'rocket' ) . '<br>' .
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
sprintf( __( '<strong>3rd Party:</strong> Use either the full URL path or only the domain name, to exclude external JS. %1$sMore info%2$s', 'rocket' ), '<a href="' . esc_url( $exclude_js_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $exclude_js_beacon['id'] ) . '" rel="noopener noreferrer" target="_blank">', '</a>' ),
'container_class' => [
'wpr-field--children',
],
'placeholder' => '/wp-content/themes/some-theme/(.*).js',
'parent' => 'minify_js',
'section' => 'js',
'page' => 'file_optimization',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
],
'defer_all_js' => [
'container_class' => [
'wpr-isParent',
],
'type' => 'checkbox',
'label' => __( 'Load JavaScript deferred', 'rocket' ),
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'Load JavaScript deferred eliminates render-blocking JS on your site and can improve load time. %1$sMore info%2$s', 'rocket' ), '<a href="' . esc_url( $defer_js_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $defer_js_beacon['id'] ) . '" target="_blank">', '</a>' ),
'section' => 'js',
'page' => 'file_optimization',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'defer_all_js_safe' => [
'container_class' => [
'wpr-field--children',
],
'type' => 'checkbox',
'label' => __( 'Safe Mode for jQuery (recommended)', 'rocket' ),
'description' => __( 'Safe mode for jQuery for deferred JS ensures support for inline jQuery references from themes and plugins by loading jQuery at the top of the document as a render-blocking script.<br><em>Deactivating may result in broken functionality, test thoroughly!</em>', 'rocket' ),
'parent' => 'defer_all_js',
'section' => 'js',
'page' => 'file_optimization',
'default' => 1,
'sanitize_callback' => 'sanitize_checkbox',
],
]
);
}
/**
* Registers Media section
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function media_section() {
$lazyload_beacon = $this->beacon->get_suggest( 'lazyload' );
$webp_beacon = $this->beacon->get_suggest( 'webp' );
if ( rocket_valid_key() && ! \Imagify_Partner::has_imagify_api_key() ) {
$imagify_link = '<a href="#imagify">';
} else {
$imagify_link = '<a href="https://wordpress.org/plugins/imagify/" target="_blank" rel="noopener noreferrer">';
}
$this->settings->add_page_section(
'media',
[
'title' => __( 'Media', 'rocket' ),
'menu_description' => __( 'LazyLoad, emojis, embeds, WebP', 'rocket' ),
]
);
$rocket_maybe_disable_lazyload_plugins = [];
if ( rocket_maybe_disable_lazyload() ) {
$rocket_maybe_disable_lazyload_plugins[] = __( 'Autoptimize', 'rocket' );
}
/**
* Lazyload Helper filter which disables WPR lazyload functionality
*
* @since 3.4.2
* @author Soponar Cristina
*
* @param array Will return the array with all plugin names which should disable LazyLoad
*/
$rocket_maybe_disable_lazyload_plugins = apply_filters( 'rocket_maybe_disable_lazyload_helper', $rocket_maybe_disable_lazyload_plugins );
$rocket_maybe_disable_lazyload_plugins = wp_sprintf_l( '%l', $rocket_maybe_disable_lazyload_plugins );
$this->settings->add_settings_sections(
[
'lazyload_section' => [
'title' => __( 'LazyLoad', 'rocket' ),
'type' => 'fields_container',
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'It can improve actual and perceived loading time as images, iframes, and videos will be loaded only as they enter (or about to enter) the viewport and reduces the number of HTTP requests. %1$sMore Info%2$s', 'rocket' ), '<a href="' . esc_url( $lazyload_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $lazyload_beacon['id'] ) . '" target="_blank" rel="noopener noreferrer">', '</a>' ),
'help' => [
'id' => $this->beacon->get_suggest( 'lazyload_section' ),
'url' => $lazyload_beacon['url'],
],
'page' => 'media',
// translators: %1$s = “WP Rocket”.
'helper' => ! empty( $rocket_maybe_disable_lazyload_plugins ) ? sprintf( __( 'Lazyload is currently activated in <strong>%2$s</strong>. If you want to use %1$s’s lazyload, disable this option in %2$s.', 'rocket' ), WP_ROCKET_PLUGIN_NAME, $rocket_maybe_disable_lazyload_plugins ) : '',
],
'emoji_section' => [
'title' => __( 'Emoji 👻', 'rocket' ),
'type' => 'fields_container',
'description' => __( 'Use default emoji of visitor\'s browser instead of loading emoji from WordPress.org', 'rocket' ),
'page' => 'media',
],
'embeds_section' => [
'title' => __( 'Embeds', 'rocket' ),
'type' => 'fields_container',
'description' => __( 'Prevents others from embedding content from your site, prevents you from embedding content from other (non-whitelisted) sites, and removes JavaScript requests related to WordPress embeds', 'rocket' ),
'page' => 'media',
],
'webp_section' => [
'title' => __( 'WebP compatibility', 'rocket' ),
'type' => 'fields_container',
'description' => sprintf(
// translators: %1$s and %3$s = opening <a> tag, %2$s = closing </a> tag.
__( 'Enable this option if you would like WP Rocket to serve WebP images to compatible browsers. Please note that WP Rocket cannot create WebP images for you. To create WebP images we recommend %1$sImagify%2$s. %3$sMore info%2$s', 'rocket' ),
$imagify_link,
'</a>',
'<a href="' . esc_url( $webp_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $webp_beacon['id'] ) . '" target="_blank" rel="noopener noreferrer">'
),
'help' => [
'id' => $webp_beacon['id'],
'url' => $webp_beacon['url'],
],
'page' => 'media',
],
]
);
/**
* Add more content to the 'cache_webp' setting field.
*
* @since 3.4
* @author Grégory Viguier
*
* @param array $cache_webp_field Data to be added to the setting field.
*/
$cache_webp_field = (array) apply_filters( 'rocket_cache_webp_setting_field', [] );
$this->settings->add_settings_fields(
[
'lazyload' => [
'type' => 'checkbox',
'label' => __( 'Enable for images', 'rocket' ),
'section' => 'lazyload_section',
'page' => 'media',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
'container_class' => [
( rocket_avada_maybe_disable_lazyload() || ! empty( $rocket_maybe_disable_lazyload_plugins ) ) ? 'wpr-isDisabled' : '',
],
'input_attr' => [
'disabled' => ( rocket_avada_maybe_disable_lazyload() || ! empty( $rocket_maybe_disable_lazyload_plugins ) ) ? 1 : 0,
],
'description' => rocket_avada_maybe_disable_lazyload() ? _x( 'Lazyload for images is currently activated in Avada. If you want to use WP Rocket’s LazyLoad, disable this option in Avada.', 'Avada', 'rocket' ) : '',
],
'lazyload_iframes' => [
'container_class' => [
rocket_maybe_disable_lazyload() ? 'wpr-isDisabled' : '',
'wpr-isParent',
],
'type' => 'checkbox',
'label' => __( 'Enable for iframes and videos', 'rocket' ),
'section' => 'lazyload_section',
'page' => 'media',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
'input_attr' => [
'disabled' => rocket_maybe_disable_lazyload() ? 1 : 0,
],
],
'lazyload_youtube' => [
'container_class' => [
rocket_maybe_disable_lazyload() ? 'wpr-isDisabled' : '',
'wpr-field--children',
],
'type' => 'checkbox',
'label' => __( 'Replace YouTube iframe with preview image', 'rocket' ),
'description' => __( 'This can significantly improve your loading time if you have a lot of YouTube videos on a page.', 'rocket' ),
'parent' => 'lazyload_iframes',
'section' => 'lazyload_section',
'page' => 'media',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
'input_attr' => [
'disabled' => rocket_maybe_disable_lazyload() ? 1 : 0,
],
],
'emoji' => [
'type' => 'checkbox',
'label' => __( 'Disable Emoji', 'rocket' ),
'description' => __( 'Disable Emoji will reduce the number of external HTTP requests.', 'rocket' ),
'section' => 'emoji_section',
'page' => 'media',
'default' => 1,
'sanitize_callback' => 'sanitize_checkbox',
],
'embeds' => [
'type' => 'checkbox',
'label' => __( 'Disable WordPress embeds', 'rocket' ),
'section' => 'embeds_section',
'page' => 'media',
'default' => 1,
'sanitize_callback' => 'sanitize_checkbox',
],
'cache_webp' => array_merge(
$cache_webp_field,
[
'type' => 'checkbox',
'label' => __( 'Enable WebP caching', 'rocket' ),
'section' => 'webp_section',
'page' => 'media',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
]
),
]
);
}
/**
* Registers Preload section
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function preload_section() {
$this->settings->add_page_section(
'preload',
[
'title' => __( 'Preload', 'rocket' ),
'menu_description' => __( 'Generate cache files', 'rocket' ),
]
);
$bot_beacon = $this->beacon->get_suggest( 'bot' );
$this->settings->add_settings_sections(
[
'preload_section' => [
'title' => __( 'Preload', 'rocket' ),
'type' => 'fields_container',
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'When you enable preloading WP Rocket will generate the cache starting with the links on your homepage followed by the sitemaps you specify. Preloading is automatically triggered when you add or update content and can also be manually triggered from the admin bar or from the %1$sWP Rocket Dashboard%2$s.', 'rocket' ), '<a href="#dashboard">', '</a>' ),
'help' => [
'id' => $this->beacon->get_suggest( 'sitemap_preload' ),
'url' => $bot_beacon['url'],
],
'page' => 'preload',
],
'dns_prefetch_section' => [
'title' => __( 'Prefetch DNS Requests', 'rocket' ),
'type' => 'fields_container',
'description' => __( 'DNS prefetching can make external files load faster, especially on mobile networks', 'rocket' ),
'help' => [
'id' => $this->beacon->get_suggest( 'dns_prefetch' ),
'url' => $bot_beacon['url'],
],
'page' => 'preload',
],
]
);
$this->settings->add_settings_fields(
[
'manual_preload' => [
'type' => 'checkbox',
'label' => __( 'Activate Preloading', 'rocket' ),
'section' => 'preload_section',
'page' => 'preload',
'default' => 1,
'container_class' => [
'wpr-isParent',
],
'sanitize_callback' => 'sanitize_checkbox',
],
]
);
// Add this separately to be able to filter it easily.
$this->settings->add_settings_fields(
apply_filters(
'rocket_sitemap_preload_options',
[
'sitemap_preload' => [
'type' => 'checkbox',
'label' => __( 'Activate sitemap-based cache preloading', 'rocket' ),
'container_class' => [
'wpr-isParent',
'wpr-field--children',
],
'parent' => 'manual_preload',
'section' => 'preload_section',
'page' => 'preload',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
]
)
);
$this->settings->add_settings_fields(
[
'sitemaps' => [
'type' => 'textarea',
'label' => __( 'Sitemaps for preloading', 'rocket' ),
'container_class' => [
'wpr-field--children',
],
'description' => __( 'Specify XML sitemap(s) to be used for preloading', 'rocket' ),
'placeholder' => 'http://example.com/sitemap.xml',
'parent' => 'sitemap_preload',
'section' => 'preload_section',
'page' => 'preload',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
],
'dns_prefetch' => [
'type' => 'textarea',
'label' => __( 'URLs to prefetch', 'rocket' ),
'description' => __( 'Specify external hosts to be prefetched (no <code>http:</code>, one per line)', 'rocket' ),
'placeholder' => '//example.com',
'section' => 'dns_prefetch_section',
'page' => 'preload',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
],
]
);
}
/**
* Registers Advanced Cache section
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function advanced_cache_section() {
$this->settings->add_page_section(
'advanced_cache',
[
'title' => __( 'Advanced Rules', 'rocket' ),
'menu_description' => __( 'Fine-tune cache rules', 'rocket' ),
]
);
$ecommerce_beacon = $this->beacon->get_suggest( 'ecommerce' );
$cache_query_strings_beacon = $this->beacon->get_suggest( 'cache_query_strings' );
$never_cache_beacon = $this->beacon->get_suggest( 'exclude_cache' );
$always_purge_beacon = $this->beacon->get_suggest( 'always_purge' );
$ecommerce_plugin = '';
$reject_uri_desc = __( 'Sensitive pages like custom login/logout URLs should be excluded from cache.', 'rocket' );
if ( function_exists( 'WC' ) && function_exists( 'wc_get_page_id' ) ) {
$ecommerce_plugin = _x( 'WooCommerce', 'plugin name', 'rocket' );
} elseif ( function_exists( 'EDD' ) ) {
$ecommerce_plugin = _x( 'Easy Digital Downloads', 'plugin name', 'rocket' );
} elseif ( function_exists( 'it_exchange_get_page_type' ) && function_exists( 'it_exchange_get_page_url' ) ) {
$ecommerce_plugin = _x( 'iThemes Exchange', 'plugin name', 'rocket' );
} elseif ( defined( 'JIGOSHOP_VERSION' ) && function_exists( 'jigoshop_get_page_id' ) ) {
$ecommerce_plugin = _x( 'Jigoshop', 'plugin name', 'rocket' );
} elseif ( defined( 'WPSHOP_VERSION' ) && class_exists( 'wpshop_tools' ) && method_exists( 'wpshop_tools', 'get_page_id' ) ) {
$ecommerce_plugin = _x( 'WP-Shop', 'plugin name', 'rocket' );
}
if ( ! empty( $ecommerce_plugin ) ) {
$reject_uri_desc .= sprintf(
// translators: %1$s = opening <a> tag, %2$s = plugin name, %3$s closing </a> tag.
__( '<br>Cart, checkout and "my account" pages set in <strong>%1$s%2$s%3$s</strong> will be detected and never cached by default.', 'rocket' ),
'<a href="' . esc_url( $ecommerce_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $ecommerce_beacon['id'] ) . '" target="_blank">',
$ecommerce_plugin,
'</a>'
);
}
$this->settings->add_settings_sections(
[
'cache_reject_uri_section' => [
'title' => __( 'Never Cache URL(s)', 'rocket' ),
'type' => 'fields_container',
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => $reject_uri_desc,
'help' => [
'id' => $this->beacon->get_suggest( 'never_cache' ),
'url' => $never_cache_beacon['url'],
],
'page' => 'advanced_cache',
],
'cache_reject_cookies_section' => [
'title' => __( 'Never Cache Cookies', 'rocket' ),
'type' => 'fields_container',
'page' => 'advanced_cache',
],
'cache_reject_ua_section' => [
'title' => __( 'Never Cache User Agent(s)', 'rocket' ),
'type' => 'fields_container',
'page' => 'advanced_cache',
],
'cache_purge_pages_section' => [
'title' => __( 'Always Purge URL(s)', 'rocket' ),
'type' => 'fields_container',
'help' => [
'id' => $this->beacon->get_suggest( 'always_purge_section' ),
'url' => $always_purge_beacon['url'],
],
'page' => 'advanced_cache',
],
'cache_query_strings_section' => [
'title' => __( 'Cache Query String(s)', 'rocket' ),
'type' => 'fields_container',
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( '%1$sCache for query strings%2$s enables you to force caching for specific GET parameters.', 'rocket' ), '<a href="' . esc_url( $cache_query_strings_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $cache_query_strings_beacon['id'] ) . '" target="_blank">', '</a>' ),
'help' => [
'id' => $this->beacon->get_suggest( 'query_strings' ),
'url' => $cache_query_strings_beacon['url'],
],
'page' => 'advanced_cache',
],
]
);
$this->settings->add_settings_fields(
[
'cache_reject_uri' => [
'type' => 'textarea',
'description' => __( 'Specify URLs of pages or posts that should never be cached (one per line)', 'rocket' ),
'helper' => __( 'The domain part of the URL will be stripped automatically.<br>Use (.*) wildcards to address multiple URLs under a given path.', 'rocket' ),
'placeholder' => '/members/(.*)',
'section' => 'cache_reject_uri_section',
'page' => 'advanced_cache',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
],
'cache_reject_cookies' => [
'type' => 'textarea',
'description' => __( 'Specify the IDs of cookies that, when set in the visitor\'s browser, should prevent a page from getting cached (one per line)', 'rocket' ),
'section' => 'cache_reject_cookies_section',
'page' => 'advanced_cache',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
],
'cache_reject_ua' => [
'type' => 'textarea',
'description' => __( 'Specify user agent strings that should never see cached pages (one per line)', 'rocket' ),
'helper' => __( 'Use (.*) wildcards to detect parts of UA strings.', 'rocket' ),
'placeholder' => '(.*)Mobile(.*)Safari(.*)',
'section' => 'cache_reject_ua_section',
'page' => 'advanced_cache',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
],
'cache_purge_pages' => [
'type' => 'textarea',
'description' => __( 'Specify URLs you always want purged from cache whenever you update any post or page (one per line)', 'rocket' ),
'helper' => __( 'The domain part of the URL will be stripped automatically.<br>Use (.*) wildcards to address multiple URLs under a given path.', 'rocket' ),
'section' => 'cache_purge_pages_section',
'page' => 'advanced_cache',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
],
'cache_query_strings' => [
'type' => 'textarea',
'description' => __( 'Specify query strings for caching (one per line)', 'rocket' ),
'section' => 'cache_query_strings_section',
'page' => 'advanced_cache',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
],
]
);
}
/**
* Registers Database section
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function database_section() {
$total = [];
foreach ( array_keys( $this->optimize->get_options() ) as $key ) {
$total[ $key ] = $this->optimize->count_cleanup_items( $key );
}
$this->settings->add_page_section(
'database',
[
'title' => __( 'Database', 'rocket' ),
'menu_description' => __( 'Optimize, reduce bloat', 'rocket' ),
]
);
$database_beacon = $this->beacon->get_suggest( 'slow_admin' );
$this->settings->add_settings_sections(
[
'post_cleanup_section' => [
'title' => __( 'Post Cleanup', 'rocket' ),
'type' => 'fields_container',
'description' => __( 'Post revisions and drafts will be permanently deleted. Do not use this option if you need to retain revisions or drafts.', 'rocket' ),
'help' => [
'id' => $this->beacon->get_suggest( 'cleanup' ),
'url' => $database_beacon['url'],
],
'page' => 'database',
],
'comments_cleanup_section' => [
'title' => __( 'Comments Cleanup', 'rocket' ),
'type' => 'fields_container',
'description' => __( 'Spam and trashed comments will be permanently deleted.', 'rocket' ),
'page' => 'database',
],
'transients_cleanup_section' => [
'title' => __( 'Transients Cleanup', 'rocket' ),
'type' => 'fields_container',
'description' => __( 'Transients are temporary options; they are safe to remove. They will be automatically regenerated as your plugins require them.', 'rocket' ),
'page' => 'database',
],
'database_cleanup_section' => [
'title' => __( 'Database Cleanup', 'rocket' ),
'type' => 'fields_container',
'description' => __( 'Reduces overhead of database tables', 'rocket' ),
'page' => 'database',
],
'schedule_cleanup_section' => [
'title' => __( 'Automatic cleanup', 'rocket' ),
'type' => 'fields_container',
'page' => 'database',
],
]
);
$this->settings->add_settings_fields(
[
'database_revisions' => [
'type' => 'checkbox',
'label' => __( 'Revisions', 'rocket' ),
// translators: %s is the number of revisions found in the database. It's a formatted number, don't use %d.
'description' => sprintf( _n( '%s revision in your database.', '%s revisions in your database.', $total['database_revisions'], 'rocket' ), number_format_i18n( $total['database_revisions'] ) ),
'section' => 'post_cleanup_section',
'page' => 'database',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'database_auto_drafts' => [
'type' => 'checkbox',
'label' => __( 'Auto Drafts', 'rocket' ),
// translators: %s is the number of revisions found in the database. It's a formatted number, don't use %d.
'description' => sprintf( _n( '%s draft in your database.', '%s drafts in your database.', $total['database_auto_drafts'], 'rocket' ), number_format_i18n( $total['database_auto_drafts'] ) ),
'section' => 'post_cleanup_section',
'page' => 'database',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'database_trashed_posts' => [
'type' => 'checkbox',
'label' => __( 'Trashed Posts', 'rocket' ),
// translators: %s is the number of revisions found in the database. It's a formatted number, don't use %d.
'description' => sprintf( _n( '%s trashed post in your database.', '%s trashed posts in your database.', $total['database_trashed_posts'], 'rocket' ), $total['database_trashed_posts'] ),
'section' => 'post_cleanup_section',
'page' => 'database',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'database_spam_comments' => [
'type' => 'checkbox',
'label' => __( 'Spam Comments', 'rocket' ),
// translators: %s is the number of revisions found in the database. It's a formatted number, don't use %d.
'description' => sprintf( _n( '%s spam comment in your database.', '%s spam comments in your database.', $total['database_spam_comments'], 'rocket' ), number_format_i18n( $total['database_spam_comments'] ) ),
'section' => 'comments_cleanup_section',
'page' => 'database',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'database_trashed_comments' => [
'type' => 'checkbox',
'label' => __( 'Trashed Comments', 'rocket' ),
// translators: %s is the number of revisions found in the database. It's a formatted number, don't use %d.
'description' => sprintf( _n( '%s trashed comment in your database.', '%s trashed comments in your database.', $total['database_trashed_comments'], 'rocket' ), number_format_i18n( $total['database_trashed_comments'] ) ),
'section' => 'comments_cleanup_section',
'page' => 'database',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'database_expired_transients' => [
'type' => 'checkbox',
'label' => __( 'Expired transients', 'rocket' ),
// translators: %s is the number of revisions found in the database. It's a formatted number, don't use %d.
'description' => sprintf( _n( '%s expired transient in your database.', '%s expired transients in your database.', $total['database_expired_transients'], 'rocket' ), number_format_i18n( $total['database_expired_transients'] ) ),
'section' => 'transients_cleanup_section',
'page' => 'database',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'database_all_transients' => [
'type' => 'checkbox',
'label' => __( 'All transients', 'rocket' ),
// translators: %s is the number of revisions found in the database. It's a formatted number, don't use %d.
'description' => sprintf( _n( '%s transient in your database.', '%s transients in your database.', $total['database_all_transients'], 'rocket' ), number_format_i18n( $total['database_all_transients'] ) ),
'section' => 'transients_cleanup_section',
'page' => 'database',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'database_optimize_tables' => [
'type' => 'checkbox',
'label' => __( 'Optimize Tables', 'rocket' ),
// translators: %s is the number of revisions found in the database. It's a formatted number, don't use %d.
'description' => sprintf( _n( '%s table to optimize in your database.', '%s tables to optimize in your database.', $total['database_optimize_tables'], 'rocket' ), number_format_i18n( $total['database_optimize_tables'] ) ),
'section' => 'database_cleanup_section',
'page' => 'database',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'schedule_automatic_cleanup' => [
'container_class' => [
'wpr-isParent',
],
'type' => 'checkbox',
'label' => __( 'Schedule Automatic Cleanup', 'rocket' ),
'description' => '',
'section' => 'schedule_cleanup_section',
'page' => 'database',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
'automatic_cleanup_frequency' => [
'container_class' => [
'wpr-field--children',
],
'type' => 'select',
'label' => __( 'Frequency', 'rocket' ),
'description' => '',
'parent' => 'schedule_automatic_cleanup',
'section' => 'schedule_cleanup_section',
'page' => 'database',
'default' => 'daily',
'sanitize_callback' => 'sanitize_text_field',
'choices' => [
'daily' => __( 'Daily', 'rocket' ),
'weekly' => __( 'Weekly', 'rocket' ),
'monthly' => __( 'Monthly', 'rocket' ),
],
],
]
);
}
/**
* Registers CDN section
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function cdn_section() {
$this->settings->add_page_section(
'page_cdn',
[
'title' => __( 'CDN', 'rocket' ),
'menu_description' => __( 'Integrate your CDN', 'rocket' ),
]
);
$cdn_beacon = $this->beacon->get_suggest( 'cdn' );
$cdn_exclude_beacon = $this->beacon->get_suggest( 'exclude_cdn' );
$this->settings->add_settings_sections(
[
'cdn_section' => [
'title' => __( 'CDN', 'rocket' ),
'type' => 'fields_container',
'description' => __( 'All URLs of static files (CSS, JS, images) will be rewritten to the CNAME(s) you provide.', 'rocket' ) . '<br><em>' . sprintf(
// translators: %1$s = opening link tag, %2$s = closing link tag.
__( 'Not required for services like Cloudflare and Sucuri. Please see our available %1$sAdd-ons%2$s.', 'rocket' ),
'<a href="#addons">',
'</a>'
) . '</em>',
'help' => [
'id' => $this->beacon->get_suggest( 'cdn_section' ),
'url' => $cdn_beacon['url'],
],
'page' => 'page_cdn',
],
'cnames_section' => [
'type' => 'nocontainer',
'page' => 'page_cdn',
],
'exclude_cdn_section' => [
'title' => __( 'Exclude files from CDN', 'rocket' ),
'type' => 'fields_container',
'help' => [
'id' => $cdn_exclude_beacon['id'],
'url' => $cdn_exclude_beacon['url'],
],
'page' => 'page_cdn',
],
]
);
$maybe_display_cdn_helper = '';
$addons = [];
if ( get_rocket_option( 'do_cloudflare' ) ) {
$addons[] = 'Cloudflare';
}
if ( get_rocket_option( 'sucury_waf_cache_sync' ) ) {
$addons[] = 'Sucuri';
}
if ( ! empty( $addons ) ) {
$maybe_display_cdn_helper = sprintf(
// translators: %1$s = opening em tag, %2$s = add-on name(s), %3$s = closing em tag.
_n(
'%1$s%2$s Add-on%3$s is currently enabled. Configuration of the CDN settings is not required for %2$s to work on your site.',
'%1$s%2$s Add-ons%3$s are currently enabled. Configuration of the CDN settings is not required for %2$s to work on your site.',
count( $addons ),
'rocket'
),
'<em>',
implode( ' and ', $addons ),
'</em>'
) . '<br>';
}
/**
* Add more content to the 'cdn' setting field.
*
* @since 3.4
* @author Grégory Viguier
*
* @param array $cdn_field Data to be added to the setting field.
*/
$cdn_field = (array) apply_filters( 'rocket_cdn_setting_field', [] );
$this->settings->add_settings_fields(
[
'cdn' => array_merge(
$cdn_field,
[
'type' => 'checkbox',
'label' => __( 'Enable Content Delivery Network', 'rocket' ),
'helper' => $maybe_display_cdn_helper,
'section' => 'cdn_section',
'page' => 'page_cdn',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
]
),
'cdn_cnames' => [
'type' => 'cnames',
'label' => __( 'CDN CNAME(s)', 'rocket' ),
'description' => __( 'Specify the CNAME(s) below', 'rocket' ),
'default' => [],
'section' => 'cnames_section',
'page' => 'page_cdn',
],
'cdn_reject_files' => [
'type' => 'textarea',
'description' => __( 'Specify URL(s) of files that should not get served via CDN (one per line).', 'rocket' ),
'helper' => __( 'The domain part of the URL will be stripped automatically.<br>Use (.*) wildcards to exclude all files of a given file type located at a specific path.', 'rocket' ),
'placeholder' => '/wp-content/plugins/some-plugins/(.*).css',
'section' => 'exclude_cdn_section',
'page' => 'page_cdn',
'default' => [],
'sanitize_callback' => 'sanitize_textarea',
],
]
);
}
/**
* Registers Heartbeat section.
*
* @since 3.2
* @access public
* @author Grégory Viguier
*/
private function heartbeat_section() {
$heartbeat_beacon = $this->beacon->get_suggest( 'heartbeat_settings' );
$this->settings->add_page_section(
'heartbeat',
[
'title' => __( 'Heartbeat', 'rocket' ),
'menu_description' => __( 'Control WordPress Heartbeat API', 'rocket' ),
]
);
$this->settings->add_settings_sections(
[
'heartbeat_section' => [
'title' => __( 'Heartbeat', 'rocket' ),
'description' => __( 'Reducing or disabling the Heartbeat API’s activity can help save some of your server’s resources.', 'rocket' ),
'type' => 'fields_container',
'page' => 'heartbeat',
'help' => [
'id' => $heartbeat_beacon['id'],
'url' => $heartbeat_beacon['url'],
],
],
'heartbeat_settings' => [
'title' => __( 'Reduce or disable Heartbeat activity', 'rocket' ),
'description' => __( 'Reducing activity will change Heartbeat frequency from one hit each minute to one hit every 2 minutes.', 'rocket' ) . '<br/>' . __( 'Disabling Heartbeat entirely may break plugins and themes using this API.', 'rocket' ),
'type' => 'fields_container',
'page' => 'heartbeat',
],
]
);
$fields_default = [
'type' => 'select',
'page' => 'heartbeat',
'section' => 'heartbeat_settings',
'sanitize_callback' => 'sanitize_text_field',
'default' => 'reduce_periodicity',
'choices' => [
'' => __( 'Do not limit', 'rocket' ),
'reduce_periodicity' => __( 'Reduce activity', 'rocket' ),
'disable' => __( 'Disable', 'rocket' ),
],
];
$this->settings->add_settings_fields(
[
'control_heartbeat' => [
'type' => 'checkbox',
'label' => __( 'Control Heartbeat', 'rocket' ),
'page' => 'heartbeat',
'section' => 'heartbeat_section',
'sanitize_callback' => 'sanitize_checkbox',
'default' => 0,
],
'heartbeat_admin_behavior' => array_merge(
$fields_default,
[
'label' => __( 'Behavior in backend', 'rocket' ),
'description' => '',
]
),
'heartbeat_editor_behavior' => array_merge(
$fields_default,
[
'label' => __( 'Behavior in post editor', 'rocket' ),
]
),
'heartbeat_site_behavior' => array_merge(
$fields_default,
[
'label' => __( 'Behavior in frontend', 'rocket' ),
]
),
]
);
}
/**
* Registers Add-ons section
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function addons_section() {
$this->settings->add_page_section(
'addons',
[
'title' => __( 'Add-ons', 'rocket' ),
'menu_description' => __( 'Add more features', 'rocket' ),
]
);
$this->settings->add_settings_sections(
[
'one_click' => [
'title' => __( 'One-click Rocket Add-ons', 'rocket' ),
'description' => __( 'One-Click Add-ons are features extending available options without configuration needed. Switch the option "on" to enable from this screen.', 'rocket' ),
'type' => 'addons_container',
'page' => 'addons',
],
]
);
$this->settings->add_settings_sections(
[
'addons' => [
'title' => __( 'Rocket Add-ons', 'rocket' ),
'description' => __( 'Rocket Add-ons are complementary features extending available options.', 'rocket' ),
'type' => 'addons_container',
'page' => 'addons',
],
]
);
$ga_beacon = $this->beacon->get_suggest( 'google_tracking' );
$this->settings->add_settings_fields(
[
'google_analytics_cache' => [
'type' => 'one_click_addon',
'label' => __( 'Google Tracking', 'rocket' ),
'logo' => [
'url' => WP_ROCKET_ASSETS_IMG_URL . 'logo-google-analytics.svg',
'width' => 153,
'height' => 111,
],
'title' => __( 'Improve browser caching for Google Analytics', 'rocket' ),
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'WP Rocket will host these Google scripts locally on your server to help satisfy the PageSpeed recommendation for <em>Leverage browser caching</em>.<br>%1$sLearn more%2$s', 'rocket' ), '<a href="' . esc_url( $ga_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $ga_beacon['id'] ) . '" target="_blank">', '</a>' ),
'section' => 'one_click',
'page' => 'addons',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
]
);
$fb_beacon = $this->beacon->get_suggest( 'facebook_tracking' );
$this->settings->add_settings_fields(
[
'facebook_pixel_cache' => [
'type' => 'one_click_addon',
'label' => __( 'Facebook Pixel', 'rocket' ),
'logo' => [
'url' => WP_ROCKET_ASSETS_IMG_URL . 'logo-facebook.svg',
'width' => 114,
'height' => 114,
],
'title' => __( 'Improve browser caching for Facebook Pixel', 'rocket' ),
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'WP Rocket will host these Facebook Pixels locally on your server to help satisfy the PageSpeed recommendation for <em>Leverage browser caching</em>.<br>%1$sLearn more%2$s', 'rocket' ), '<a href="' . esc_url( $fb_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $fb_beacon['id'] ) . '" target="_blank">', '</a>' ),
'section' => 'one_click',
'page' => 'addons',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
]
);
/**
* Allow to display the "Varnish" tab in the settings page
*
* @since 2.7
*
* @param bool $display true will display the "Varnish" tab.
*/
if ( apply_filters( 'rocket_display_varnish_options_tab', true ) ) {
$varnish_beacon = $this->beacon->get_suggest( 'varnish' );
$this->settings->add_settings_fields(
/**
* Filters the Varnish field settings data
*
* @since 3.0
* @author Remy Perona
*
* @param array $settings Field settings data.
*/
apply_filters(
'rocket_varnish_field_settings',
[
'varnish_auto_purge' => [
'type' => 'one_click_addon',
'label' => __( 'Varnish', 'rocket' ),
'logo' => [
'url' => WP_ROCKET_ASSETS_IMG_URL . 'logo-varnish.svg',
'width' => 152,
'height' => 135,
],
'title' => __( 'If Varnish runs on your server, you must activate this add-on.', 'rocket' ),
// translators: %1$s = opening <a> tag, %2$s = closing </a> tag.
'description' => sprintf( __( 'Varnish cache will be purged each time WP Rocket clears its cache to ensure content is always up-to-date.<br>%1$sLearn more%2$s', 'rocket' ), '<a href="' . esc_url( $varnish_beacon['url'] ) . '" data-beacon-article="' . esc_attr( $varnish_beacon['id'] ) . '" target="_blank">', '</a>' ),
'section' => 'one_click',
'page' => 'addons',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
]
)
);
}
$this->settings->add_settings_fields(
[
'do_cloudflare' => [
'type' => 'rocket_addon',
'label' => __( 'Cloudflare', 'rocket' ),
'logo' => [
'url' => WP_ROCKET_ASSETS_IMG_URL . 'logo-cloudflare2.svg',
'width' => 153,
'height' => 51,
],
'title' => __( 'Integrate your Cloudflare account with this add-on.', 'rocket' ),
'description' => __( 'Provide your account email, global API key, and domain to use options such as clearing the Cloudflare cache and enabling optimal settings with WP Rocket.', 'rocket' ),
'section' => 'addons',
'page' => 'addons',
'settings_page' => 'cloudflare',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
]
);
if ( defined( 'WP_ROCKET_SUCURI_API_KEY_HIDDEN' ) && WP_ROCKET_SUCURI_API_KEY_HIDDEN ) {
// No need to display the dedicated tab if there is nothing to display on it.
$description = __( 'Clear the Sucuri cache when WP Rocket’s cache is cleared.', 'rocket' );
$settings_page = false;
} else {
$description = __( 'Provide your API key to clear the Sucuri cache when WP Rocket’s cache is cleared.', 'rocket' );
$settings_page = 'sucuri';
}
$this->settings->add_settings_fields(
[
'sucury_waf_cache_sync' => [
'type' => 'rocket_addon',
'label' => __( 'Sucuri', 'rocket' ),
'logo' => [
'url' => WP_ROCKET_ASSETS_IMG_URL . 'logo-sucuri.png',
'width' => 152,
'height' => 56,
],
'title' => __( 'Synchronize Sucuri cache with this add-on.', 'rocket' ),
'description' => $description,
'section' => 'addons',
'page' => 'addons',
'settings_page' => $settings_page,
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
]
);
}
/**
* Registers Cloudflare section
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function cloudflare_section() {
$this->settings->add_page_section(
'cloudflare',
[
'title' => __( 'Cloudflare', 'rocket' ),
'menu_description' => '',
'class' => [
'wpr-subMenuItem',
'wpr-addonSubMenuItem',
],
]
);
$beacon_cf_credentials = $this->beacon->get_suggest( 'cloudflare_credentials' );
$beacon_cf_settings = $this->beacon->get_suggest( 'cloudflare_settings' );
$beacon_cf_credentials_api = $this->beacon->get_suggest( 'cloudflare_credentials_api' );
$this->settings->add_settings_sections(
[
'cloudflare_credentials' => [
'type' => 'fields_container',
'title' => __( 'Cloudflare credentials', 'rocket' ),
'help' => [
'id' => $beacon_cf_credentials['id'],
'url' => $beacon_cf_credentials['url'],
],
'page' => 'cloudflare',
],
'cloudflare_settings' => [
'type' => 'fields_container',
'title' => __( 'Cloudflare settings', 'rocket' ),
'help' => [
'id' => $beacon_cf_settings['id'],
'url' => $beacon_cf_settings['url'],
],
'page' => 'cloudflare',
],
]
);
if ( ! defined( 'WP_ROCKET_CF_API_KEY_HIDDEN' ) || ! WP_ROCKET_CF_API_KEY_HIDDEN ) {
$this->settings->add_settings_fields(
[
'cloudflare_api_key' => [
'label' => _x( 'Global API key:', 'Cloudflare', 'rocket' ),
'description' => sprintf( '<a href="%1$s" target="_blank">%2$s</a>', esc_url( $beacon_cf_credentials_api['url'] ), _x( 'Find your API key', 'Cloudflare', 'rocket' ) ),
'default' => '',
'section' => 'cloudflare_credentials',
'page' => 'cloudflare',
],
]
);
}
$this->settings->add_settings_fields(
[
'cloudflare_email' => [
'label' => _x( 'Account email', 'Cloudflare', 'rocket' ),
'default' => '',
'container_class' => [
'wpr-field--split',
],
'section' => 'cloudflare_credentials',
'page' => 'cloudflare',
],
'cloudflare_zone_id' => [
'label' => _x( 'Zone ID', 'Cloudflare', 'rocket' ),
'default' => '',
'container_class' => [
'wpr-field--split',
],
'section' => 'cloudflare_credentials',
'page' => 'cloudflare',
],
'cloudflare_devmode' => [
'type' => 'sliding_checkbox',
'label' => __( 'Development mode', 'rocket' ),
// translators: %1$s = link opening tag, %2$s = link closing tag.
'description' => sprintf( __( 'Temporarily activate development mode on your website. This setting will automatically turn off after 3 hours. %1$sLearn more%2$s', 'rocket' ), '<a href="https://support.cloudflare.com/hc/en-us/articles/200168246" target="_blank">', '</a>' ),
'default' => 0,
'section' => 'cloudflare_settings',
'page' => 'cloudflare',
'sanitize_callback' => 'sanitize_checkbox',
],
'cloudflare_auto_settings' => [
'type' => 'sliding_checkbox',
'label' => __( 'Optimal settings', 'rocket' ),
'description' => __( 'Automatically enhances your Cloudflare configuration for speed, performance grade and compatibility.', 'rocket' ),
'default' => 0,
'section' => 'cloudflare_settings',
'page' => 'cloudflare',
'sanitize_callback' => 'sanitize_checkbox',
],
'cloudflare_protocol_rewrite' => [
'type' => 'sliding_checkbox',
'label' => __( 'Relative protocol', 'rocket' ),
'description' => __( 'Should only be used with Cloudflare\'s flexible SSL feature. URLs of static files (CSS, JS, images) will be rewritten to use // instead of http:// or https://.', 'rocket' ),
'default' => 0,
'section' => 'cloudflare_settings',
'page' => 'cloudflare',
'sanitize_callback' => 'sanitize_checkbox',
],
]
);
}
/**
* Registers Sucuri cache section.
*
* @since 3.2
* @access private
* @author Grégory Viguier
*/
private function sucuri_section() {
if ( defined( 'WP_ROCKET_SUCURI_API_KEY_HIDDEN' ) && WP_ROCKET_SUCURI_API_KEY_HIDDEN ) {
return;
}
$sucuri_beacon = $this->beacon->get_suggest( 'sucuri_credentials' );
$this->settings->add_page_section(
'sucuri',
[
'title' => __( 'Sucuri', 'rocket' ),
'menu_description' => '',
'class' => [
'wpr-subMenuItem',
'wpr-addonSubMenuItem',
],
]
);
$this->settings->add_settings_sections(
[
'sucuri_credentials' => [
'type' => 'fields_container',
'title' => __( 'Sucuri credentials', 'rocket' ),
'page' => 'sucuri',
'help' => [
'id' => $sucuri_beacon['id'],
'url' => $sucuri_beacon['url'],
],
],
]
);
$this->settings->add_settings_fields(
[
'sucury_waf_api_key' => [
'label' => _x( 'Firewall API key (for plugin), must be in format <code>{32 characters}/{32 characters}</code>:', 'Sucuri', 'rocket' ),
'description' => sprintf( '<a href="%1$s" target="_blank">%2$s</a>', 'https://kb.sucuri.net/firewall/Performance/clearing-cache', _x( 'Find your API key', 'Sucuri', 'rocket' ) ),
'default' => '',
'section' => 'sucuri_credentials',
'page' => 'sucuri',
],
]
);
}
/**
* Sets hidden fields
*
* @since 3.0
* @author Remy Perona
*
* @return void
*/
private function hidden_fields() {
$this->settings->add_hidden_settings_fields(
[
'consumer_key',
'consumer_email',
'secret_key',
'license',
'secret_cache_key',
'minify_css_key',
'minify_js_key',
'version',
'cloudflare_old_settings',
'sitemap_preload_url_crawl',
'cache_ssl',
]
);
}
}