<!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>[44232] branches/5.0/src/wp-includes/l10n.php: I18N: Introduce `load_script_translations()` as a wrapper for loading and filtering translation data for JavaScript files.</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/44232">44232</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/44232","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-12-16 15:53:34 +0000 (Sun, 16 Dec 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: Introduce `load_script_translations()` as a wrapper for loading and filtering translation data for JavaScript files.
* Introduces `pre_load_script_translations` to short-circuit the function.
* Introduces `load_script_translation_file` to filter the file path for loading script translations.
* Introduces `load_script_translations` to filter the JSON-encoded translation data.
Props johnbillion, strategio, swissspidy, dimadin, ocean90.
See <a href="https://core.trac.wordpress.org/ticket/45425">#45425</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches50srcwpincludesl10nphp">branches/5.0/src/wp-includes/l10n.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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-12-16 11:05:53 UTC (rev 44231)
+++ branches/5.0/src/wp-includes/l10n.php 2018-12-16 15:53:34 UTC (rev 44232)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -870,16 +870,15 @@
</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">- * Load the script translated strings.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Loads the script translated strings.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.0.0
+ * @since 5.0.2 Uses load_script_translations() to load translation data.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Scripts::set_translations()
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @link https://core.trac.wordpress.org/ticket/45103
- * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 5.0.0
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @param string $handle Name of the script to register a translation domain to.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $domain The textdomain.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $domain The text domain.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $path Optional. The full file path to the directory containing translation files.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return false|string False if the script textdomain could not be loaded, the translated strings
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -886,7 +885,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * in JSON encoding otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function load_script_textdomain( $handle, $domain, $path = null ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wp_scripts;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_scripts = wp_scripts();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $wp_scripts->registered[ $handle ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -899,7 +898,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $file_base = $domain === 'default' ? $locale : $domain . '-' . $locale;
</span><span class="cx" style="display: block; padding: 0 10px"> $handle_filename = $file_base . '-' . $handle . '.json';
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $path && file_exists( $path . '/' . $handle_filename ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return file_get_contents( $path . '/' . $handle_filename );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return load_script_translations( $path . '/' . $handle_filename, $handle, $domain );
</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"> $obj = $wp_scripts->registered[ $handle ];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -953,7 +952,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If the source is not from WP.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $relative ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return load_script_translations( false, $handle, $domain );
</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"> // Translations are always based on the unminified filename.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -963,16 +962,75 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $md5_filename = $file_base . '-' . md5( $relative ) . '.json';
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $path && file_exists( $path . '/' . $md5_filename ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return file_get_contents( $path . '/' . $md5_filename );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return load_script_translations( $path . '/' . $md5_filename, $handle, $domain );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( file_exists( $languages_path . '/' . $md5_filename ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return file_get_contents( $languages_path . '/' . $md5_filename );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return load_script_translations( $languages_path . '/' . $md5_filename, $handle, $domain );
</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">- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return load_script_translations( false, $handle, $domain );
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Loads the translation data for the given script handle and text domain.
+ *
+ * @since 5.0.2
+ *
+ * @param string|false $file Path to the translation file to load. False if there isn't one.
+ * @param string $handle Name of the script to register a translation domain to.
+ * @param string $domain The text domain.
+ * @return string|false The JSON-encoded translated strings for the given script handle and text domain. False if there are none.
+ */
+function load_script_translations( $file, $handle, $domain ) {
+ /**
+ * Pre-filters script translations for the given file, script handle and text domain.
+ *
+ * Returning a non-null value allows to override the default logic, effectively short-circuiting the function.
+ *
+ * @since 5.0.2
+ *
+ * @param string|false $translations JSON-encoded translation data. Default null.
+ * @param string|false $file Path to the translation file to load. False if there isn't one.
+ * @param string $handle Name of the script to register a translation domain to.
+ * @param string $domain The text domain.
+ */
+ $translations = apply_filters( 'pre_load_script_translations', null, $file, $handle, $domain );
+
+ if ( null !== $translations ) {
+ return $translations;
+ }
+
+ /**
+ * Filters the file path for loading script translations for the given script handle and text domain.
+ *
+ * @since 5.0.2
+ *
+ * @param string|false $file Path to the translation file to load. False if there isn't one.
+ * @param string $handle Name of the script to register a translation domain to.
+ * @param string $domain The text domain.
+ */
+ $file = apply_filters( 'load_script_translation_file', $file, $handle, $domain );
+
+ if ( ! $file || ! is_readable( $file ) ) {
+ return false;
+ }
+
+ $translations = file_get_contents( $file );
+
+ /**
+ * Filters script translations for the given file, script handle and text domain.
+ *
+ * @since 5.0.2
+ *
+ * @param string $translations JSON-encoded translation data.
+ * @param string $file Path to the translation file that was loaded.
+ * @param string $handle Name of the script to register a translation domain to.
+ * @param string $domain The text domain.
+ */
+ return apply_filters( 'load_script_translations', $translations, $file, $handle, $domain );
+}
+
+/**
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1404,9 +1462,9 @@
</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"> * Determines whether the current locale is right-to-left (RTL).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * For more information on this and similar theme functions, check out
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
</ins><span class="cx" style="display: block; padding: 0 10px"> * Conditional Tags} article in the Theme Developer Handbook.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span></span></pre>
</div>
</div>
</body>
</html>