WP Rocket

https://docs.wp-rocket.me/
Admin
WP Rocket is a premium WordPress caching plugin that helps improve website speed and performance by...
Tokens:298,285
Snippets:2,422
Trust Score:9.7
Update:19 hours ago
Show doc for...
Tokens:
Raw
### Complete example MU plugin for WP Rocket

Source: https://docs.wp-rocket.me/article/142-how-to-make-a-custom-mu-plugin

A full MU plugin example with plugin header, security check, function prefixing, and a custom function hooked into the wp_rocket_loaded action.

```php
<?php
/**
 * Plugin Name: Your Plugin Name Here
 * Description: Short description of your plugin here.
 * Author:      your name here
 * License:     GNU General Public License v3 or later
 * License URI: http://www.gnu.org/licenses/gpl-3.0.html
 */

// Basic security, prevents file from being loaded directly.
defined( 'ABSPATH' ) or die( 'Cheatin&#8217; uh?' );

/* Prefix your custom functions!
 *
 * Function names must be unique in PHP.
 * In order to make sure the name of your function does not
 * exist anywhere else in WordPress, or in other plugins,
 * give your function a unique custom prefix.
 * Example prefix: wpr20151231
 * Example function name: wpr20151231__do_something
 *
 * For the rest of your function name after the prefix,
 * make sure it is as brief and descriptive as possible.
 * When in doubt, do not fear a longer function name if it
 * is going to remind you at once of what the function does.
 * Imagine you’ll be reading your own code in some years, so
 * treat your future self with descriptive naming. ;)
 */

/**
 * Pass your custom function to the wp_rocket_loaded action hook.
 *
 * Note: wp_rocket_loaded itself is hooked into WordPress’ own
 * plugins_loaded hook.
 * Depending what kind of functionality your custom plugin
 * should implement, you can/should hook your function(s) into
 * different action hooks, such as for example
 * init, after_setup_theme, or template_redirect.
 * 
 * Learn more about WordPress actions and filters here:
 * https://developer.wordpress.org/plugins/hooks/
 *
 * @param string 'wp_rocket_loaded'         Hook name to hook function into
 * @param string 'yourprefix__do_something' Function name to be hooked
 */
add_action( 'wp_rocket_loaded', 'yourprefix__do_something' );

/**
 * Define your custom function here.
 * This example just returns true.
 * 
 * @return bool Boolean value TRUE
 */
function yourprefix__do_something() {
	return true;
}

```

--------------------------------

### Get help for a WP Rocket CLI command

Source: https://docs.wp-rocket.me/article/1497-wp-cli-interface-for-wp-rocket

Use this command to learn more about the usage of a specific command and its available flags, for example 'clean'.

```bash
wp help rocket clean
```

--------------------------------

### External asset examples

Source: https://docs.wp-rocket.me/article/1869-preconnect-to-external-domains

These are examples of external assets (script, stylesheet, iframe) that WP Rocket will optimize by adding dns-prefetch hints.

```html
<script src="https://cloudflare.com/assets/script.js"></script>
```

```html
<link rel="stylesheet" href="https://cdnjs.com/styles.css">
```

```html
<iframe src="https://www.youtube.com/video-embed-1"></iframe>
```

--------------------------------

### Example configuration file using update_rocket_option()

Source: https://docs.wp-rocket.me/article/1677-how-to-programmatically-configure-wp-rocket-options

Example PHP file that turns off LazyLoad, turns on Delay JavaScript Execution, turns on CDN, and sets the CDN CNAME to example.com. Visit the file in a browser to apply the configuration.

```php
<?php 
// Load WordPress.
require( 'wp-load.php' );

if(function_exists('update_rocket_option')) {
  update_rocket_option( 'lazyload', 0);
  update_rocket_option( 'delay_js', 1);
  update_rocket_option( 'cdn', 1);
  update_rocket_option( 'cdn_cnames', ["example.com"] );
}
	
```

--------------------------------

### Install WP Rocket CLI from zip file

Source: https://docs.wp-rocket.me/article/1497-wp-cli-interface-for-wp-rocket

For WP-CLI versions prior to v0.23.0, install the WP Rocket CLI from a downloaded zip file. Run this command after uploading the zip to your server.

```bash
wp package install wp-rocket-cli-trunk.zip
```

--------------------------------

### Example URL patterns for event pages

Source: https://docs.wp-rocket.me/article/54-exclude-pages-from-the-cache

Shows the URL structure for event pages that are child pages, used as an example for regex exclusion.

```text
/events/your-event-here/  
/events/another-event here/
```

--------------------------------

### Install WP Rocket dependencies with Composer

Source: https://docs.wp-rocket.me/article/1301-wp-rocket-installation-from-github-using-composer

Runs Composer install with --no-dev and --no-scripts to create the /vendor/ folder containing third-party libraries. Must be run inside the WP Rocket plugin folder.

```bash
composer install --no-dev --no-scripts
```

--------------------------------

### Example var_dump output showing classic-editor query string

Source: https://docs.wp-rocket.me/article/1429-subpages-are-not-cached

Example output from the var_dump diagnostic, showing a conflicting query string 'classic-editor' set to true. This indicates the presence of a query string that causes WP Rocket to bypass caching.

```plaintext
array(1) {
	["classic-editor"]=>
	bool(true)
}
```

--------------------------------

### Add cron job entry via wget

Source: https://docs.wp-rocket.me/article/1279-cron-and-wp-rocket

Add this cron job entry through your hosting control panel, replacing example.com with your actual domain. Set the job to run every 1 or 5 minutes.

```bash
wget -q -O - https://example.com/custom-cron-multisite.php?doing_wp_cron >/dev/null 2>&1
```

--------------------------------

### Install WP Rocket CLI with wp package install

Source: https://docs.wp-rocket.me/article/1497-wp-cli-interface-for-wp-rocket

Install the WP Rocket CLI package using WP-CLI v0.23.0 or later. Run this command in the terminal.

```bash
wp package install wp-media/wp-rocket-cli:trunk
```

--------------------------------

### Install WP Rocket CLI with increased memory limit

Source: https://docs.wp-rocket.me/article/1497-wp-cli-interface-for-wp-rocket

Use this command to avoid memory exhaustion errors during installation. It sets memory_limit to 512M on the fly and installs the wp-media/wp-rocket-cli package.

```bash
php -d memory_limit=512M "$(which wp)" package install wp-media/wp-rocket-cli
```

--------------------------------

### Replace prefetch with preconnect using rocket_preconnect_external_domains_use_prefetch

Source: https://docs.wp-rocket.me/article/1869-preconnect-to-external-domains

Switches the Preconnect to external domains option from the default 'dns-prefetch' hint to the 'preconnect' hint. The resulting markup for the preconnected domain is shown.

```PHP
add_filter( 'rocket_preconnect_external_domains_use_prefetch', '__return_false' );
```

```HTML
<link crossorigin data-rocket-preconnect href="https://cloudflare.com/" rel="preconnect">
```

--------------------------------

### Examples of is_category() usage

Source: https://docs.wp-rocket.me/article/1561-programmatically-toggle-wp-rocket-options-under-specific-conditions

These examples show different ways to use the is_category() conditional tag: with no arguments, by ID, by name, by slug, or with an array of multiple categories. Each example includes a comment explaining when it returns true.

```php
is_category();
// When any Category archive page is being displayed.

is_category( '9' ); 
// ID based, When the archive page for Category 9 is being displayed.

is_category( 'Stinky Cheeses' ); 
// Name based: When the archive page for the Category with Name "Stinky Cheeses" is being displayed.

is_category( 'blue-cheese' ); 
// Slug based: When the archive page for the Category with Category Slug "blue-cheese" is being displayed.

is_category( array( 9, 'blue-cheese', 'Stinky Cheeses' ) ); 
// Multiple categories: returns true when the category of posts being displayed is either term_ID 9, or slug "blue-cheese", or name "Stinky Cheeses".
```

--------------------------------

### Import WP Rocket settings via CLI

Source: https://docs.wp-rocket.me/article/1497-wp-cli-interface-for-wp-rocket

Import WP Rocket's settings. Optionally specify a file with --file.

```bash
wp rocket import [--file=<file>]
```

--------------------------------

### Example inline script to exclude

Source: https://docs.wp-rocket.me/article/976-exclude-files-from-defer-js

Example of an inline script that could be excluded. The 'kl-identify-browser-js-extra' string is a good candidate for the exclusion key.

```html
<script id='kl-identify-browser-js-extra'> var klUser = {"current_user_email":"","commenter_email":""}; </script>
```

--------------------------------

### Example cron.log output

Source: https://docs.wp-rocket.me/article/1811-how-to-check-if-cron-is-running-correctly

Shows the expected format of the cron.log file after adding the logging snippet. Entries like 'Triggered by the server' or 'Wget/1.14 (linux-gnu)' indicate server-triggered cron, while 'WordPress/6.0.2; https://example.com/' indicates backend-triggered cron.

```log
[2022-11-15 20:00:00] Cron: Triggered by the server
[2022-11-15 20:01:00] Cron: WordPress/6.0.2; https://example.com/
[2022-11-15 20:02:00] Cron: WordPress/6.0.2; https://example.com/
[2022-11-15 20:05:00] Cron: Triggered by the server
[2022-11-15 20:06:00] Cron: WordPress/6.0.2; https://example.com/
[2022-11-15 20:07:00] Cron: WordPress/6.0.2; https://example.com/
[2022-11-15 20:10:00] Cron: Wget/1.14 (linux-gnu)
[2022-11-15 20:13:32] Cron: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko)
[2022-11-15 20:15:00] Cron: Triggered by the server
[2022-11-15 20:16:00] Cron: WordPress/6.0.2; https://example.com/
[2022-11-15 20:17:00] Cron: WordPress/6.0.2; https://example.com/
[2022-11-15 20:20:00] Cron: Triggered by the server
```
Tokens:
Raw