Switch branches/tags
Nothing to show
Clone or download
wladston Merge pull request #37 from t-wright/master
Add conditional to replace background image urls
Latest commit 3cc0fa1 Jun 20, 2018

README.md

Images via imgix

Scrutinizer Code Quality Build Status

A community powered WordPress plugin to automatically load all your existing (and future) WordPress images via the imgix service for smaller, faster, and better looking images.

Features

  • Your images behind a CDN.
  • Automatically smaller and faster images with the Auto Format option.
  • Automatically better looking images with the Auto Enhance option.
  • Use arbitrary imgix API params when editing <img> tags in "Text mode" and they will pass through.
  • No lock in! Disable the plugin and your images will be served as they were before installation.

Getting Started

  1. If you don't already have an imgix account then sign up at imgix.com.

  2. Create a Web Folder imgix source with the Base URL set to your WordPress root URL (without the wp-content part). For example, if your WordPress instance is at http://example.com and an example image is http://example.com/wp-content/uploads/2017/01/image.jpg then your source's Base URL would be just http://example.com/.

  3. Download the imgix WordPress plugin imgix_plugin.zip and install on your WordPress instance. In the WordPress admin, click "Plugins" on the right and then "Add New". This will take you to a page to upload the imgix_plugin.zip file. Alternatively, you can extract the contents of imgix_plugin.zip into the wp-content/plugins directory of your WordPress instance.

  4. Return to the "Plugins" page and ensure the "imgix plugin" is activated. Once activated, click the "settings" link and populate the "imgix Host" field (e.g., http://yourcompany.imgix.net). This is the full host of the imgix source you created in step #1. Optionally, you can also turn on Auto Format or Auto Enhance. Finally, click "Save Options" when you're done.

  5. Go to a post on your WordPress blog and ensure your images are now serving through imgix.

History

Originally this plugin was hosted as part of the official imgix organisation. It was depreciated as they focused their efforts on the PHP library.

This plugin is maintained and managed by the community. Imgix have kindly permitted the use of their name here but it should be noted that there is no official support available for this plugin. If you've got any problems submit an issue on this repo.

Testing

This plugin uses phpunit to run its tests. You will need to set up a local test database to run these tests. You can do that using the bootstrap script:

$ bin/install-wp-tests.sh imgix_wordpress_tests <YOUR MYSQL USERNAME> <YOUR MYSQL PASSWORD>

Then running the tests is as simple as:

$ phpunit

Testing with Docker

This plugin uses phpunit to run its tests. You can use Docker if you don't want to set up the test database locally.

Start the database:

$ docker-compose up -d mysql

Then running the tests is as simple as:

$ docker-compose up phpunit