Ticket #45103: 45103.6.diff

src/wp-includes/class.wp-scripts.php

@@ -478 +478 @@
         }
 
         /**
+         * 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'
+                );
+        }
+
+        /**
          * Determines script dependencies.
      *
          * @since 2.1.0

src/wp-includes/functions.wp-scripts.php

@@ -193 +193 @@
 }
 
 /**
+ * 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 );
+}
+
+/**
  * Remove a registered script.
  *
  * Note: there are intentional safeguards in place to prevent critical admin scripts,

src/wp-includes/l10n.php

@@ -870 +870 @@
 }
 
 /**
+ * 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;
+}
+
+/**
  * Loads plugin and theme textdomains just-in-time.
  *
  * When a textdomain is encountered for the first time, we try to load

tests/phpunit/data/languages/default-en_US-813e104eb47e13dd4cc5af844c618754.json

@@ +1 @@
+{
+  "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"
+      ]
+    }
+  }
+}

tests/phpunit/tests/dependencies/scripts.php

@@ -768 +768 @@
         }
 
         /**
+         * @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' ) );
+        }
+
+        /**
          * Testing `wp_enqueue_code_editor` with file path.
          *
          * @ticket 41871