<!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>[49639] trunk: I18N: Avoid PHP notices for relative URLs in `load_script_textdomain()`.</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 { white-space: pre-line; 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/49639">49639</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/49639","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-11-17 20:50:21 +0000 (Tue, 17 Nov 2020)</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'>I18N: Avoid PHP notices for relative URLs in `load_script_textdomain()`.
Props hellofromTonya, SeBsZ, archon810, nourma, justinahinon, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/49145">#49145</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesl10nphp">trunk/src/wp-includes/l10n.php</a></li>
<li><a href="#trunktestsphpunittestsl10nloadScriptTextdomainphp">trunk/tests/phpunit/tests/l10n/loadScriptTextdomain.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesl10nphp"></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/l10n.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/l10n.php 2020-11-17 20:26:32 UTC (rev 49638)
+++ trunk/src/wp-includes/l10n.php 2020-11-17 20:50:21 UTC (rev 49639)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1040,7 +1040,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // If the host is the same or it's a relative URL.
</span><span class="cx" style="display: block; padding: 0 10px"> if (
</span><span class="cx" style="display: block; padding: 0 10px"> ( ! isset( $content_url['path'] ) || strpos( $src_url['path'], $content_url['path'] ) === 0 ) &&
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ( ! isset( $src_url['host'] ) || $src_url['host'] === $content_url['host'] )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ( ! isset( $src_url['host'] ) || ! isset( $content_url['host'] ) || $src_url['host'] === $content_url['host'] )
</ins><span class="cx" style="display: block; padding: 0 10px"> ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Make the src relative the specific plugin or theme.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $content_url['path'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1057,7 +1057,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $relative = implode( '/', $relative );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif (
</span><span class="cx" style="display: block; padding: 0 10px"> ( ! isset( $plugins_url['path'] ) || strpos( $src_url['path'], $plugins_url['path'] ) === 0 ) &&
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ( ! isset( $src_url['host'] ) || $src_url['host'] === $plugins_url['host'] )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ( ! isset( $src_url['host'] ) || ! isset( $plugins_url['host'] ) || $src_url['host'] === $plugins_url['host'] )
</ins><span class="cx" style="display: block; padding: 0 10px"> ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Make the src relative the specific plugin.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $plugins_url['path'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1072,7 +1072,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $relative = array_slice( $relative, 1 ); // Remove <plugin name>.
</span><span class="cx" style="display: block; padding: 0 10px"> $relative = implode( '/', $relative );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } elseif ( ! isset( $src_url['host'] ) || $src_url['host'] === $site_url['host'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( ! isset( $src_url['host'] ) || ! isset( $site_url['host'] ) || $src_url['host'] === $site_url['host'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $site_url['path'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $relative = trim( $src_url['path'], '/' );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( ( strpos( $src_url['path'], trailingslashit( $site_url['path'] ) ) === 0 ) ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsl10nloadScriptTextdomainphp"></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/l10n/loadScriptTextdomain.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/l10n/loadScriptTextdomain.php 2020-11-17 20:26:32 UTC (rev 49638)
+++ trunk/tests/phpunit/tests/l10n/loadScriptTextdomain.php 2020-11-17 20:50:21 UTC (rev 49639)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5,69 +5,128 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @group i18n
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_L10n_loadScriptTextdomain extends WP_UnitTestCase {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function site_url_subdirectory( $site_url ) {
- return $site_url . '/wp';
- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function relative_path_from_cdn( $relative, $src ) {
- if ( 0 === strpos( $src, 'https://my-cdn.com/wordpress/' ) ) {
- return substr( $src, strlen( 'https://my-cdn.com/wordpress/' ) );
- }
-
- return $relative;
- }
-
- public function plugins_url_custom_domain() {
- return 'https://plugins.example.com';
- }
-
- public function content_url_custom_domain_with_no_path() {
- return 'https://content.example.com';
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 45528
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 46336
+ * @ticket 46387
+ * @ticket 49145
+ *
+ * @dataProvider data_test_resolve_relative_path
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_resolve_relative_path() {
- $json_translations = file_get_contents( DIR_TESTDATA . '/languages/en_US-813e104eb47e13dd4cc5af844c618754.json' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_resolve_relative_path( $translation_path, $handle, $src, $textdomain, $filter = array() ) {
+ if ( ! empty( $filter ) ) {
+ add_filter( $filter[0], $filter[1], 10, isset( $filter[2] ) ? $filter[2] : 1 );
+ }
+ wp_enqueue_script( $handle, $src, array(), null );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_enqueue_script( 'test-example-root', '/wp-includes/js/script.js', array(), null );
- $this->assertSame( $json_translations, load_script_textdomain( 'test-example-root', 'default', DIR_TESTDATA . '/languages' ) );
-
- // Assets on a CDN.
- add_filter( 'load_script_textdomain_relative_path', array( $this, 'relative_path_from_cdn' ), 10, 2 );
- wp_enqueue_script( 'test-example-cdn', 'https://my-cdn.com/wordpress/wp-includes/js/script.js', array(), null );
- $this->assertSame( $json_translations, load_script_textdomain( 'test-example-cdn', 'default', DIR_TESTDATA . '/languages' ) );
- remove_filter( 'load_script_textdomain_relative_path', array( $this, 'relative_path_from_cdn' ) );
-
- // Test for WordPress installs in a subdirectory.
- add_filter( 'site_url', array( $this, 'site_url_subdirectory' ) );
- wp_enqueue_script( 'test-example-subdir', '/wp/wp-includes/js/script.js', array(), null );
- $this->assertSame( $json_translations, load_script_textdomain( 'test-example-subdir', 'default', DIR_TESTDATA . '/languages' ) );
- remove_filter( 'site_url', array( $this, 'site_url_subdirectory' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $expected = file_get_contents( DIR_TESTDATA . $translation_path );
+ $this->assertSame( $expected, load_script_textdomain( $handle, $textdomain, DIR_TESTDATA . '/languages' ) );
</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">- /**
- * @ticket 46336
- */
- public function test_resolve_relative_path_custom_plugins_url() {
- $json_translations = file_get_contents( DIR_TESTDATA . '/languages/plugins/internationalized-plugin-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json' );
-
- add_filter( 'plugins_url', array( $this, 'plugins_url_custom_domain' ) );
- wp_enqueue_script( 'plugin-example-1', 'https://plugins.example.com/my-plugin/js/script.js', array(), null );
- $this->assertSame( $json_translations, load_script_textdomain( 'plugin-example-1', 'internationalized-plugin', DIR_TESTDATA . '/languages' ) );
- remove_filter( 'plugins_url', array( $this, 'plugins_url_custom_domain' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function data_test_resolve_relative_path() {
+ return array(
+ // @ticket 45528
+ array(
+ '/languages/en_US-813e104eb47e13dd4cc5af844c618754.json',
+ 'test-example-root',
+ '/wp-includes/js/script.js',
+ 'default',
+ ),
+ // Assets on a CDN.
+ array(
+ '/languages/en_US-813e104eb47e13dd4cc5af844c618754.json',
+ 'test-example-cdn',
+ 'https://my-cdn.com/wordpress/wp-includes/js/script.js',
+ 'default',
+ array( 'load_script_textdomain_relative_path', array( $this, 'relative_path_from_cdn' ), 2 ),
+ ),
+ // Test for WordPress installs in a subdirectory.
+ array(
+ '/languages/en_US-813e104eb47e13dd4cc5af844c618754.json',
+ 'test-example-subdir',
+ '/wp/wp-includes/js/script.js',
+ 'default',
+ array(
+ 'site_url',
+ function ( $site_url ) {
+ return $site_url . '/wp';
+ },
+ ),
+ ),
+ // @ticket 46336
+ array(
+ '/languages/plugins/internationalized-plugin-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json',
+ 'plugin-example-1',
+ 'https://plugins.example.com/my-plugin/js/script.js',
+ 'internationalized-plugin',
+ array(
+ 'plugins_url',
+ function () {
+ return 'https://plugins.example.com';
+ },
+ ),
+ ),
+ // @ticket 46387
+ array(
+ '/languages/plugins/internationalized-plugin-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json',
+ 'plugin-example-2',
+ 'https://content.example.com/plugins/my-plugin/js/script.js',
+ 'internationalized-plugin',
+ array(
+ 'content_url',
+ function () {
+ return 'https://content.example.com';
+ },
+ ),
+ ),
+ // @ticket 49145
+ array(
+ '/languages/plugins/internationalized-plugin-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json',
+ 'test-when-no-content_url-host',
+ 'https://content.example.com/plugins/my-plugin/js/script.js',
+ 'internationalized-plugin',
+ array(
+ 'content_url',
+ function () {
+ return '/';
+ },
+ ),
+ ),
+ // @ticket 49145
+ array(
+ '/languages/plugins/internationalized-plugin-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json',
+ 'test-when-no-plugins_url-host',
+ 'https://plugins.example.com/my-plugin/js/script.js',
+ 'internationalized-plugin',
+ array(
+ 'plugins_url',
+ function () {
+ return '/';
+ },
+ ),
+ ),
+ // @ticket 49145
+ array(
+ '/languages/en_US-813e104eb47e13dd4cc5af844c618754.json',
+ 'test-when-no-site_url-host',
+ '/wp/wp-includes/js/script.js',
+ 'default',
+ array(
+ 'site_url',
+ function () {
+ return '/wp';
+ },
+ ),
+ ),
+ );
</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">- /**
- * @ticket 46387
- */
- public function test_resolve_relative_path_custom_content_url() {
- $json_translations = file_get_contents( DIR_TESTDATA . '/languages/plugins/internationalized-plugin-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function relative_path_from_cdn( $relative, $src ) {
+ if ( 0 === strpos( $src, 'https://my-cdn.com/wordpress/' ) ) {
+ return substr( $src, strlen( 'https://my-cdn.com/wordpress/' ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'content_url', array( $this, 'content_url_custom_domain_with_no_path' ) );
- wp_enqueue_script( 'plugin-example-2', 'https://content.example.com/plugins/my-plugin/js/script.js', array(), null );
- $this->assertSame( $json_translations, load_script_textdomain( 'plugin-example-2', 'internationalized-plugin', DIR_TESTDATA . '/languages' ) );
- remove_filter( 'content_url', array( $this, 'content_url_custom_domain_with_no_path' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $relative;
</ins><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>