Integrating with WordPress

The official PicPerf WordPress plugin is a stupid-easy way to make your website’s images faster, lighter, and more SEO-friendly.

Getting Started

Before installing the plugin, you’ll need to do the following:

1. Create an account.

In order to benefit from this plugin, you’ll need to first create an account at app.picperf.io. You’ll automatically be given a 14-day free trial, but in order keep your images optimized beyond that, upgrade to a regular plan.

2. Add your domain.

Add your website’s domain inside the PicPerf dashboard. If your WordPress site runs on a different domain from your public website, you’ll need to add both domains.

Installation & Activation

After creating an account and adding a domain, download the plugin here. Then, install it in the WordPress admin plugin page by uploading the .zip file you just downloaded.

After it’s successfully installed, activate it.

Using Composer?

To install the PicPerf WordPress plugin with Composer, make sure the composer/installers package is installed in your project:

  "require": {
    "composer/installers": "^2.2"
  },

In addition, you’ll need to set your install-paths property, so the plugin is installed where your WordPress plugins live:

  "extra": {
    "installer-paths": {
      "wp-content/plugins/{$name}/": [
        "type:wordpress-plugin"
      ]
    }
  },

Then, run composer require picperf/wordpress. Activate your newly installed plugin, and you’re set.

What It Does

Once it’s activated, the plugin will automatically prefix every URL found in an image tag with the PicPerf host, allowing it to be optimized, reformatted, and cached.

In its curent version, it only impacts images loaded through WordPress’s the_content filter. Because of this, you’re highly encouraged to manually change image URLs outside this scope. For convenience, you may use the PicPerf/transformUrl() function available globally when the plugin is active:

    $transformedUrl = PicPerf\transformUrl("https://example.com/my-image.jpg");

    // https://picperf.io/https://example.com/my-image.jpg

What If My Subscription is Cancelled?

If paused or cancelled, your images will remain to be prefixed as long as the plugin is active. However, you won’t get any of the optimization benefit. Instead, your images will just pass through as if they’re being served from your own site (with a little bit of extra latency, since they’ll still be getting routed through picperf.io). If you’d like to revert your images and stop using PicPerf, simply deactivate the plugin after removing any PicPerf\transformUrl() calls as described above.

Changelog

• v0.0.1 - Initial verison is released.
• v0.1.0 - Add transformation support for images constructed through the wp_get_attachment_image_attributes filter.
• v0.2.0 - Add transformation support to featured images.
• v0.3.0 - Transform image URLs in <style> tags and style= attributes.