Skip to content

raisinli/imgix-wordpress

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

imgix logo

Build Status

imgix-wordpress

A WordPress plugin to automatically use your existing (and future) WordPress images via imgix 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 serve as they did before installation.

Getting Started

Screencast

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

  1. 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://students.miguelcardona.com and an example image is http://students.miguelcardona.com/wp-content/uploads/2013/01/beat.jpg then your source's Base URL would be just http://students.miguelcardona.com/.

  2. 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.

  3. 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.

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

Updates

If you find bugs or have a feature request please open a github issue. Thanks!

Testing

This plugin uses a Docker container and phpunit to run its tests.

Why Docker? Wordpress requires a database to start, and constantly creating a clean state environment on subsequent test runs can be a bit of a chore. Setting up the database environment is also different depending on the host OS. We defer to Docker to encapsulate that logic.

Here’s how to run the tests:

$ export WP_VERSION=latest # Or the specific version of WordPress you'd like to target
$ docker build -t imgix-wordpress:latest .
$ docker run imgix-wordpress:latest /bin/sh -c "/etc/init.d/mysql start && bash bin/install-wp-tests.sh wordpress_test root '' localhost:3306 $WP_VERSION && phpunit"

About

The official imgix WordPress plugin

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 87.5%
  • Shell 9.8%
  • JavaScript 2.7%