<!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>[37798] branches/4.4: Embeds: Improve performance when embedding a post from the current site.</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/37798">37798</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/37798","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-06-21 14:41:05 +0000 (Tue, 21 Jun 2016)</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'>Embeds: Improve performance when embedding a post from the current site.
When the post being embedded is from the same site, there's no reason to do an HTTP request for it. The data can be fetched directly using `get_oembed_response_data()`.
Merge of <a href="https://core.trac.wordpress.org/changeset/37708">[37708]</a>, <a href="https://core.trac.wordpress.org/changeset/37710">[37710]</a> and <a href="https://core.trac.wordpress.org/changeset/37729">[37729]</a> to the 4.4 branch.
Fixes <a href="https://core.trac.wordpress.org/ticket/36767">#36767</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches44srcwpincludesclassoembedphp">branches/4.4/src/wp-includes/class-oembed.php</a></li>
<li><a href="#branches44srcwpincludesdefaultfiltersphp">branches/4.4/src/wp-includes/default-filters.php</a></li>
<li><a href="#branches44srcwpincludesembedphp">branches/4.4/src/wp-includes/embed.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#branches44testsphpunittestsoembedwpOembedphp">branches/4.4/tests/phpunit/tests/oembed/wpOembed.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches44srcwpincludesclassoembedphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.4/src/wp-includes/class-oembed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.4/src/wp-includes/class-oembed.php 2016-06-21 14:40:07 UTC (rev 37797)
+++ branches/4.4/src/wp-includes/class-oembed.php 2016-06-21 14:41:05 UTC (rev 37798)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -284,10 +284,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return false|string False on failure, otherwise the UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_html( $url, $args = '' ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the oEmbed result before any HTTP requests are made.
+ *
+ * This allows one to short-circuit the default logic, perhaps by
+ * replacing it with a routine that is more optimal for your setup.
+ *
+ * Passing a non-null value to the filter will effectively short-circuit retrieval,
+ * returning the passed value instead.
+ *
+ * @since 4.5.3
+ *
+ * @param null|string $result The UNSANITIZED (and potentially unsafe) HTML that should be used to embed. Default null.
+ * @param string $url The URL to the content that should be attempted to be embedded.
+ * @param array $args Optional. Arguments, usually passed from a shortcode. Default empty.
+ */
+ $pre = apply_filters( 'pre_oembed_result', null, $url, $args );
+
+ if ( null !== $pre ) {
+ return $pre;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $provider = $this->get_provider( $url, $args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !$provider || false === $data = $this->fetch( $provider, $url, $args ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $provider || false === $data = $this->fetch( $provider, $url, $args ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</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 HTML returned by the oEmbed provider.
</span></span></pre></div>
<a id="branches44srcwpincludesdefaultfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.4/src/wp-includes/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.4/src/wp-includes/default-filters.php 2016-06-21 14:40:07 UTC (rev 37797)
+++ branches/4.4/src/wp-includes/default-filters.php 2016-06-21 14:41:05 UTC (rev 37798)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -473,5 +473,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'oembed_dataparse', 'wp_filter_oembed_result', 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'oembed_response_data', 'get_oembed_response_data_rich', 10, 4 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'pre_oembed_result', 'wp_filter_pre_oembed_result', 10, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $filter, $action );
</span></span></pre></div>
<a id="branches44srcwpincludesembedphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.4/src/wp-includes/embed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.4/src/wp-includes/embed.php 2016-06-21 14:40:07 UTC (rev 37797)
+++ branches/4.4/src/wp-includes/embed.php 2016-06-21 14:41:05 UTC (rev 37798)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1045,3 +1045,39 @@
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Filters the oEmbed result before any HTTP requests are made.
+ *
+ * If the URL belongs to the current site, the result is fetched directly instead of
+ * going through the oEmbed discovery process.
+ *
+ * @since 4.5.3
+ *
+ * @param null|string $result The UNSANITIZED (and potentially unsafe) HTML that should be used to embed. Default null.
+ * @param string $url The URL that should be inspected for discovery `<link>` tags.
+ * @param array $args oEmbed remote get arguments.
+ * @return null|string The UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
+ * Null if the URL does not belong to the current site.
+ */
+function wp_filter_pre_oembed_result( $result, $url, $args ) {
+ $post_id = url_to_postid( $url );
+
+ /** This filter is documented in wp-includes/class-wp-oembed-controller.php */
+ $post_id = apply_filters( 'oembed_request_post_id', $post_id, $url );
+
+ if ( ! $post_id ) {
+ return $result;
+ }
+
+ $width = isset( $args['width'] ) ? $args['width'] : 0;
+
+ $data = get_oembed_response_data( $post_id, $width );
+ $data = _wp_oembed_get_object()->data2html( (object) $data, $url );
+
+ if ( ! $data ) {
+ return $result;
+ }
+
+ return $data;
+}
</ins></span></pre></div>
<a id="branches44testsphpunittestsoembedwpOembedphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: branches/4.4/tests/phpunit/tests/oembed/wpOembed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.4/tests/phpunit/tests/oembed/wpOembed.php (rev 0)
+++ branches/4.4/tests/phpunit/tests/oembed/wpOembed.php 2016-06-21 14:41:05 UTC (rev 37798)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,72 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group oembed
+ */
+class Tests_WP_oEmbed extends WP_UnitTestCase {
+ /**
+ * @var WP_oEmbed
+ */
+ protected $oembed;
+
+ public $pre_oembed_result_filtered = false;
+
+ public function setUp() {
+ parent::setUp();
+
+ require_once ABSPATH . WPINC . '/class-oembed.php';
+ $this->oembed = _wp_oembed_get_object();
+
+ $this->pre_oembed_result_filtered = false;
+ }
+
+ public function _filter_pre_oembed_result( $result ) {
+ // If this is not null, the oEmbed result has been filtered before any HTTP requests were made.
+ $this->pre_oembed_result_filtered = $result;
+
+ // Return false to prevent HTTP requests during tests.
+ return $result ? $result : false;
+ }
+
+ public function test_wp_filter_pre_oembed_result_prevents_http_request_for_internal_permalinks() {
+ $post_id = self::factory()->post->create();
+ $permalink = get_permalink( $post_id );
+
+ add_filter( 'pre_oembed_result', array( $this, '_filter_pre_oembed_result' ) );
+ $actual = $this->oembed->get_html( $permalink );
+ remove_filter( 'pre_oembed_result', array( $this, '_filter_pre_oembed_result' ) );
+
+ $this->assertTrue( false !== $this->pre_oembed_result_filtered );
+ $this->assertEquals( $this->pre_oembed_result_filtered, $actual );
+ }
+
+ public function test_wp_filter_pre_oembed_result_prevents_http_request_when_viewing_the_post() {
+ $post_id = self::factory()->post->create();
+ $permalink = get_permalink( $post_id );
+
+ $this->go_to( $permalink );
+ $this->assertQueryTrue( 'is_single', 'is_singular' );
+
+ add_filter( 'pre_oembed_result', array( $this, '_filter_pre_oembed_result' ) );
+ $actual = $this->oembed->get_html( $permalink );
+ remove_filter( 'pre_oembed_result', array( $this, '_filter_pre_oembed_result' ) );
+
+ $this->assertTrue( false !== $this->pre_oembed_result_filtered );
+ $this->assertEquals( $this->pre_oembed_result_filtered, $actual );
+ }
+
+ public function test_wp_filter_pre_oembed_result_non_existent_post() {
+ $post_id = self::factory()->post->create();
+ $permalink = get_permalink( $post_id );
+
+ $this->go_to( $permalink );
+ $this->assertQueryTrue( 'is_single', 'is_singular' );
+
+ add_filter( 'pre_oembed_result', array( $this, '_filter_pre_oembed_result' ) );
+ $actual = $this->oembed->get_html( 'https://example.com/' );
+ remove_filter( 'pre_oembed_result', array( $this, '_filter_pre_oembed_result' ) );
+
+ $this->assertTrue( false !== $this->pre_oembed_result_filtered );
+ $this->assertFalse( $actual );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: branches/4.4/tests/phpunit/tests/oembed/wpOembed.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>