Cloudimage - Documentation

Accounts created before Nov. 1st, 2021

Accounts created before November 1, 2021 have to include /v7/ in the path, like shown below.

//token.cloudimg.io/v7/original_image_url?operations&filters

Accounts created on or after November 1, 2021 do not require /v7/ and documentation have been updated accordingly.
To verify the type of configuration on your Cloudimage account, log in to your Cloudimage admin panel and look at the syntax provided on the Welcome page.

[NOTE] If you are an existing Cloudimage customer and wish to be able to remove the v7 from your URL syntax, please contact our support.

Cloudimage Wordpress Plugin

The Cloudimage Wordpress plugin will automatically adapt the image URLs in your Wordpress site to deliver your images rocket fast over Cloudimage. You only need to register with Cloudimage and install the plugin in your Wordpress site.

If you need to adjust the behaviour of the plugin, please see the Advanced settings.

Step 1 - Create an account if you have not registered already.

You can create an account on the Cloudimage registration page.

Photo alt \#responsive

Step 2 - Log in to your Wordpress admin panel

Step 3 - On the Admin sidebar, navigate to Plugins > Add New.

Step 4 - Enter "Cloudimage" in the search field and then install our plugin

Step 5 - Activate the installed plugin

Step 6 - Navigate to the Cloudimage admin page

Configurations

You need to enter your Cloudimage account token which you have received upon account creation (step 1).

Photo alt \#responsive

Photo alt \#responsive

The v7 option

Photo alt \#responsive

  • Some tokens are associated with a v7 URL, while others are not.
  • But not to worry, this plugin automatically checks and sets it for you, all within a few seconds.
  • Eg: If you enter a v7 token into the text input field, then a few seconds later, the v7 dial will automatically turn itself on.
  • Please be patient and wait for the “The v7 checking process …” message to disappear, before pressing the “SAVE ALL CHANGES“ button.

The JS Mode option

Without Cloudimage

Your image URL will be like this:

<img 
  class="alignnone size-medium wp-image-437" 
  src="http://wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats-201x300.jpeg" 
  alt="" 
  width="201" 
  height="300" 
  srcset="https://wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats-201x300.jpeg 201w, 
          https://wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats-600x894.jpeg 600w, 
          https://wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg 644w" 
  sizes="(max-width: 201px) 100vw, 201px"
>

With Cloudimage

<img 
  class="alignnone size-medium wp-image-440" 
  src="https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?func=bound&amp;w=300&amp;h=300" 
  alt="" 
  width="300" 
  height="300" 
  srcset="https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=150 150w, 
          https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=450 450w, 
          https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=100 100w
  sizes="(max-width: 300px) 100vw, 300px"
>

With Cloudimage and its JavaScript Mode turned on

Photo alt \#responsive

<img 
  class="alignnone size-medium wp-image-440 ci-image ci-image-loaded lazyloaded" 
  ci-src="https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?func=bound&amp;w=300&amp;h=300" 
  alt="" 
  data-srcset="https://token.cloudimg.io/https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=300&amp;org_if_sml=1&amp;func=bound 1x, 
               https://token.cloudimg.io/https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=450&amp;org_if_sml=1&amp;func=bound 1.5x, 
               https://token.cloudimg.io/https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=600&amp;org_if_sml=1&amp;func=bound 2x" 
  data-src="https://token.cloudimg.io/https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=300&amp;org_if_sml=1&amp;func=bound" 
  srcset="https://token.cloudimg.io/https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=300&amp;org_if_sml=1&amp;func=bound 1x, 
          https://token.cloudimg.io/https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=450&amp;org_if_sml=1&amp;func=bound 1.5x, 
          https://token.cloudimg.io/https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=600&amp;org_if_sml=1&amp;func=bound 2x" 
  src="https://token.cloudimg.io/https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=300&amp;org_if_sml=1&amp;func=bound"
>

With JS Mode turned on, Cloudimage will:

With JS Mode off and these srcset advanced settings

Photo alt \#responsive

<img 
  class="alignnone size-medium wp-image-440" 
  src="https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?func=bound&amp;w=300&amp;h=300" 
  alt="" 
  width="300" 
  height="300" 
  srcset="https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=150 150w, 
          https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=450 450w, 
          https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=100 100w, 
          https://token.cloudimg.io/wp.sandbox.sfxconnector.com/wp-content/uploads/catswillbecats.jpeg?w=666 666w"
  sizes="(max-width: 300px) 100vw, 300px"
>
  • Notice the 666 in the srcset

When to use JS Mode and when it’s better not used

Photo alt \#responsive

The login option

With this turned on, Cloudimage will only take effect when the user is logged in

Localhost

Please note that Cloudimage will not take effect on localhosts

Advanced Configurations

Global

Disable image downsize filter

ON: disable WordPress’s default image-cropping functionality

Standard Mode

Enable srcset adding

If this is turned off, then “Srcset widths“ will have no effect.

srcset widths (px)

Add more sizes to srcset

Replaceable text

For example
Cloudimage URL: token.cloudimg.io/mywebsite/wp-uploads/2020/image.png Replaceable text: wp-uploads/2020 Replacement text: upload

Then from frontend users will see the image URL as: token.cloudimg.io/mywebsite/upload/image.png

But we need to configure aliases (https://docs.cloudimage.io/go/cloudimage-documentation-v7/en/domains-urls/aliases#529b15ac9a0a51a57837cd9db395aa3311e8434c) in Cloudimage admin and set up the alias upload with value wp-uploads/2020

Replacement text

(See above)

JavaScript mode

Skip classes

Exclude Cloudimage processing by class name

Skip files

Exclude Cloudimage processing by file type, eg “.gif“

Use WordPress filter method

OFF: use ob_buffer PHP function

ON: use the_content filter from WordPress.

Local JavaScript libraries

ON: use Cloudimage JS files from CDN

OFF: use Cloudimage JS files from plugin locally

Ignore image node size

Can become helpful to turn on when using non-standard WordPress themes. Especially for badly-made themes, to compensate for some adverse impact on images.

Save image node ratio

(See above)

Ignore style image size

(See above)

Destroy node image size

(See above)

Detect image node css

(See above)

Process only width

(See above)

Disable setTimeout checks

Better to turn this on when there are AJAX loaded images, so that the late-loaded images don’t miss out on Cloudimage processing