Breeze is a powerful caching plugin by Cloudways built to optimize your WordPress applications and reduce the website load time. It is fully compatible with WooCommerce and Multisite applications as well. Breeze is a free and lightweight plugin offering top-notch caching performance and equipped with the best features set, including:

  • Built-in Varnish server-level caching support.

  • CDN integration support.

  • Gzip compression

  • File-level caching

  • Browser caching

  • Code minification and combination

  • Database optimization

  • Control to exclude particular URLs, JS files, and CSS files from caching.

All in all, Breeze is a complete package to improve the user experience of your website.

Breeze plugin is pre-installed and configured with default settings on Cloudways-optimized WordPress and WooCommerce applications. Breeze settings are highly customizable, but the default settings also work best and provide optimal performance.

In the first part of this guide, we will show how to install the Breeze plugin if you don't have it installed on your application. In the second part of this guide, we will go over all the settings of the Breeze plugin and configure it.

How to Install Breeze Plugin

Log in to your WordPress application using your credentials. Your application login credentials are available on the Cloudways Platform.

  1. Go to Plugins > Add New.

Important

We don't recommend using any other caching plugin while Breeze is active to avoid any conflict.

2. Search for the Breeze plugin.

3. Next, click Install.

4. Finally, click Activate.

That's it! The Breeze plugin is successfully installed and activated.

How to Configure Breeze Plugin

As mentioned earlier, all settings are pre-configured with Cloudways-optimized WordPress applications; however, the information mentioned in this section can be useful to you to verify existing settings and configure Breeze if you just installed it.

First of all, navigate to Breeze settings by clicking Settings > Breeze.

Basic Options

On the Breeze settings page, you will see a few tabs. The Basic options tab will be open by default.

Purge cache is set to 1440 minutes (24 hours) by default. If you wish, you can change this duration to suit your cache purge requirements.

For Minification, it is recommended to keep it unchecked unless it’s necessary. We recommend you test it first on your staging website before using it on your live site.

We advise that you keep the GZIP Compression option enabled. However, you can uncheck this option if you have already enabled GZIP compression on the server through other means, such as via the .htaccess file.

Advanced Options (Optional)

For many users, the options in this tab do not require any configuration, and we suggest that all sub-options should be left unchanged. However, in case you wish to modify these options, here is the explanation for the options:

  • You may want to exclude specific URLs from the plugin’s cache. If that is the case, you can add them in the Never Cache these URLs field. (Note: If Varnish is enabled on your Cloudways Platform, we suggest excluding the URLs from the Varnish as well. Check this KB for details).

  • If you are using minification, you may select CSS and/or JS under the Group Files option to combine your CSS/JS files into a single file.

  • You may also want to exclude certain CSS and JS from minification and grouping. You can add them in separate fields to exclude your CSS/JS files, as shown in the screenshot below.

Query Strings Caching

The query string is a part of a link (in other words, URL) attached at its end. It assigns the values to the defined set of parameters that helps to identify particular actions or content based on the data being passed.

Here is an example of a typical link containing a query string. In this example, the question mark (?) separates the base URL from the query strings. "name" is a parameter, and "foo" is the value.

http://example.com/page/?name=foo

Ignored Query Strings

Breeze does not cache query strings by default. Therefore, it ignores the links with query string and serves the standard cache file for all the parameters available below:

URL 1: example.com/services/?utm_medium=socialmedia
URL 2: example.com/services/?utm_medium=blog

Here, both URLs will receive one standard caching file, such as:
example.com/services/

Description

Query Strings

Google Analytics and Ads

  • utm_source

  • utm_medium

  • utm_campaign

  • utm_expid

  • utm_term

  • utm_content

  • campaignid

  • adgroupid

  • adid

  • gclid

  • _ga

Matomo

  • mtm_medium

  • mtm_campaign

  • mtm_keyword

  • mtm_cid

  • mtm_content

Piwik Pro

  • pk_source

  • pk_medium

  • pk_campaign

  • pk_keyword

  • pk_cid

  • pk_content

Facebook

  • fb_action_ids

  • fb_action_types

  • fb_source

  • fbclid

Age Verify Plugin

  • age-verified

Autoptimize

  • ao_noptimize

AMP

  • usqp

Cookie Notice

  • cn-reloaded

ShareASale

  • sscid

Google DoubleClick

  • gclsrc

Google Web Stories

  • _gl

Mailchimp

  • mc_cid

  • mc_eid

Bronto

  • _bta_tid

  • _bta_c

Listrak

  • trk_contact

  • trk_msg

  • trk_module

  • trk_sid

GoDataFeed

  • gdfms

  • gdftrk

  • gdffi

Klaviyo

  • _ke

Springbot

  • redirect_log_mongo_id

  • redirect_mongo_id

  • sb_referer_host

Marin

  • mkwid

  • pcrid

Adobe Advertising Cloud

  • ef_id

Adobe Analytics

  • s_kwcid

Microsoft Advertising

  • msclkid

Dotdigital

  • dm_i

Pinterest

  • epik

  • pp

Include Query Strings in Caching

If you want to enable caching for a few specific query strings, you need to define those in the Cache Query Strings available under the Advanced Options.

For instance, you wish to cache the "country" query string.

http://example.com/page/?country=germany

Here, "country" is the parameter, and "germany" is its value. Therefore, in Cache Query Strings, add "country".

Breeze will generate a dedicated cache file against each value the parameter country receives in a URL. If multiple parameters in a URL with at least one of your defined parameters is present, the page will be cached.

Dedicated Caching for Few Query Strings

Breeze serves a dedicated cache file for the following query string parameters.

  • lang

  • permalink_name

  • lp-variation-id

URL 1: example.com/services/?lang=english
URL 2: example.com/about-us/?lang=german

Here, both URLs will have dedicated caching file for their parameter/value pairs:
?lang=english
?lang=german

Database Optimization

Options discussed below can be set according to your requirements. For example, you can decide which type of content needs to be cleared from your WordPress database to keep it optimized.

Database optimization options include Post revisions, Auto drafted content, trashed content, comments from trash and spam, trackbacks and pingbacks, and transients. These options will keep unnecessary data off your application database, decreasing the database size and improving overall website performance.

CDN (Optional)

Breeze WordPress Cache Plugin allows you to configure a CDN with your website. The following options are available for configuration:

  • CDN Root URL: Here, you can specify the URL of CDN that you are using or planning to use with your WordPress website. If you have some pages on HTTP and some on HTTPS, you should begin the URL with a double slash ‘//’ (e.g.,//www.cdnurl.com).

  • CDN Content: Here, you enter the subdirectories for which you wish CDN to serve content.

  • Exclude Content: If you want to exclude content (static content such as CSS/JS/images) from CDN, you can list them in this field.

  • Relative Path: We recommend that you keep this option enabled. This will enable the relative path for your website.

Varnish Options

The last tab that you can configure is Varnish. By default, Varnish is enabled on all fresh WordPress deployments. To manage Varnish settings, please refer to this guide. We recommend that you keep the Auto Purge Varnish option enabled at all times. You can also manually purge Varnish, as shown below.

Settings Import/Export

You can import and export your Breeze configurations using the WordPress Admin Panel or WordPress Command Line Interface (CLI).

WordPress Admin Panel

Export Configurations

If you want to export your Breeze settings, click Export JSON. The configurations will be downloaded in a .json file on your local computer.

Import Configurations

Similarly, if you already have Breeze settings in the .json file, you can import them by clicking Select JSON File and navigating to the file available on your local computer. Next, click Save Changes.

WordPress CLI

You can also import and export Breeze settings using the WordPress Command Line Interface (CLI).

Export Configurations

First of all, connect to your server remotely using SSH.

To export your Breeze configurations, execute the following command. The configurations will be downloaded in a .json file at the default path "wp-content/uploads/breeze-export".

wp breeze export

You can also define the path where you want the breeze configurations to be exported by adding an extra parameter "--file-path". Be sure to replace your_export_path with the desired path.

wp breeze export --file-path=your_export_path

If you are using a WordPress Multisite and want to export your Breeze configurations of the network or specific subsite, you can execute the following command. But, first, be sure to replace your_parameter with the correct parameter defined below.

wp breeze export --level=your_parameter

Parameters

  • --level=network — It will export the Breeze configurations found in the Multisite network.

  • --level=1 or --level=2 (and so on…) — It will export the Breeze configurations of the specific subsite with the defined ID.

  • --file-path=your_export_path — It will allow you to define the path where you want the breeze configurations to be exported.

When the file is successfully exported, you can also download it to your local computer using SFTP.

Import Configurations

Similarly, if you already have Breeze settings in the .json file, you can first upload it to your server using SFTP and import it using the following command. Again, make sure to replace your_export_path with the correct file path. You can also use any external path (valid URL) outside your server to import configurations.

wp breeze import --file-path=your_export_path

If you use a WordPress Multisite and want to import your Breeze configurations for the network or specific subsite, you can execute the following command. But, first, be sure to replace your_parameter with the correct parameter defined below.

wp breeze import --level=your_parameter --file-path=your_export_path

Parameters

  • --level=network — It will export the Breeze configurations found in the Multisite network.

  • --level=1 or --level=2 (and so on…) — It will export the Breeze configurations of the specific subsite with the defined ID.

  • --file-path=your_export_path — It will allow you to define the path where you want the breeze configurations to be exported. You can also use any external path (valid URL) outside your server to import configurations.

Purge Breeze Cache

By default, Breeze WordPress Cache Plugin purges cache (including plugin's internal and Varnish cache) after one day (you can change this value in Basic Options).

WordPress Admin Panel

If you want to purge the plugin’s internal and varnish cache manually, you can do so from the Breeze tab in the top bar, as shown below.

WordPress CLI

You can also purge the Breeze cache using the WordPress Command Line Interface (CLI).

First of all, connect to your server remotely using SSH.

To purge the Breeze cache, execute the following command. Be sure to replace your_parameter with the correct parameter defined below.

wp breeze purge --cache=your_parameter

Parameters

  • --cache=all — It will purge the plugin's internal and Varnish cache.

  • --cache=varnish — It will only purge the Varnish cache.

  • --cache=local — It will only purge the plugin's internal cache.

If you are using a WordPress Multisite and want to purge the Breeze cache of the network or specific subsite, you can execute the following command. But, first, be sure to replace your_parameter with the correct parameter defined below.

wp breeze purge --cache=your_parameter --level=your_parameter

Parameters

  • --cache=all — It will purge the plugin's internal and Varnish cache.

  • --cache=varnish — It will only purge the plugin's internal and Varnish cache.

  • --cache=local — It will only purge the plugin's internal cache.

  • --level=network — It will purge the Breeze cache of the Multisite network.

  • --level=1 or --level=2 (and so on…) — It will purge the Breeze cache of the specific subsite with the defined ID.

Breeze WordPress CLI Help Command

The following command allows you to explore all the options available for Breeze Management in the WordPress CLI.

wp breeze help

That’s it! We hope this tutorial was helpful. If you need any help, then feel free to search your query on Cloudways Support Center or contact us via chat (Need a Hand > Send us a Message). Alternatively, you can also create a support ticket.

Did this answer your question?