<!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>[30085] trunk: Improve global variable setting in `setup_postdata()`.</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/30085">30085</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/30085","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-10-29 02:31:37 +0000 (Wed, 29 Oct 2014)</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'>Improve global variable setting in `setup_postdata()`.
`setup_postdata()` is responsible for setting a number of global variables
that are used for post pagination (`$pages`, `$page`, `$nextpage`) and the
generation of post excerpts (`$more`). These variables should be sensitive to
the currently running instance of `WP_Query` - rather than the main query -
so that these features work properly inside of secondary `WP_Query` loops.
This changeset moves the logic of `setup_postdata()` into a method on `WP_Query`,
and converts `setup_postdata()` to a wrapper.
Props boonebgorges, wonderboymusic.
See <a href="https://core.trac.wordpress.org/ticket/25349">#25349</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/9256">#9256</a>, <a href="https://core.trac.wordpress.org/ticket/20904">#20904</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesqueryphp">trunk/src/wp-includes/query.php</a></li>
<li><a href="#trunktestsphpunittestsqueryphp">trunk/tests/phpunit/tests/query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesqueryphp"></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/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/query.php 2014-10-29 02:21:10 UTC (rev 30084)
+++ trunk/src/wp-includes/query.php 2014-10-29 02:31:37 UTC (rev 30085)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3710,7 +3710,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'loop_start', array( &$this ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post = $this->next_post();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- setup_postdata($post);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->setup_postdata( $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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4545,6 +4545,68 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Set up global post data.
+ *
+ * @since 4.1.0
+ *
+ * @param object $post Post data.
+ * @return bool True when finished.
+ */
+ public function setup_postdata( $post ) {
+ global $id, $authordata, $currentday, $currentmonth, $page, $pages, $multipage, $more, $numpages;
+
+ $id = (int) $post->ID;
+
+ $authordata = get_userdata($post->post_author);
+
+ $currentday = mysql2date('d.m.y', $post->post_date, false);
+ $currentmonth = mysql2date('m', $post->post_date, false);
+ $numpages = 1;
+ $multipage = 0;
+ $page = $this->get( 'page' );
+ if ( ! $page )
+ $page = 1;
+
+ // Force full post content when viewing the permalink for the $post, or
+ // when on an RSS feed. Otherwise respect the 'more' tag.
+ if ( $post->ID === get_queried_object_id() && ( $this->is_page() || $this->is_single() ) ) {
+ $more = 1;
+ } else if ( $this->is_feed() ) {
+ $more = 1;
+ } else {
+ $more = 0;
+ }
+
+ $content = $post->post_content;
+ if ( false !== strpos( $content, '<!--nextpage-->' ) ) {
+ if ( $page > 1 )
+ $more = 1;
+ $content = str_replace( "\n<!--nextpage-->\n", '<!--nextpage-->', $content );
+ $content = str_replace( "\n<!--nextpage-->", '<!--nextpage-->', $content );
+ $content = str_replace( "<!--nextpage-->\n", '<!--nextpage-->', $content );
+ // Ignore nextpage at the beginning of the content.
+ if ( 0 === strpos( $content, '<!--nextpage-->' ) )
+ $content = substr( $content, 15 );
+ $pages = explode('<!--nextpage-->', $content);
+ $numpages = count($pages);
+ if ( $numpages > 1 )
+ $multipage = 1;
+ } else {
+ $pages = array( $post->post_content );
+ }
+
+ /**
+ * Fires once the post data has been setup.
+ *
+ * @since 2.8.0
+ *
+ * @param WP_Post &$post The Post object (passed by reference).
+ */
+ do_action_ref_array( 'the_post', array( &$post ) );
+
+ return true;
+ }
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * After looping through a nested query, this function
</span><span class="cx" style="display: block; padding: 0 10px"> * restores the $post global to the current post in this query.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4630,47 +4692,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True when finished.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function setup_postdata( $post ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $id, $authordata, $currentday, $currentmonth, $page, $pages, $multipage, $more, $numpages;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wp_query;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $id = (int) $post->ID;
-
- $authordata = get_userdata($post->post_author);
-
- $currentday = mysql2date('d.m.y', $post->post_date, false);
- $currentmonth = mysql2date('m', $post->post_date, false);
- $numpages = 1;
- $multipage = 0;
- $page = get_query_var('page');
- if ( ! $page )
- $page = 1;
- if ( is_single() || is_page() || is_feed() )
- $more = 1;
- $content = $post->post_content;
- if ( false !== strpos( $content, '<!--nextpage-->' ) ) {
- if ( $page > 1 )
- $more = 1;
- $content = str_replace( "\n<!--nextpage-->\n", '<!--nextpage-->', $content );
- $content = str_replace( "\n<!--nextpage-->", '<!--nextpage-->', $content );
- $content = str_replace( "<!--nextpage-->\n", '<!--nextpage-->', $content );
- // Ignore nextpage at the beginning of the content.
- if ( 0 === strpos( $content, '<!--nextpage-->' ) )
- $content = substr( $content, 15 );
- $pages = explode('<!--nextpage-->', $content);
- $numpages = count($pages);
- if ( $numpages > 1 )
- $multipage = 1;
- } else {
- $pages = array( $post->post_content );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $wp_query ) && $wp_query instanceof WP_Query ) {
+ return $wp_query->setup_postdata( $post );
</ins><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">- /**
- * Fires once the post data has been setup.
- *
- * @since 2.8.0
- *
- * @param WP_Post &$post The Post object (passed by reference).
- */
- do_action_ref_array( 'the_post', array( &$post ) );
-
- return true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return false;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query.php 2014-10-29 02:21:10 UTC (rev 30084)
+++ trunk/tests/phpunit/tests/query.php 2014-10-29 02:31:37 UTC (rev 30085)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,62 +15,6 @@
</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">- * @ticket 16746
- */
- function test_nextpage_at_start_of_content() {
- $post = $this->factory->post->create_and_get( array( 'post_content' => '<!--nextpage-->Page 1<!--nextpage-->Page 2<!--nextpage-->Page 3' ) );
- setup_postdata( $post );
-
- $this->assertEquals( 1, $GLOBALS['multipage'] );
- $this->assertCount( 3, $GLOBALS['pages'] );
- $this->assertEquals( 3, $GLOBALS['numpages'] );
- $this->assertEquals( array( 'Page 1', 'Page 2', 'Page 3' ), $GLOBALS['pages'] );
- }
-
- function test_setup_postdata_single_page() {
- $post = $this->factory->post->create_and_get( array( 'post_content' => 'Page 0' ) );
- setup_postdata( $post );
-
- $this->assertEquals( 0, $GLOBALS['multipage'] );
- $this->assertCount( 1, $GLOBALS['pages'] );
- $this->assertEquals( 1, $GLOBALS['numpages'] );
- $this->assertEquals( array( 'Page 0' ), $GLOBALS['pages'] );
- }
-
- function test_setup_postdata_multi_page() {
- $post = $this->factory->post->create_and_get( array( 'post_content' => 'Page 0<!--nextpage-->Page 1<!--nextpage-->Page 2<!--nextpage-->Page 3' ) );
- setup_postdata( $post );
-
- $this->assertEquals( 1, $GLOBALS['multipage'] );
- $this->assertCount( 4, $GLOBALS['pages'] );
- $this->assertEquals( 4, $GLOBALS['numpages'] );
- $this->assertEquals( array( 'Page 0', 'Page 1', 'Page 2', 'Page 3' ), $GLOBALS['pages'] );
- }
-
- /**
- * @ticket 24330
- *
- * setup_postdata( $a_post ) followed by the_content() in a loop that does not update
- * global $post should use the content of $a_post rather then the global post.
- */
- function test_setup_postdata_loop() {
- $post_id = $this->factory->post->create( array( 'post_content' => 'global post' ) );
- $GLOBALS['wp_query']->post = $GLOBALS['post'] = get_post( $post_id );
-
- $ids = $this->factory->post->create_many(5);
- foreach ( $ids as $id ) {
- $page = get_post( $id );
- if ( $page ) {
- setup_postdata( $page );
- $content = get_echo( 'the_content', array() );
- $this->assertEquals( $post_id, $GLOBALS['post']->ID );
- $this->assertNotEquals( '<p>global post</p>', strip_ws( $content ) );
- wp_reset_postdata();
- }
- }
- }
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * @ticket 24785
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>