Skip to content

Commit

Permalink
Filter content to add srcset and sizes
Browse files Browse the repository at this point in the history 
This changes our approach from one where `srcset` and `sizes` are written to the
image markup in post content to one where the responsive attributes are added on the
front end when the page is being rendered. There is a small performance hit but the
benefit is worth the tradeoff for what is gained. What exactly do we gain? Glad you
asked:

* Automatically extend support to images in posts published before we responsive image
support was available.
* Removes the need to update the markup in TinyMCE when the image size is changed.
* Keeps `sizes` attributes, which should probably be adjusted based on the needs of the
theme, from being stored in the database.
* Is non-destructive if a site needs to change available image sizes and regenerate
thumbnails.

Changes:

* Removes the old JS code for handling markup changes in TinyMCE
* Adds `tevkori_filter_content_images()` as a display filter.
* Adds `_tevkori_filter_content_images_callback()` to process filtered images.
* Adds tests
  • Loading branch information
@joemcgill
joemcgill committed Sep 22, 2015
1 parent 057bd7b commit 63f5156
Show file tree
Hide file tree
Showing 3 changed files with 184 additions and 136 deletions.
53 changes: 0 additions & 53 deletions js/wp-tevko-responsive-images.js
View file

This file was deleted.

70 changes: 70 additions & 0 deletions tests/test-suite.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -371,4 +371,74 @@ function test_tevkori_filter_attachment_image_attributes_thumbnails() {
$this->assertFalse( isset( $resp_attr['srcset'] ) );
$this->assertFalse( isset( $resp_attr['sizes'] ) );
}

/**
* @group 170
*/
function test_tevkori_filter_content_images() {
// Make image.
$id = $this->_test_img();

$srcset = tevkori_get_srcset_string( $id, 'medium' );
$sizes = tevkori_get_sizes_string( $id, 'medium' );

// Function used to build HTML for the editor.
$img = get_image_tag( $id, '', '', '', 'medium' );
$img_no_size = str_replace( 'size-', '', $img );
$img_no_size_id = str_replace( 'wp-attachment-', '', $img_no_size );

// Manually add srcset and sizes to the markup from get_image_tag();
$respimg = preg_replace('|<img ([^>]+) />|', '<img $1 ' . $srcset . ' ' . $sizes . ' />', $img);
$respimg_no_size = preg_replace('|<img ([^>]+) />|', '<img $1 ' . $srcset . ' ' . $sizes . ' />', $img_no_size);
$respimg_no_size_id = preg_replace('|<img ([^>]+) />|', '<img $1 ' . $srcset . ' ' . $sizes . ' />', $img_no_size_id);

$content = '<p>Welcome to WordPress! This post contains important information. After you read it, you can make it private to hide it from visitors but still have the information handy for future reference.</p>
<p>First things first:</p>
%1$s
<ul>
<li><a href="http://wordpress.org" title="Subscribe to the WordPress mailing list for Release Notifications">Subscribe to the WordPress mailing list for release notifications</a></li>
</ul>
%2$s
<p>As a subscriber, you will receive an email every time an update is available (and only then). This will make it easier to keep your site up to date, and secure from evildoers.<br />
When a new version is released, <a href="http://wordpress.org" title="If you are already logged in, this will take you directly to the Dashboard">log in to the Dashboard</a> and follow the instructions.<br />
Upgrading is a couple of clicks!</p>
%3$s
<p>Then you can start enjoying the WordPress experience:</p>
<ul>
<li>Edit your personal information at <a href="http://wordpress.org" title="Edit settings like your password, your display name and your contact information">Users &#8250; Your Profile</a></li>
<li>Start publishing at <a href="http://wordpress.org" title="Create a new post">Posts &#8250; Add New</a> and at <a href="http://wordpress.org" title="Create a new page">Pages &#8250; Add New</a></li>
<li>Browse and install plugins at <a href="http://wordpress.org" title="Browse and install plugins at the official WordPress repository directly from your Dashboard">Plugins &#8250; Add New</a></li>
<li>Browse and install themes at <a href="http://wordpress.org" title="Browse and install themes at the official WordPress repository directly from your Dashboard">Appearance &#8250; Add New Themes</a></li>
<li>Modify and prettify your website&#8217;s links at <a href="http://wordpress.org" title="For example, select a link structure like: http://example.com/1999/12/post-name">Settings &#8250; Permalinks</a></li>
<li>Import content from another system or WordPress site at <a href="http://wordpress.org" title="WordPress comes with importers for the most common publishing systems">Tools &#8250; Import</a></li>
<li>Find answers to your questions at the <a href="http://wordpress.orgs" title="The official WordPress documentation, maintained by the WordPress community">WordPress Codex</a></li>
</ul>';

$content_unfiltered = sprintf( $content, $img, $img_no_size, $img_no_size_id );
$content_filtered = sprintf( $content, $respimg, $respimg_no_size, $respimg_no_size_id );

$this->assertSame( $content_filtered, tevkori_filter_content_images( $content_unfiltered ) );
}

/**
* @group 170
*/
function test_tevkori_filter_content_images_with_preexisting_srcset() {
// Make image.
$id = $this->_test_img();

// Generate HTML and add a dummy srcset attribute.
$image_html = get_image_tag( $id, '', '', '', 'medium' );
$image_html = preg_replace('|<img ([^>]+) />|', '<img $1 ' . 'srcset="image2x.jpg 2x" />', $image_html );

// The content filter should return the image unchanged.
$this->assertSame( $image_html, tevkori_filter_content_images( $image_html ) );
}

}
197 changes: 114 additions & 83 deletions wp-tevko-responsive-images.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -297,31 +297,130 @@ function tevkori_get_src_sizes( $id, $size = 'thumbnail' ) {
}

/**
* Filter for extending image tag to include srcset attribute.
* Filters images in post content to add `srcset` and `sizes`.
*
* @see images_send_to_editor
* @return string HTML for image.
* @since 3.0
*
* @param string $content The raw post content to be filtered.
* @return string Converted content with `srcset` and `sizes` added to images.
*/
function tevkori_extend_image_tag( $html, $id, $caption, $title, $align, $url, $size, $alt ) {
add_filter( 'editor_max_image_size', 'tevkori_editor_image_size' );
function tevkori_filter_content_images( $content ) {
// Only match images in our uploads directory.
$uploads_dir = wp_upload_dir();
$path_to_upload_dir = $uploads_dir['baseurl'];

// Get the srcset attribute.
$srcset = tevkori_get_srcset_string( $id, $size );
$content = preg_replace_callback( '|<img ([^>]+' . $path_to_upload_dir . '[^>]+)[\s?][\/?]>|i', '_tevkori_filter_content_images_callback', $content );

remove_filter( 'editor_max_image_size', 'tevkori_editor_image_size' );
return $content;
}
add_filter( 'the_content', 'tevkori_filter_content_images', 5, 1 );

if ( $srcset ) {
/**
* Private preg_replace callback used in tevkori_filter_content_images()
*
* @access private
* @since 3.0.0
*/
function _tevkori_filter_content_images_callback( $image ) {
if ( empty( $image ) ) {
return false;
}

// Build the data-sizes attribute if sizes were returned.
$sizes = tevkori_get_sizes( $id, $size );
$sizes = $sizes ? 'data-sizes="' . $sizes . '"' : '';
list( $image_html, $atts ) = $image;
$id = $size = false;

$html = preg_replace( '/(src\s*=\s*"(.+?)")/', '$1 ' . $sizes . ' ' . $srcset, $html );
// Bail early if a `srcset` attribute already exists.
if ( false !== strpos( $atts, 'srcset=' ) ) {
return $image_html;
}

return $html;
// Grab ID and size info from core classes.
if ( preg_match( '/wp-image-([0-9]+)/i', $atts, $class_id ) ) {
(int) $id = $class_id[1];
}
if ( preg_match( '/size-([^\s|"]+)/i', $atts, $class_size ) ) {
$size = $class_size[1];
}

if ( $id && false === $size ) {
preg_match( '/width="([0-9]+)"/', $atts, $width );
preg_match( '/height="([0-9]+)"/', $atts, $height );

$size = array(
(int) $width[1],
(int) $height[1]
);
}

/*
* If attempts to get values for `id` and `size` failed, use the
* src to query for matching values in `_wp_attachment_metadata`
*/
if ( false === $id || false === $size ) {
preg_match( '/src="([^"]+)"/', $atts, $url );

if ( ! $url[1] ) {
return $image_html;
}

$image_filename = basename( $url[1] );

/*
* If we already have an ID, we use it to get the attachment metadata
* using `wp_get_attachment_metadata()`. Otherwise, we'll use the image
* `src` url to query the postmeta table for both the attachement ID and
* metadata, which we'll use later to get the size.
*/
if ( ! empty( $id ) ) {
$meta = wp_get_attachment_metadata( $id );
} else {
global $wpdb;
$meta_object = $wpdb->get_row( $wpdb->prepare(
"SELECT `post_id`, `meta_value` FROM $wpdb->postmeta WHERE `meta_key` = '_wp_attachment_metadata' AND `meta_value` LIKE %s",
'%' . $image_filename . '%'
) );

// If the query is successful, we can determine the ID and size.
if ( is_object( $meta_object ) ) {
$id = $meta_object->post_id;
// Unserialize the meta_value returned in our query.
$meta = maybe_unserialize( $meta_object->meta_value );
} else {
$meta = false;
}
}

/*
* Now that we have the attachment ID and metadata, we can retrieve the
* size by matching the original image's `src` filename with the sizes
* included in the attachment metadata.
*/
if ( $id && $meta ) {
/*
* First, see if the file is the full size image. If not, we loop through
* the itermediate sizes until we find a match.
*/
if ( $image_filename === basename( $meta['file'] ) ) {
$size = 'full';
} else {
foreach( $meta['sizes'] as $image_size => $image_size_data ) {
if ( $image_filename === $image_size_data['file'] ) {
$size = $image_size;
break;
}
}
}
}
}

// If we have an ID and size, try for srcset and sizes and update the markup.
if ( $id && $size && $srcset = tevkori_get_srcset_string( $id, $size ) ) {
$sizes = tevkori_get_sizes_string( $id, $size );
$image_html = "<img " . $atts . " " . $srcset . " " . $sizes . " />";
};

return $image_html;
}
add_filter( 'image_send_to_editor', 'tevkori_extend_image_tag', 0, 8 );

/**
* Filter to add srcset and sizes attributes to post thumbnails and gallery images.
Expand Down Expand Up @@ -351,71 +450,3 @@ function tevkori_filter_attachment_image_attributes( $attr, $attachment, $size )
return $attr;
}
add_filter( 'wp_get_attachment_image_attributes', 'tevkori_filter_attachment_image_attributes', 0, 3 );

/**
* Disable the editor size constraint applied for images in TinyMCE.
*
* @return array A width & height array so large it shouldn't constrain reasonable images.
*/
function tevkori_editor_image_size() {
return array( 99999, 99999 );
}

/**
* Load admin scripts.
*
* @param string $hook Admin page file name.
*/
function tevkori_load_admin_scripts( $hook ) {
if ( $hook == 'post.php' || $hook == 'post-new.php' ) {
wp_enqueue_script( 'wp-tevko-responsive-images', plugin_dir_url( __FILE__ ) . 'js/wp-tevko-responsive-images.js', array( 'wp-backbone' ), '2.0.0', true );
}
}
add_action( 'admin_enqueue_scripts', 'tevkori_load_admin_scripts' );


/**
* Filter for the_content to replace data-size attributes with size attributes.
*
* @since 2.2.0
*
* @param string $content The raw post content to be filtered.
*/
function tevkori_filter_content_sizes( $content ) {
$images = '/(<img\s.*?)data-sizes="([^"]+)"/i';
$sizes = '${2}';

return preg_replace( $images, '${1}sizes="' . $sizes . '"', $content );
}
add_filter( 'the_content', 'tevkori_filter_content_sizes' );


/**
* Ajax handler for updating the srcset when an image is changed in the editor.
*
* @since 2.3.0
*
* @return string A sourcest value.
*/
function tevkori_ajax_srcset() {

// Bail early if no post ID is passed.
if ( empty( $_POST['postID'] ) ) {
return;
}

$postID = (int) $_POST['postID'];
if ( ! $postID ) {
return;
}

// Grab the image size being passed from the AJAX request.
$size = empty( $_POST['size'] ) ? $_POST['size'] : '';

// Get the srcset value for our image.
$srcset = tevkori_get_srcset( $postID, $size );

// For AJAX requests, we echo the result and then die.
wp_send_json( $srcset );
}
add_action( 'wp_ajax_tevkori_ajax_srcset', 'tevkori_ajax_srcset' );

0 comments on commit 63f5156

Please sign in to comment.