https://github.com/alexmacarthur/picperf-wordpress

WordPress plugin for upgrading your images with PicPerf.io.
https://github.com/alexmacarthur/picperf-wordpress

image-processing performance seo

Last synced: 2 months ago
JSON representation

WordPress plugin for upgrading your images with PicPerf.io.

• Host: GitHub
• URL: https://github.com/alexmacarthur/picperf-wordpress
• Owner: alexmacarthur
• Created: 2023-06-22T04:23:25.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-07-16T00:10:02.000Z (5 months ago)
• Last Synced: 2024-07-17T03:43:59.299Z (5 months ago)
• Topics: image-processing, performance, seo
• Language: PHP
• Homepage: https://picperf.dev
• Size: 153 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PicPerf WordPress Plugin

[PicPerf](http://picperf.io) is a service for automatically optimizing, reformating, and aggressively caching your website's images just by prefixing the URLs you're already using. This WordPress plugin will take care of that part too, making it even easier to upgrade your image performance.

## Getting Started

1. Create an account.

In order to benefit from this plugin, you'll need to first sign up for a plan at [picperf.io](https://picperf.io). You'll automatically be given a 14-day free trial (no card required), but in order keep your images optimized beyond that, upgrade to a regular plan.

1. 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, please add both domains.

## Installation

After you've created an account and added your domain, all you need to do is install the plugin and activate it. You're set!

## Usage

This plugin will automatically prefix every URL found in images, style tags, inline styles, and data attributes with `https://picperf.io`, allowing it to be optimized, reformatted, and globally cached. By default, it'll impact every image that's rendered in the final HTML output of your page.

### Changing Transformation Scope

If you'd like to disable universal URL transformations, you can set the `PICPERF_TRANSFORMATION_SCOPE` constant in your `wp-config.php` file to `null`. Setting it to `CONTENT` will cause only images rendered via the `the_content` filter to be transformed. For example:

```php

// Transform all images (default).

define('PICPERF_TRANSFORMATION_SCOPE', 'ALL');

// Only transform `the_content` images.

define('PICPERF_TRANSFORMATION_SCOPE', 'CONTENT');

// Transform no images.

define('PICPERF_TRANSFORMATION_SCOPE', null);

```

### Using an Auto-Generated Image Sitemap

When a `sitemap_path` query parameter is set on an image, PicPerf will automatically include it in an image sitemap generated for you. By default, no images are included in the sitemap. However, you can enable this by setting the `PICPERF_ADD_SITEMAP_PATH` constant.

You

```php

` tag to the `` of your pages.

All this endpoint does is proxy the auto-generated sitemap provided at `https://picperf.io/sitemap/ur-site.com`. The benefit is that search engines will be able to crawl and index it, since it'll be available through your domain (as set returned by the `get_site_url()` function).

If you'd like to disable this endpoint, set the `PICPERF_DISABLE_SITEMAP` to `true`.

```php