<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[34167] trunk: Update post thumbnail functions to allow a `WP_Post` to be passed.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/34167">34167</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/34167","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-15 03:45:23 +0000 (Tue, 15 Sep 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Update post thumbnail functions to allow a `WP_Post` to be passed.
Adds unit tests.
Props swissspidy, Rahe.
Fixes <a href="https://core.trac.wordpress.org/ticket/33723">#33723</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespostthumbnailtemplatephp">trunk/src/wp-includes/post-thumbnail-template.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestspostthumbnailsphp">trunk/tests/phpunit/tests/post/thumbnails.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespostthumbnailtemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/post-thumbnail-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post-thumbnail-template.php 2015-09-15 03:34:44 UTC (rev 34166)
+++ trunk/src/wp-includes/post-thumbnail-template.php 2015-09-15 03:45:23 UTC (rev 34167)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13,25 +13,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Check if post has an image attached.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 `$post` can be a post ID or WP_Post object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $post_id Optional. Post ID.
- * @return bool Whether post has an image attached.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @return bool Whether the post has an image attached.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function has_post_thumbnail( $post_id = null ) {
- return (bool) get_post_thumbnail_id( $post_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function has_post_thumbnail( $post = null ) {
+ return (bool) get_post_thumbnail_id( $post );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieve Post Thumbnail ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieve post thumbnail ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 `$post` can be a post ID or WP_Post object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|null $post_id Optional. Post ID.
- * @return mixed
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @return string|int Post thumbnail ID or empty string.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_post_thumbnail_id( $post_id = null ) {
- $post_id = ( null === $post_id ) ? get_the_ID() : $post_id;
- return get_post_meta( $post_id, '_thumbnail_id', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_post_thumbnail_id( $post = null ) {
+ $post = get_post( $post );
+ if ( ! $post ) {
+ return '';
+ }
+ return get_post_meta( $post->ID, '_thumbnail_id', true );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -57,7 +62,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Update cache for thumbnails in the current loop
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Update cache for thumbnails in the current loop.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,16 +101,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * size is used by default, though a different size can be specified instead as needed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 `$post` can be a post ID or WP_Post object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $post_id Post ID. Default is the ID of the `$post` global.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $size Optional. Registered image size to use, or flat array of height
</span><span class="cx" style="display: block; padding: 0 10px"> * and width values. Default 'post-thumbnail'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $attr Optional. Query string or array of attributes. Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string The post thumbnail image tag.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_the_post_thumbnail( $post_id = null, $size = 'post-thumbnail', $attr = '' ) {
- $post_id = ( null === $post_id ) ? get_the_ID() : $post_id;
- $post_thumbnail_id = get_post_thumbnail_id( $post_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_the_post_thumbnail( $post = null, $size = 'post-thumbnail', $attr = '' ) {
+ $post = get_post( $post );
+ if ( ! $post ) {
+ return '';
+ }
+ $post_thumbnail_id = get_post_thumbnail_id( $post );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filter the post thumbnail size.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,11 +134,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $post_id The post ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $post_id The post ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $post_thumbnail_id The post thumbnail ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $size The post thumbnail size.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- do_action( 'begin_fetch_post_thumbnail_html', $post_id, $post_thumbnail_id, $size );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ do_action( 'begin_fetch_post_thumbnail_html', $post->ID, $post_thumbnail_id, $size );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( in_the_loop() )
</span><span class="cx" style="display: block; padding: 0 10px"> update_post_thumbnail_cache();
</span><span class="cx" style="display: block; padding: 0 10px"> $html = wp_get_attachment_image( $post_thumbnail_id, $size, false, $attr );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -139,11 +148,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $post_id The post ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $post_id The post ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $post_thumbnail_id The post thumbnail ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $size The post thumbnail size.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- do_action( 'end_fetch_post_thumbnail_html', $post_id, $post_thumbnail_id, $size );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ do_action( 'end_fetch_post_thumbnail_html', $post->ID, $post_thumbnail_id, $size );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $html = '';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -154,10 +163,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $html The post thumbnail HTML.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $post_id The post ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $post_id The post ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $post_thumbnail_id The post thumbnail ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $size The post thumbnail size.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $attr Query string of attributes.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( 'post_thumbnail_html', $html, $post_id, $post_thumbnail_id, $size, $attr );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'post_thumbnail_html', $html, $post->ID, $post_thumbnail_id, $size, $attr );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestspostthumbnailsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/post/thumbnails.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/thumbnails.php (rev 0)
+++ trunk/tests/phpunit/tests/post/thumbnails.php 2015-09-15 03:45:23 UTC (rev 34167)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,113 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group post
+ * @group media
+ */
+class Tests_Post_Thumbnail_Template extends WP_UnitTestCase {
+ protected $post;
+ protected $attachment_id;
+
+ function setUp() {
+ parent::setUp();
+
+ $this->post = $this->factory->post->create_and_get();
+ $file = DIR_TESTDATA . '/images/canola.jpg';
+ $this->attachment_id = $this->factory->attachment->create_object( $file, $this->post->ID, array(
+ 'post_mime_type' => 'image/jpeg',
+ ) );
+ }
+
+ function test_has_post_thumbnail() {
+ $this->assertFalse( has_post_thumbnail( $this->post ) );
+ $this->assertFalse( has_post_thumbnail( $this->post->ID ) );
+ $this->assertFalse( has_post_thumbnail() );
+
+ $GLOBALS['post'] = $this->post;
+
+ $this->assertFalse( has_post_thumbnail() );
+
+ unset( $GLOBALS['post'] );
+
+ set_post_thumbnail( $this->post, $this->attachment_id );
+
+ $this->assertTrue( has_post_thumbnail( $this->post ) );
+ $this->assertTrue( has_post_thumbnail( $this->post->ID ) );
+ $this->assertFalse( has_post_thumbnail() );
+
+ $GLOBALS['post'] = $this->post;
+
+ $this->assertTrue( has_post_thumbnail() );
+ }
+
+ function test_get_post_thumbnail_id() {
+ $this->assertEmpty( get_post_thumbnail_id( $this->post ) );
+ $this->assertEmpty( get_post_thumbnail_id( $this->post->ID ) );
+ $this->assertEmpty( get_post_thumbnail_id() );
+
+ set_post_thumbnail( $this->post, $this->attachment_id );
+
+ $this->assertEquals( $this->attachment_id, get_post_thumbnail_id( $this->post ) );
+ $this->assertEquals( $this->attachment_id, get_post_thumbnail_id( $this->post->ID ) );
+
+ $GLOBALS['post'] = $this->post;
+
+ $this->assertEquals( $this->attachment_id, get_post_thumbnail_id() );
+ }
+
+ function test_update_post_thumbnail_cache() {
+ set_post_thumbnail( $this->post, $this->attachment_id );
+
+ $WP_Query = new WP_Query( array(
+ 'post_type' => 'any',
+ 'post__in' => array( $this->post->ID ),
+ 'orderby' => 'post__in',
+ ) );
+
+ $this->assertFalse( $WP_Query->thumbnails_cached );
+
+ update_post_thumbnail_cache( $WP_Query );
+
+ $this->assertTrue( $WP_Query->thumbnails_cached );
+ }
+
+ function test_get_the_post_thumbnail() {
+ $this->assertEquals( '', get_the_post_thumbnail() );
+ $this->assertEquals( '', get_the_post_thumbnail( $this->post ) );
+ set_post_thumbnail( $this->post, $this->attachment_id );
+
+ $expected = wp_get_attachment_image( $this->attachment_id, 'post-thumbnail', false, array( 'class' => 'attachment-post-thumbnail wp-post-image' ) );
+
+ $this->assertEquals( $expected, get_the_post_thumbnail( $this->post ) );
+
+ $GLOBALS['post'] = $this->post;
+
+ $this->assertEquals( $expected, get_the_post_thumbnail() );
+ }
+
+ function test_the_post_thumbnail() {
+ ob_start();
+ the_post_thumbnail();
+ $actual = ob_get_clean();
+
+ $this->assertEquals( '', $actual );
+
+ $GLOBALS['post'] = $this->post;
+
+ ob_start();
+ the_post_thumbnail();
+ $actual = ob_get_clean();
+
+ $this->assertEquals( '', $actual );
+
+ set_post_thumbnail( $this->post, $this->attachment_id );
+
+ $expected = wp_get_attachment_image( $this->attachment_id, 'post-thumbnail', false, array( 'class' => 'attachment-post-thumbnail wp-post-image' ) );
+
+ ob_start();
+ the_post_thumbnail();
+ $actual = ob_get_clean();
+
+ $this->assertEquals( $expected, $actual );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>