WP Rocket Helpers

https://github.com/wp-media/wp-rocket-helpers
Admin
WP Rocket Helpers is a collection of helper plugins designed to extend, customize, and fine-tune WP...
Tokens:132,835
Snippets:1,268
Trust Score:9.4
License:GPL-2.0
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Direct call to wprlm_install_bootstrap()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/wp-rocket-license-manager.md

Direct call example for wprlm_install_bootstrap(). Logs the error message if the installation fails.

```php
$result = wprlm_install_bootstrap();
if ( is_wp_error( $result ) ) {
    error_log( 'Bootstrap install failed: ' . $result->get_error_message() );
}
```

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

### Example Helper Plugin with namespace and action hook

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/README.md

Example of a Helper Plugin using the namespace pattern. It defines a function and hooks it to the 'init' action. Replace example.com placeholders before activation.

```php
namespace WP_Rocket\Helpers\cache\no_cache_for_admins;

function handle_cache_for_admins() {
    // Handle caching for logged-in administrators.
}
add_action( 'init', __NAMESPACE__ . '\handle_cache_for_admins' );
```

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

### Usage Example - Set and Display a Notice

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/wp-rocket-license-manager.md

Shows how to set a notice with wprlm_set_notice() and then display it on a later page render using wprlm_get_notice(). The example outputs a WordPress admin notice div with the appropriate notice class.

```php
wprlm_set_notice( 'error', 'Enter a valid email address and an 8-character WP Rocket API key.' );
// …later, on page render:
$notice = wprlm_get_notice();
if ( $notice ) {
    echo '<div class="notice notice-' . esc_attr( $notice['type'] ) . '">' . esc_html( $notice['message'] ) . '</div>';
}
```

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

### Add multiple Varnish IPs

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/compatibility/wp-rocket-varnish-config/readme.md

Example of adding multiple IPs with and without port.

```php
$ips[] =  '192.168.0.5:6081';
$ips[] =  '10.0.0.15';
```

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

### Single Site Custom Sitemaps Configuration

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/preload/wp-rocket-preload-sitemap-control/README.md

Use this format to specify the domain and sitemaps for a single site setup. Replace the example domain and sitemap names with your actual values.

```php
'sites' = [

  'https://www.example1.com' => [
    'https://www.example1.com/custom-sitemap-1.xml',
    'https://www.example1.com/custom-sitemap-2.xml',
  ],
];
```

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

### Placeholder URLs and domains

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/README.md

Placeholder URLs and domains for illustrative examples. Replace all example.com occurrences with custom values before activating the plugin.

```text
https://example.com
http://example.com
https://sub-domain.example.com
person@example.com
ftp.example.com
```

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

### Example: prepend and swap a rule in Used CSS

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/rucss.md

Shows a minimal WPRH_MOD_USED_CSS_PARAMS definition that prepends a CSS rule and swaps another. The comment notes the generated Used CSS starts with the prepended rule and the old rule is rewritten.

```php
define( 'WPRH_MOD_USED_CSS_PARAMS', [
	'prepend_css' => [ '.site{max-width:1100px}' ],
	'filter_css'  => [ '.old{padding:10px}' => '.old{padding:20px}' ],
	// …
] );
// Generated Used CSS now starts with .site{max-width:1100px} and .old is rewritten.
```

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

### wprlm_get_bootstrap_status()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/wp-rocket-license-manager.md

Checks the installation status of the MU bootstrap by comparing file hashes. Returns one of 'active', 'missing', 'outdated', or 'conflict'.

```APIDOC
## wprlm_get_bootstrap_status()

### Description
Determines the current status of the MU bootstrap file by comparing the bundled and installed files using sha256 hashes.

### Method
PHP function

### Endpoint
`wprlm_get_bootstrap_status()`

### Parameters
None

### Return Value
- **string** - One of: `active`, `missing`, `outdated`, `conflict`.

### Example
```php
$status = wprlm_get_bootstrap_status();
if ( 'active' === $status ) {
    // bootstrap is up to date
}
```
```

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

### Example: Force update check via rocket_force_update query

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/class-wp-rocket-update-notification-recovery.md

Example usage: visiting `wp-admin/plugins.php?rocket_force_update=1` triggers the manual refresh by calling `maybe_force_update_check()`.

```php
// Visiting: wp-admin/plugins.php?rocket_force_update=1
WP_Rocket_Update_Notification_Recovery::maybe_force_update_check();
```

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

### Direct usage example for WPRExcludeHighlightDelayJS

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/various.md

Shows direct usage of the class methods: get_instance, remove_before_optimizations, and add_after_optimizations. The first call replaces the <pre> block with a comment placeholder, and the second restores the original HTML.

```php
$obj = WPRExcludeHighlightDelayJS::get_instance();
$html = '<pre><code>var a = 1;</code></pre>';
$tmp  = $obj->remove_before_optimizations( $html ); // → '<!-- WPR_DJ_HELPER_… -->'
$back = $obj->add_after_optimizations( $tmp );      // → original <pre> HTML
```

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

### wprlm_get_bootstrap_paths()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/wp-rocket-license-manager.md

Returns an array with the bundled source path and the installed target path for the MU bootstrap file. Used by other bootstrap functions.

```php
function wprlm_get_bootstrap_paths() {
	return [
		'source' => __DIR__ . '/bootstrap/' . WPRLM_BOOTSTRAP_FILENAME,
		'target' => WPMU_PLUGIN_DIR . '/' . WPRLM_BOOTSTRAP_FILENAME,
	];
}
```

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

### Add extra URLs for multiple config files

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/various/wp-rocket-multiple-config-files/README.md

Replace the example provided in line 27 with the real URLs for which you need to generate the config files. Add new URLs as needed, one per line.

```php
$extra_url[] = 'another-url.com';
$extra_url[] = 'and-another-url.com';
$extra_url[] = 'and-yet-another-url.com';
```

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

### Direct usage of restore_folder_name() with error path

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/class-wp-rocket-update-notification-recovery.md

Direct usage example with error path. Checks the update_plugins capability, verifies the nonce, then calls restore_folder_name() which never returns.

```php
if ( ! current_user_can( 'update_plugins' ) ) {
    wp_die( 'Not allowed' );
}
check_admin_referer( 'wp_rocket_update_notification_recovery_restore_folder' );
WP_Rocket_Update_Notification_Recovery::restore_folder_name(); // never returns
```

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

### Example: apply_filters with rocket_preload_before_preload_url

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/preload.md

Shows how to invoke the filter with a sample request array. After the filter runs, the 'cookies' header contains a WP_Http_Cookie per combination, e.g., currency=usd and currency=eur.

```php
$requests = apply_filters( 'rocket_preload_before_preload_url', [ [ 'url' => 'https://example.com/' ] ] );
// header 'cookies' now contains a WP_Http_Cookie per combination: currency=usd, currency=eur
```

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

### Set custom Varnish IP and host for proxy setups

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/compatibility.md

Defines a constant for the custom Varnish host (must be edited from the placeholder) and functions to set a custom IP and host. The host is only changed if the constant's md5 checksum differs from the placeholder's checksum. Hooks: 'rocket_varnish_ip' and 'rocket_varnish_purge_request_host'.

```php
// REPLACE example.com WITH YOUR DOMAIN NAME:
define( 'WPROCKETHELPERS_CUSTOM_VARNISH_HOST', 'example.com' );
// STOP EDITING

function set_custom_varnish_ip() {
	return 'localhost';
}
add_action( 'rocket_varnish_ip', __NAMESPACE__ . '\set_custom_varnish_ip' );

function maybe_set_custom_varnish_host( $host ) {
	$custom_host = (string) WPROCKETHELPERS_CUSTOM_VARNISH_HOST;
	$host = '5ababd603b22780302dd8d83498e5172' === md5( $custom_host ) ? $host : $custom_host;
	return $host;
}
add_action( 'rocket_varnish_purge_request_host', __NAMESPACE__ . '\maybe_set_custom_varnish_host' );
```

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

### Manually invoke WPR_CF_Intkey_Fix::activate_rocket()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/various.md

Example of manually invoking the WPR_CF_Intkey_Fix::activate_rocket() handler. Requires the 'activate_plugins' capability and a valid nonce for 'wpr_cf_fix_activate_rocket'; the call terminates.

```php
if ( current_user_can( 'activate_plugins' ) ) {
    check_admin_referer( 'wpr_cf_fix_activate_rocket' );
    WPR_CF_Intkey_Fix::activate_rocket(); // terminates
}
```

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

### Customize Preload Links config (wp-rocket-customize-preload-links-config)

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/preload.md

Extends the Preload Links front-end script config by adding custom exclusions, image extensions, and file extensions. The example appends to existing pipe-separated lists or creates them if missing. Edit the custom_* arrays as needed.

```php
function customize_preload_config( array $config ) {

	// EDIT THIS:
	$custom_exclusions = [ '/custom-path/', /* '/url-part', 'url-part/' */ ];
	$custom_image_extensions = [ 'svg', 'ico' ];
	$custom_file_extensions = [ 'zip', 'rar', 'txt' ];

	if ( isset( $config['excludeUris'] ) ) {
		$config['excludeUris'] .= '|' . implode( '|', $custom_exclusions );
	} else {
		$config['excludeUris'] = implode( '|', $custom_exclusions );
	}

	if ( isset( $config['imageExt'] ) ) {
		$config['imageExt'] .= '|' . implode( '|', $custom_image_extensions );
	} else {
		$config['imageExt'] = implode( '|', $custom_image_extensions );
	}

	if ( isset( $config['fileExt'] ) ) {
		$config['fileExt'] .= '|' . implode( '|', $custom_file_extensions );
	} else {
		$config['fileExt'] = implode( '|', $custom_file_extensions );
	}

	// STOP EDITING
	return $config;
}
add_filter( 'rocket_preload_links_config', __NAMESPACE__ . '\customize_preload_config' );

```

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

### wprlm_get_bootstrap_status()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/wp-rocket-license-manager.md

Returns a string status: active, missing, outdated, or conflict. Hash-compares the bundled and installed files with sha256 to determine if the installed bootstrap is outdated.

```php
function wprlm_get_bootstrap_status() {
	$paths = wprlm_get_bootstrap_paths();

	if ( ! file_exists( $paths['target'] ) ) {
		return 'missing';
	}

	$existing = file_get_contents( $paths['target'] );

	if ( false === $existing || false === strpos( $existing, WPRLM_BOOTSTRAP_MARKER ) ) {
		return 'conflict';
	}

	if ( ! is_readable( $paths['source'] ) || hash_file( 'sha256', $paths['source'] ) !== hash_file( 'sha256', $paths['target'] ) ) {
		return 'outdated';
	}

	return 'active';
}
```

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

### Activation hook with wprlm_install_bootstrap()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/wp-rocket-license-manager.md

Error handling pattern used by the plugin itself. On activation, installs the bootstrap and deactivates the plugin with a wp_die message if installation fails. Source: wp-rocket-license-manager.php:92.

```php
function wprlm_activate() {
    $result = wprlm_install_bootstrap();
    if ( is_wp_error( $result ) ) {
        deactivate_plugins( plugin_basename( __FILE__ ) );
        wp_die( esc_html( $result->get_error_message() ), esc_html__( 'WP Rocket - License Manager could not be activated.' ), [ 'back_link' => true ] );
    }
}
register_activation_hook( __FILE__, 'wprlm_activate' );
```

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

### Define custom hostname

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/compatibility/wp-rocket-varnish-config/readme.md

Replace 'example.com' with your public domain in line 42 to ensure purge requests use the correct host header when going through a proxy.

```php
$custom_host  =  'example.com';
```

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

### Disable LazyLoad by src fragment (rocket_lazyload_excluded_src)

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/lazyload.md

Adds src fragments to the excluded sources filter. The examples show matching a domain, a path, and a query string. Edit the example entries before use.

```php
function exclude_src( array $excluded_src ) {
	// EDIT/REPLACE THESE EXAMPLES:
	$excluded_src[] = 'example.com';    // <img src="example.com">
	$excluded_src[] = '/example-path';  // <img src="/example-path/image.jpg">
	$excluded_src[] = '/example?query'; // <img src="example?query=image.jpg">
	// STOP EDITING.
	return $excluded_src;
}
add_filter( 'rocket_lazyload_excluded_src', __NAMESPACE__ . '\exclude_src' );
```

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

### wprlm_install_bootstrap()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/wp-rocket-license-manager.md

Copies the bundled bootstrap file into the mu-plugins directory, refusing to overwrite foreign files. Returns true on success or a WP_Error on failure.

```APIDOC
## wprlm_install_bootstrap()

### Description
Installs the bundled MU bootstrap file into `wp-content/mu-plugins/`. Will not overwrite a file that does not contain the plugin's marker.

### Method
PHP function

### Endpoint
`wprlm_install_bootstrap()`

### Parameters
None

### Return Value
- **true** - On success.
- **\WP_Error** - On failure with one of the following error codes: `missing_source`, `mkdir_failed`, `bootstrap_conflict`, `copy_failed`.

### Errors
- `missing_source` - The bundled MU bootstrap file is missing.
- `mkdir_failed` - Could not create the mu-plugins directory.
- `bootstrap_conflict` - A different file already uses the MU bootstrap filename.
- `copy_failed` - Could not copy the file. Check permissions.

### Example
```php
$result = wprlm_install_bootstrap();
if ( is_wp_error( $result ) ) {
    error_log( 'Bootstrap install failed: ' . $result->get_error_message() );
}
```
```

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

### bootstrap()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/class-wp-rocket-update-notification-recovery.md

Registers every hook the class honors. Called once at file load. Returns nothing.

```APIDOC
## bootstrap()

### Description
Registers every hook the class honors. Called once at file load. Returns nothing.

### Method
bootstrap()

### Signature
```php
public static function bootstrap()
```

### Parameters
None

### Return Value
void

### Usage Example
```php
WP_Rocket_Update_Notification_Recovery::bootstrap();
```
```

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

### Relocate WP Rocket cache/config folders (wp-rocket-cache-custom-folders)

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/deprecated-experimental.md

Defines custom cache and config folder paths for WP Rocket pre-3.x installs and injects them into advanced-cache.php via the rocket_advanced_cache_file filter. Kept for legacy installations that need to relocate WP Rocket's cache and config directories.

```php
define( 'WP_ROCKET_CACHE_ROOT_PATH', WP_CONTENT_DIR . '/your-wp-rocket-cache-folder/' );
define( 'WP_ROCKET_CACHE_ROOT_URL', 'http://your-domain.com/wp-content/your-wp-rocket-cache-folder/' );
define( 'WP_ROCKET_CONFIG_PATH', WP_CONTENT_DIR.'/your-wp-rocket-config-folder/' );

function modify_advanced_cache_file( $buffer ) {
	// …injects the three constants into advanced-cache.php
	return $buffer;
}
add_filter( 'rocket_advanced_cache_file', __NAMESPACE__ . '\modify_advanced_cache_file' );
```

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

### Enable Varnish HTTP Purge

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/deprecated-experimental.md

Enables Varnish HTTP purge by adding a filter on init. Legacy; now a core option.

```php
function wp_rocket_varnish_cache_purge__do_rocket_varnish_http_purge() {
	add_filter( 'do_rocket_varnish_http_purge', '__return_true' );
}
add_action( 'init', 'wp_rocket_varnish_cache_purge__do_rocket_varnish_http_purge' );
```

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

### Add multilingual URLs to disable caching

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_experimental/wp-rocket-compat-wc-optimize/README.md

For multilingual sites, add more URLs as needed. Example includes Spanish equivalents: /pagar, /carrito, /mi-cuenta.

```php
$uris_to_remove = [
'/checkout',
'/cart',
'/my-account',
'/pagar',
'/carrito',
'/mi-cuenta',
];
```

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

### bootstrap() - Register all hooks

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/class-wp-rocket-update-notification-recovery.md

Registers every hook the class honors. Called once at file load. Returns nothing.

```php
public static function bootstrap() {
	add_filter( 'http_request_args', array( __CLASS__, 'maybe_add_rocket_user_agent' ), 10, 2 );
	add_filter( 'pre_set_site_transient_update_plugins', array( __CLASS__, 'add_update' ), 20 );
	add_filter( 'site_transient_update_plugins', array( __CLASS__, 'add_update' ), 20 );
	add_filter( 'plugin_row_meta', array( __CLASS__, 'add_check_updates_link' ), 20, 2 );
	add_action( 'deleted_site_transient', array( __CLASS__, 'maybe_clear_cache' ) );
	add_action( 'admin_init', array( __CLASS__, 'maybe_force_update_check' ), 1 );
	add_action( 'admin_init', array( __CLASS__, 'maybe_redirect_after_activation' ), 2 );
	add_action( 'admin_notices', array( __CLASS__, 'display_folder_notice' ) );
	add_action( 'network_admin_notices', array( __CLASS__, 'display_folder_notice' ) );
	add_action( 'admin_post_wp_rocket_update_notification_recovery_restore_folder', array( __CLASS__, 'restore_folder_name' ) );
}
```

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

### add_update() - Add WP Rocket update to update_plugins transient

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/class-wp-rocket-update-notification-recovery.md

Hooked on `pre_set_site_transient_update_plugins` and `site_transient_update_plugins` (priority 20). Returns the (possibly new `stdClass`) transient with WP Rocket's vendor update offer in `->response[$plugin_file]` (when `installed < new_version`) and its checked version in `->checked[$plugin_file]`. Skips everything when WP Rocket is already loaded or not installed, or when the API returns a `WP_Error`. The injected object has shape `{slug, plugin, new_version, stable_version, url, package}`.

```php
public static function add_update( $updates ) {
	if ( self::wp_rocket_is_loaded() || ! self::wp_rocket_is_installed() ) {
		return $updates;
	}

	$plugin_file = self::get_wp_rocket_plugin_file();
	if ( ! $plugin_file ) {
		return $updates;
	}

	$installed_version = self::get_installed_version();
	if ( '' === $installed_version ) {
		return $updates;
	}

	$remote_data = self::get_remote_data();
	if ( is_wp_error( $remote_data ) ) {
		return $updates;
	}

	if ( ! is_object( $updates ) ) {
		$updates = new stdClass();
	}
	if ( ! isset( $updates->response ) || ! is_array( $updates->response ) ) {
		$updates->response = array();
	}
	if ( ! isset( $updates->checked ) || ! is_array( $updates->checked ) ) {
		$updates->checked = array();
	}

	if ( version_compare( $installed_version, $remote_data->new_version, '<' ) ) {
		$updates->response[ $plugin_file ] = $remote_data;
	} else {
		unset( $updates->response[ $plugin_file ] );
	}

	$updates->checked[ $plugin_file ] = $installed_version;

	return $updates;
}
```

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

### Multisite Custom Sitemaps Configuration

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/preload/wp-rocket-preload-sitemap-control/README.md

Use this format for multisite setups to specify each site on the network and their sitemaps. Copy and paste as many blocks as needed for each site.

```php
'sites' = [

  'https://www.example1.com' => [
    'https://www.example1.com/custom-sitemap-1.xml',
    'https://www.example1.com/custom-sitemap-2.xml',
  ],

  'https://www.example2.com' => [
    'https://www.example2.com/custom-sitemap-1.xml',
    'https://www.example2.com/custom-sitemap-2.xml',
  ],
];
```

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

### Example usage of rocket_lazyload_threshold filter

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/lazyload.md

Shows how to use the filter with a different constant value (e.g., 600). The comment indicates the filter returns 600 when the constant is edited.

```php
// Edit the constant to e.g. 600, then:
$threshold = apply_filters( 'rocket_lazyload_threshold', 300 ); // → 600
```

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

### wprlm_install_bootstrap()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/wp-rocket-license-manager.md

Copies the bundled bootstrap into wp-content/mu-plugins/, refusing to overwrite a foreign file that does not contain WPRLM_BOOTSTRAP_MARKER. Returns true on success or a WP_Error with codes missing_source, mkdir_failed, bootstrap_conflict, or copy_failed.

```php
function wprlm_install_bootstrap() {
	$paths = wprlm_get_bootstrap_paths();

	if ( ! is_readable( $paths['source'] ) ) {
		return new WP_Error( 'missing_source', 'The bundled MU bootstrap file is missing.' );
	}

	if ( ! is_dir( WPMU_PLUGIN_DIR ) && ! wp_mkdir_p( WPMU_PLUGIN_DIR ) ) {
		return new WP_Error( 'mkdir_failed', 'WordPress could not create the mu-plugins directory.' );
	}

	if ( file_exists( $paths['target'] ) ) {
		$existing = file_get_contents( $paths['target'] );
		if ( false === $existing || false === strpos( $existing, WPRLM_BOOTSTRAP_MARKER ) ) {
			return new WP_Error( 'bootstrap_conflict', 'A different file already uses the MU bootstrap filename.' );
		}
	}

	if ( ! copy( $paths['source'], $paths['target'] ) ) {
		return new WP_Error( 'copy_failed', 'WordPress could not install the MU bootstrap. Check wp-content/mu-plugins permissions.' );
	}

	return true;
}
```

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

### maybe_redirect_after_activation()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/class-wp-rocket-update-notification-recovery.md

On admin_init (priority 2), redirects the activating admin to the Plugins screen with rocket_force_update=1 once. Terminates with exit after wp_safe_redirect.

```APIDOC
## maybe_redirect_after_activation()

### Description
On admin_init (priority 2), redirects the activating admin to the Plugins screen with rocket_force_update=1 once. Terminates with exit after wp_safe_redirect.

### Method
maybe_redirect_after_activation()

### Signature
```php
public static function maybe_redirect_after_activation()
```

### Parameters
None

### Return Value
void

### Behavior
- Checks if current user can update_plugins and not doing AJAX.
- If activation redirect transient exists, deletes it and redirects to the Plugins page with the force query parameter.
- Terminates with exit after redirect.
```

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

### Get stored credentials with wprlm_get_credentials()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/wp-rocket-license-manager.md

Reads helper-stored credentials from the WPRLM_CREDENTIALS_OPTION option. Returns an array with 'key' and 'email' strings, using empty strings when unset or not strings.

```php
function wprlm_get_credentials() {
	$credentials = get_option( WPRLM_CREDENTIALS_OPTION, [] );
	if ( ! is_array( $credentials ) ) {
		$credentials = [];
	}
	return [
		'key'   => isset( $credentials['key'] ) && is_string( $credentials['key'] ) ? $credentials['key'] : '',
		'email' => isset( $credentials['email'] ) && is_string( $credentials['email'] ) ? $credentials['email'] : '',
	];
}
```

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

### Add plugin action link with wprlm_add_plugin_action_links()

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/wp-rocket-license-manager.md

Prepends a "Settings" link to the plugin action links. Hooks into the plugin_action_links_{plugin_basename} filter. Returns the modified $links array.

```php
function wprlm_add_plugin_action_links( $links ) {
	array_unshift(
		$links,
		'<a href="' . esc_url( admin_url( 'options-general.php?page=' . WPRLM_PAGE_SLUG ) ) . '">Settings</a>'
	);
	return $links;
}
add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), 'wprlm_add_plugin_action_links' );
```

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

### Check dynamic cookie filter return value

Source: https://github.com/wp-media/wp-rocket-helpers/blob/master/_autodocs/api-reference/cache.md

Example showing how to call the rocket_cache_dynamic_cookies filter to see the resulting array, which includes the defined cookie and any added by WP Rocket.

```php
$cookies = apply_filters( 'rocket_cache_dynamic_cookies', [] );
// → [ 'your-cookie-id-here' ] (plus anything WP Rocket added)
```
Tokens:
Raw