A Wordpress plugin to use picturefill.js to load responsive/retina images, mimicking the proposed HTML5 picture spec.

christhewanderer

Picture Element Responsive and Retina Images

A plugin that helps you generate a picture element for creating responsive images. Retina support is included out of the box.

kylereicks

<p><strong>Note: This is an implementation of <a href="https://github.com/scottjehl/picturefill/tree/1.2" rel="nofollow ugc">Picturefill.js version 1.2.x</a>. For an implementation of <a href="http://scottjehl.github.io/picturefill/" rel="nofollow ugc">Picturefill.js 2.x</a>, see the <a href="https://github.com/kylereicks/picturefill.js.wp/tree/master" rel="nofollow ugc">master branch of the GitHub repository</a>.</strong></p>
<p>Picturefill.WP is a simple and option-less plugin to serve HDPI and responsive images on a WordPress website.</p>
<p>This plugin parses post and page content replacing images with a special syntax similar to the proposed syntax for the HTML5 <code>picture</code> element, then uses an adapted version of <a href="https://github.com/scottjehl/picturefill" rel="nofollow ugc">picturefill.js</a> to load the appropriate image to the browser.</p>
<h3>Considerations before installing</h3>
<h4>Slow Loading on Activation</h4>
<p>The first time a page or post is loaded after activating Picturefill.WP, new <code>@2x</code> size images will need to be created for the images in the post or page content. This can take several seconds and will take longer on image heavy posts. Once these images are created, posts should load at least as fast or faster than they do without the plugin.</p>
<p>If you are installing Picturefill.WP on a large and image heavy site, you may want to consider using another plugin like <a href="https://wordpress.org/plugins/regenerate-thumbnails/" rel="ugc">Regenerate Thumbnails</a> to create the new image sizes for existing posts and pages.</p>
<h4>500 or 504 server errors</h4>
<p>These errors are related to the slow loading listed above. If the server reaches its timeout limit before it is finished processing new images, it will return a 500 or 504 error. Refreshing the page usually gives the server the time it needs to finish processing the images. On some image-heavy posts, it may take more than one refresh.</p>
<h4>Image Sizes</h4>
<p>By default, WordPress creates as many as 3 images of different sizes for each uploaded image (“large”, “medium”, and “thumbnail”), in addition to the “full” image size.</p>
<p>This plugin adds responsive breakpoints based on the width of the image. The largest available image will display unless the browser width is less than the image width + 20px, in which case the next size down is displayed.</p>
<p>To use this plugin most effectively, set the default image sizes (“large”, “medium”, and “thumbnail”) to reflect useful breakpoints in your theme design.</p>
<h4>Errors and Warnings</h4>
<p>As of version 1.3.3 Picturefill.WP suppresses errors and warnings in parsing the DOM. Errors and warnings can now be collected via the <code>picturefill_wp_syntax_present_libxml_errors</code> and <code>picturefill_wp_get_images_libxml_errors</code> filters.</p>
<pre><code>add_filter('picturefill_wp_get_images_libxml_errors', 'handle_errors');

function handle_errors($errors){
  foreach($errors as $error){
    // Handle errors here.
  }
}
</code></pre>
<h4>Theme CSS</h4>
<p>As described in the <a href="https://wordpress.org/plugins/picturefillwp/other_notes/" rel="ugc">Details section</a>, the picturefill.js syntax uses nested <code>span</code> elements. If a theme’s CSS applies styles to un-classed <code>span</code> elements, you may notice some of these <code>span</code>s showing up unexpectedly on the page after activating Picturefill.WP. If possible, it is best to remove the offending code from your theme files, but adding the flowing to the bottom of your theme’s CSS file should also work to reset these styles.</p>
<pre><code>span[data-picture]{display:inline;margin:0;padding:0;border:0;}
span[data-picture] span{display:inline;margin:0;padding:0;border:0;}
</code></pre>
<h4>Caching</h4>
<p>To improve performance, especially in image heavy posts, Picturefill.WP uses transient caching. The cache will be refreshed automatically every time a post is updated or Picturefill.WP is updated. The cache can be manually refreshed by deactivating and reactivating Picturefill.WP from the plugins menu.</p>
<p>If you suspect that Picturefill.WP’s caching is causing trouble with another plugin or theme feature, first try deactivating and reactivating Picturefill.WP. If problems persist, try lowering the priority for Picturefill.WP to be executed by adding the following to your functions.php file:</p>
<pre><code>remove_filter('the_content', array(Picturefill_WP::get_instance(), 'apply_picturefill_wp_to_the_content'), 11);
add_filter('the_content', array(Picturefill_WP::get_instance(), 'cache_picturefill_output'), 9999);
</code></pre>
<p>If you still encounter problems with other plugins or theme features, you may want to disable caching all together. See the subsection on how to disable caching under the “Extending Picturefill.WP” section of the <a href="https://github.com/kylereicks/picturefill.js.wp" rel="nofollow ugc">GitHub repository</a>.</p>
<h3>Details</h3>
<p>Picturefill.WP looks through <code>the_content</code> to find <code><img></code> elements like this:</p>
<pre><code><img class="alignnone size-large wp-image-123" alt="Accessible alternate text for the image" title="A title that displays on hover" src="http://sitename.com/wp-content/uploads/2013/4/image-770x577.jpg" width="770" height="577" />
</code></pre>
<p>then replaces them with something like this (visit the <a href="https://github.com/kylereicks/picturefill.js.wp#details" rel="nofollow ugc">GitHub repository</a> for a breakdown of the syntax):</p>
<pre><code><span data-picture data-class="alignnone size-large wp-image-123" dat-alt="Accessible alternate text for the image" data-title="A title that displays on hover" data-width="770" data-height="577">
  <span data-src="http://sitename.com/wp-content/uploads/2013/4/image-770x577.jpg"></span>
  <span data-src="http://sitename.com/wp-content/uploads/2013/4/image-150x150.jpg" data-width="150" data-height="150" data-media="(min-width: 1px)" class="picturefill-wp-source thumbnail"></span>
  <span data-src="http://sitename.com/wp-content/uploads/2013/4/image-300x300.jpg" data-width="150" data-height="150" data-media="(min-width: 1px) and (-webkit-min-device-pixel-ratio: 1.5),(min-resolution: 144dpi),(min-resolution: 1.5dppx)" class="picturefill-wp-source retina thumbnail"></span>
  <span data-src="http://sitename.com/wp-content/uploads/2013/4/image-400x300.jpg" data-width="400" data-height="300" data-media="(min-width: 420px)" class="picturefill-wp-source medium"></span>
  <span data-src="http://sitename.com/wp-content/uploads/2013/4/image-800x600.jpg" data-width="400" data-height="300" data-media="(min-width: 420px) and (-webkit-min-device-pixel-ratio: 1.5),(min-resolution: 144dpi),(min-resolution: 1.5dppx)" class="picturefill-wp-source retina medium"></span>
  <span data-src="http://sitename.com/wp-content/uploads/2013/4/image-770x577.jpg" data-width="770" data-height="577" data-media="(min-width: 790px)" class="picturefill-wp-source large"></span>
  <span data-src="http://sitename.com/wp-content/uploads/2013/4/image-1540x1155.jpg" data-width="770" data-height="577" data-media="(min-width: 790px) and (-webkit-min-device-pixel-ratio: 1.5),(min-resolution: 144dpi),(min-resolution: 1.5dppx)" class="picturefill-wp-source retina large"></span>
  <noscript>
    <img class="alignnone size-large wp-image-123" alt="Accessible alternate text for the image" title="A title that displays on hover" src="http://sitename.com/wp-content/uploads/2013/4/image-770x577.jpg" width="770" height="577" />
  </noscript>
</span>
</code></pre>
<p>The adapted version of picturefill.js then looks for the last <code>data-src</code> listed where the associated <code>data-media</code> matches the device and browser, and loads the appropriate image inside the matched <code><span></code> element.</p>
<h3>Extending Picturefill.WP</h3>
<p>See the <a href="https://github.com/kylereicks/picturefill.js.wp#extending-picturefillwp" rel="nofollow ugc">Extending Picturefill.WP</a> subsection of the GitHub repository for a list of plugin hooks and examples.</p>
<h3>Advanced Use</h3>
<h3>Markup Tricks</h3>
<h4>Limit Responsiveness</h4>
<p>The responsiveness of an image can be limited by adding the class <code>min-size-{image size}</code>. For example, an image with the class <code>min-size-medium</code> will not load an image smaller than size <code>medium</code>.</p>
<h4>Skip Images</h4>
<p>To skip images and load them normally add the attribute <code>data-picturefill-wp-ignore</code> to the <code><img></code> tag.</p>
<h3>Helper Functions</h3>
<p>See the <a href="https://github.com/kylereicks/picturefill.js.wp#helper-functions" rel="nofollow ugc">helper functions</a> section of the documentation on GitHub.</p>


Alternatives to Picturefill.WP

Top alternatives