<!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>[43825] branches/5.0: I18N: Add JavaScript translation support.</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/43825">43825</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/43825","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>herregroen</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-10-25 13:59:51 +0000 (Thu, 25 Oct 2018)</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: Add JavaScript translation support.
Adds the `wp_set_script_translations` function which registers translations for a JavaScript file. This function takes a handle, domain and optionally a path and ensures JavaScript translation files are loaded if they exist.
Props atimmer, omarreiss, nerrad, swissspidy, ocean90.
Fixes <a href="https://core.trac.wordpress.org/ticket/45103">#45103</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches50srcwpincludesclasswpscriptsphp">branches/5.0/src/wp-includes/class.wp-scripts.php</a></li>
<li><a href="#branches50srcwpincludesfunctionswpscriptsphp">branches/5.0/src/wp-includes/functions.wp-scripts.php</a></li>
<li><a href="#branches50srcwpincludesl10nphp">branches/5.0/src/wp-includes/l10n.php</a></li>
<li><a href="#branches50testsphpunittestsdependenciesscriptsphp">branches/5.0/tests/phpunit/tests/dependencies/scripts.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#branches50testsphpunitdatalanguagesdefaulten_US813e104eb47e13dd4cc5af844c618754json">branches/5.0/tests/phpunit/data/languages/default-en_US-813e104eb47e13dd4cc5af844c618754.json</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches50srcwpincludesclasswpscriptsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-includes/class.wp-scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-includes/class.wp-scripts.php 2018-10-25 13:42:03 UTC (rev 43824)
+++ branches/5.0/src/wp-includes/class.wp-scripts.php 2018-10-25 13:59:51 UTC (rev 43825)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -478,6 +478,41 @@
</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">+ * Register a translation textdomain.
+ *
+ * @since 5.0.0
+ *
+ * @param string $handle Name of the script to register a translation domain to.
+ * @param string $domain The textdomain.
+ * @param string $path Optional. The full file path to the directory containing translation files.
+ *
+ * @return bool True if the textdomain was registered, false if not.
+ */
+ public function set_translations( $handle, $domain, $path = null ) {
+ if ( ! isset( $this->registered[ $handle ] ) ) {
+ return false;
+ }
+
+ $json_translations = load_script_textdomain( $handle, $domain, $path );
+
+ if ( ! $json_translations ) {
+ return false;
+ }
+
+ /** @var \_WP_Dependency $obj */
+ $obj = $this->registered[ $handle ];
+ $obj->deps[] = 'wp-i18n';
+
+ return $this->add_inline_script(
+ $handle,
+ '(function( translations ){' .
+ 'wp.i18n.setLocaleData( translations.locale_data, "' . $domain . '" );' .
+ '})(' . $json_translations . ');',
+ 'before'
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Determines script dependencies.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span></span></pre></div>
<a id="branches50srcwpincludesfunctionswpscriptsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-includes/functions.wp-scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-includes/functions.wp-scripts.php 2018-10-25 13:42:03 UTC (rev 43824)
+++ branches/5.0/src/wp-includes/functions.wp-scripts.php 2018-10-25 13:59:51 UTC (rev 43825)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -193,6 +193,37 @@
</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">+ * Register translated strings for a script.
+ *
+ * Works only if the script has already been added.
+ *
+ * @see WP_Scripts::set_translations()
+ * @link https://core.trac.wordpress.org/ticket/45103
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @since 5.0.0
+ *
+ * @param string $handle Script handle the textdomain will be attached to.
+ * @param string $domain The textdomain.
+ * @param string $path Optional. The full file path to the directory containing translation files.
+ *
+ * @return bool True if the textdomain was successfully localized, false otherwise.
+ */
+function wp_set_script_translations( $handle, $domain, $path = null ) {
+ global $wp_scripts;
+ if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
+ _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
+ return false;
+ }
+
+ if ( ! wp_script_is( $handle, 'enqueued' ) ) {
+ _doing_it_wrong( __FUNCTION__, __( 'Script translations may only be set if the script is enqueued.' ), '5.0.0' );
+ }
+
+ return $wp_scripts->set_translations( $handle, $domain, $path );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Remove a registered script.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Note: there are intentional safeguards in place to prevent critical admin scripts,
</span></span></pre></div>
<a id="branches50srcwpincludesl10nphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-includes/l10n.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-includes/l10n.php 2018-10-25 13:42:03 UTC (rev 43824)
+++ branches/5.0/src/wp-includes/l10n.php 2018-10-25 13:59:51 UTC (rev 43825)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -870,6 +870,91 @@
</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">+ * Load the script translated strings.
+ *
+ * @see WP_Scripts::set_translations()
+ * @link https://core.trac.wordpress.org/ticket/45103
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
+ *
+ * @param string $handle Name of the script to register a translation domain to.
+ * @param string $domain The textdomain.
+ * @param string $path Optional. The full file path to the directory containing translation files.
+ *
+ * @return false|string False if the script textdomain could not be loaded, the translated strings
+ * in JSON encoding otherwise.
+ */
+function load_script_textdomain( $handle, $domain, $path = null ) {
+ global $wp_scripts;
+
+ $locale = is_admin() ? get_locale() : get_user_locale();
+
+ // If a path was given and the handle file exists simply return it.
+ $handle_filename = $domain . '-' . $locale . '-' . $handle . '.json';
+ if ( $path && file_exists( $path . '/' . $handle_filename ) ) {
+ return file_get_contents( $path . '/' . $handle_filename );
+ }
+
+ $obj = $wp_scripts->registered[ $handle ];
+
+ /** This filter is documented in wp-includes/class.wp-scripts.php */
+ $src = esc_url( apply_filters( 'script_loader_src', $obj->src, $handle ) );
+
+ $relative = false;
+ $languages_path = WP_LANG_DIR;
+
+ $src_url = wp_parse_url( $src );
+ $content_url = wp_parse_url( content_url() );
+ $site_url = wp_parse_url( site_url() );
+
+ // If the host is the same or it's a relative URL.
+ if (
+ strpos( $content_url['path'], $src_url['path'] ) === 0 &&
+ ( ! isset( $src_url['host'] ) || $src_url['host'] !== $content_url['host'] )
+ ) {
+ // Make the src relative the specific plugin or theme.
+ $relative = trim( substr( $src, strlen( $content_url['path'] ) ), '/' );
+ $relative = explode( '/', $relative );
+
+ $languages_path = WP_LANG_DIR . '/' . $relative[0];
+
+ $relative = array_slice( $relative, 2 );
+ $relative = implode( '/', $relative );
+ } else if (
+ ! isset( $site_url['path'] ) &&
+ ( ! isset( $src_url['host'] ) || $src_url['host'] !== $site_url['host'] )
+ ) {
+ $relative = trim( $src_url['path'], '/' );
+ } else if (
+ ( strpos( $site_url['path'], $src_url['path'] ) === 0 ) &&
+ ( ! isset( $src_url['host'] ) || $src_url['host'] !== $site_url['host'] )
+ ) {
+ // Make the src relative to the WP root.
+ $relative = substr( $src, strlen( $site_url['path'] ) );
+ $relative = trim( $relative, '/' );
+ }
+
+ // If the source is not from WP.
+ if ( false === $relative ) {
+ return false;
+ }
+
+ // Translations are always based on the unminified filename.
+ if ( substr( $relative, -7 ) === '.min.js' ) {
+ $relative = substr( $relative, 0, -7 ) . '.js';
+ }
+
+ $md5_filename = $domain . '-' . $locale . '-' . md5( $relative ) . '.json';
+ if ( $path && file_exists( $path . '/' . $md5_filename ) ) {
+ return file_get_contents( $path . '/' . $md5_filename );
+ }
+ if ( file_exists( $languages_path . '/' . $md5_filename ) ) {
+ return file_get_contents( $languages_path . '/' . $md5_filename );
+ }
+
+ return false;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Loads plugin and theme textdomains just-in-time.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * When a textdomain is encountered for the first time, we try to load
</span></span></pre></div>
<a id="branches50testsphpunitdatalanguagesdefaulten_US813e104eb47e13dd4cc5af844c618754json"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: branches/5.0/tests/phpunit/data/languages/default-en_US-813e104eb47e13dd4cc5af844c618754.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/data/languages/default-en_US-813e104eb47e13dd4cc5af844c618754.json (rev 0)
+++ branches/5.0/tests/phpunit/data/languages/default-en_US-813e104eb47e13dd4cc5af844c618754.json 2018-10-25 13:59:51 UTC (rev 43825)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,30 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+{
+ "translation-revision-data": "+0000",
+ "generator": "GlotPress/2.3.0-alpha",
+ "domain": "messages",
+ "locale_data": {
+ "messages": {
+ "": {
+ "domain": "messages",
+ "plural-forms": "n != 1",
+ "lang": "en-gb"
+ },
+ "This file is too big. Files must be less than %d KB in size.": [
+ "This file is too big. Files must be less than %d KB in size."
+ ],
+ "%d Theme Update": [
+ "%d Theme Update",
+ "%d Theme Updates"
+ ],
+ "password strength\u0004Medium": [
+ "Medium"
+ ],
+ "taxonomy singular name\u0004Category": [
+ "Category"
+ ],
+ "post type general name\u0004Pages": [
+ "Pages"
+ ]
+ }
+ }
+}
</ins></span></pre></div>
<a id="branches50testsphpunittestsdependenciesscriptsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/tests/phpunit/tests/dependencies/scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/tests/dependencies/scripts.php 2018-10-25 13:42:03 UTC (rev 43824)
+++ branches/5.0/tests/phpunit/tests/dependencies/scripts.php 2018-10-25 13:59:51 UTC (rev 43825)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -768,6 +768,23 @@
</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">+ * @ticket 45103
+ */
+ public function test_wp_set_script_translation() {
+ wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+ wp_enqueue_script( 'test-example', '/wp-includes/js/script.js', array(), null );
+ wp_set_script_translations( 'test-example', 'default', __DIR__ . '/../../data/languages/' );
+
+ $expected = "<script type='text/javascript' src='/wp-includes/js/dist/wp-i18n.js'></script>";
+ $expected .= "\n<script type='text/javascript'>\n(function( translations ){" .
+ "wp.i18n.setLocaleData( translations.locale_data, \"default\" );" .
+ "})(" . file_get_contents( __DIR__ . '/../../data/languages/default-en_US-813e104eb47e13dd4cc5af844c618754.json') . ");\n</script>\n";
+ $expected .= "<script type='text/javascript' src='/wp-includes/js/script.js'></script>\n";
+
+ $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Testing `wp_enqueue_code_editor` with file path.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 41871
</span></span></pre>
</div>
</div>
</body>
</html>