Add-on%3$s is currently enabled. Configuration of the CDN settings is not required for %2$l to work on your site.',
'%1$s%2$l Add-ons%3$s are currently enabled. Configuration of the CDN settings is not required for %2$l to work on your site.',
count( $addons ),
'rocket'
),
'',
$addons,
''
) . '
';
}
$this->settings->add_settings_fields(
/**
* Filters the fields for the CDN section.
*
* @since 3.5
* @author Remy Perona
*
* @param array $cdn_settings_fields Data to be added to the CDN section.
*/
apply_filters(
'rocket_cdn_settings_fields',
[
'cdn' => [
'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.
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
*/
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' => $heartbeat_beacon,
],
'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' ) . '
' . __( '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
*/
private function addons_section() {
$webp_beacon = $this->beacon->get_suggest( 'webp' );
$user_cache_beacon = $this->beacon->get_suggest( 'user_cache' );
$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',
],
]
);
$this->settings->add_settings_fields(
[
'cache_logged_user' => [
'type' => 'one_click_addon',
'label' => __( 'User Cache', 'rocket' ),
'logo' => [
'url' => WP_ROCKET_ASSETS_IMG_URL . 'icon-user-cache.svg',
'width' => 152,
'height' => 135,
],
'title' => __( 'If you need to create a dedicated set of cache files for each logged-in WordPress user, you must activate this add-on.', 'rocket' ),
// translators: %1$s = opening tag, %2$s = closing tag.
'description' => sprintf( __( 'User cache is great when you have user-specific or restricted content on your website.
%1$sLearn more%2$s', 'rocket' ), '', '' ),
'section' => 'one_click',
'page' => 'addons',
'settings_page' => 'user_cache',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
]
);
$default_cf_settings = [
'do_cloudflare' => [
'type' => 'rocket_addon',
'label' => __( 'Cloudflare', 'rocket' ),
'logo' => [
'url' => rocket_get_constant( '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' ),
'helper' => sprintf(
// translators: %1$s = opening span tag, %2$s = closing span tag.
__( '%1$sPlanning on using Automatic Platform Optimization (APO)?%2$s Just activate the official Cloudflare plugin and configure it. WP Rocket will automatically enable compatibility.', 'rocket' ),
'',
''
),
'section' => 'addons',
'page' => 'addons',
'settings_page' => 'cloudflare',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
];
/**
* Filters the Cloudflare Addon field values
*
* @since 3.14
*
* @param array $cf_settings Array of values to populate the field.
*/
$cf_settings = (array) apply_filters( 'rocket_cloudflare_field_settings', $default_cf_settings );
$cf_settings = wp_parse_args( $cf_settings, $default_cf_settings );
$this->settings->add_settings_fields( $cf_settings );
/**
* 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 tag, %2$s = closing tag.
'description' => sprintf( __( 'Varnish cache will be purged each time WP Rocket clears its cache to ensure content is always up-to-date.
%1$sLearn more%2$s', 'rocket' ), '', '' ),
'section' => 'one_click',
'page' => 'addons',
'settings_page' => 'varnish',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
],
]
)
);
}
$webp_beacon = $this->beacon->get_suggest( 'webp' );
if ( rocket_valid_key() && ! \Imagify_Partner::has_imagify_api_key() ) {
$imagify_link = '';
} else {
$imagify_link = '';
}
$this->settings->add_settings_fields(
[
'cache_webp' =>
/**
* Add more content to the 'cache_webp' setting field.
*
* @since 3.10 moved to add-on section
* @since 3.4
*
* @param array $cache_webp_field Data to be added to the setting field.
*/
apply_filters(
'rocket_cache_webp_setting_field',
[
'type' => 'one_click_addon',
'label' => __( 'WebP Compatibility', 'rocket' ),
'logo' => [
'url' => WP_ROCKET_ASSETS_IMG_URL . 'logo-webp.svg',
'width' => 152,
'height' => 135,
],
'title' => __( 'Improve browser compatibility for WebP images.', 'rocket' ),
// translators: %1$s = opening tag, %2$s = closing tag.
'description' => sprintf(
// translators: %1$s and %3$s = opening tag, %2$s = closing 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,
'',
''
),
'section' => 'one_click',
'page' => 'addons',
'settings_page' => 'webp',
'default' => 0,
'sanitize_callback' => 'sanitize_checkbox',
'container_class' => [
'wpr-webp-addon',
],
]
),
]
);
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
*/
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_mask' => [
'label' => _x( 'Global API key:', 'Cloudflare', 'rocket' ),
'description' => sprintf( '%2$s', 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_mask' => [
'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' ), '', '' ),
'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
*/
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 {32 characters}/{32 characters}:', 'Sucuri', 'rocket' ),
'description' => sprintf( '%2$s', '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
*/
private function hidden_fields() {
$hidden_fields = [
'consumer_key',
'consumer_email',
'secret_key',
'license',
'secret_cache_key',
'minify_css_key',
'minify_js_key',
'version',
'previous_version',
'cloudflare_old_settings',
'cache_ssl',
'minify_google_fonts',
'emoji',
'remove_unused_css',
'async_css',
'cache_mobile',
'do_caching_mobile_files',
'minify_concatenate_css',
'cloudflare_api_key',
'cloudflare_zone_id',
];
$this->settings->add_hidden_settings_fields(
/**
* Filters the hidden settings fields
*
* @since 3.5
* @author Remy Perona
*
* @param array $hidden_settings_fields An array of hidden settings fields ID
*/
apply_filters(
'rocket_hidden_settings_fields',
$hidden_fields
)
);
}
/**
* Sanitize and format a list.
*
* @since 3.5.5
*
* @param array $list A list of strings.
* @param string $tag_name Name of the HTML tag that will wrap each element of the list.
* @return array
*/
private function sanitize_and_format_list( array $list, $tag_name = 'strong' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.listFound
if ( empty( $list ) ) {
return [];
}
$list = array_filter( $list );
if ( empty( $list ) ) {
return [];
}
$list = array_unique( $list );
if ( empty( $tag_name ) ) {
return $list;
}
$format = "<$tag_name>%s$tag_name>";
return array_map( 'sprintf', array_fill( 0, count( $list ), $format ), $list );
}
/**
* Checks if combine JS option should be disabled
*
* @since 3.9
*
* @return bool
*/
private function disable_combine_js(): bool {
if ( (bool) get_rocket_option( 'delay_js', 0 ) ) {
return true;
}
return ! (bool) get_rocket_option( 'minify_js', 0 );
}
/**
* Render radio options sub fields.
*
* @since 3.10
*
* @param array $sub_fields Array of fields to display.
*/
public function display_radio_options_sub_fields( $sub_fields ) {
$sub_fields = $this->settings->set_radio_buttons_sub_fields_value( $sub_fields );
$this->render->render_fields( $sub_fields );
}
/**
* Render mobile cache option.
*
* @return void
*/
public function display_mobile_cache_option(): void {
if ( (bool) $this->options->get( 'cache_mobile', 0 ) ) {
return;
}
$data = $this->beacon->get_suggest( 'mobile_cache' );
echo $this->generate( 'settings/mobile-cache', $data ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Dynamic content is properly escaped in the view.
}
/**
* Callback method for the AJAX request to mobile cache.
*
* @return void
*/
public function enable_mobile_cache(): void {
check_ajax_referer( 'rocket-ajax', 'nonce', true );
if ( ! current_user_can( 'rocket_manage_options' ) ) {
wp_send_json_error();
return; // @phpstan-ignore-line
}
$this->options->set( 'cache_mobile', 1 );
$this->options->set( 'do_caching_mobile_files', 1 );
update_option( rocket_get_constant( 'WP_ROCKET_SLUG', 'wp_rocket_settings' ), $this->options->get_options() );
wp_send_json_success();
}
/**
* Enable Separate cache files option on upgrade.
*
* @return void
*/
public function enable_separate_cache_files_mobile(): void {
if ( ! (bool) $this->options->get( 'cache_mobile', 0 ) ) {
return;
}
if ( (bool) $this->options->get( 'do_caching_mobile_files', 0 ) ) {
return;
}
$this->options->set( 'do_caching_mobile_files', 1 );
update_option( rocket_get_constant( 'WP_ROCKET_SLUG', 'wp_rocket_settings' ), $this->options->get_options() );
}
/**
* Display an update notice when the plugin is updated.
*
* @return void
*/
public function display_update_notice() {
if ( ! current_user_can( 'rocket_manage_options' ) ) {
return;
}
if ( 'settings_page_wprocket' !== get_current_screen()->id ) {
return;
}
$boxes = get_user_meta( get_current_user_id(), 'rocket_boxes', true );
if ( in_array( 'rocket_update_notice', (array) $boxes, true ) ) {
return;
}
$previous_version = $this->options->get( 'previous_version' );
// Bail-out for fresh install.
if ( empty( $previous_version ) ) {
return;
}
// Bail-out if previous version is greater than 3.17.
if ( $previous_version > '3.17' ) {
return;
}
$lazy_render_content = $this->beacon->get_suggest( 'lazy_render_content' );
rocket_notice_html(
[
'status' => 'info',
'dismissible' => '',
'message' => sprintf(
// translators: %1$s: opening strong tag, %2$s: closing strong tag, %3$s: opening a tag, %4$s: opening a tag.
__( '%1$sWP Rocket:%2$s the plugin has been updated to the 3.17 version. New feature: %3$sAutomatic Lazy Rendering%4$s. Check out our documentation to learn more about it.', 'rocket' ),
'',
'',
'',
''
),
'dismiss_button' => 'rocket_update_notice',
]
);
}
}