Changeset 43825 for branches/5.0/src/wp-includes/functions.wp-scripts.php

Timestamp:

10/25/2018 01:59:51 PM (6 years ago)

Author:

herregroen

Message:

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 #45103.

File:

• branches/5.0/src/wp-includes/functions.wp-scripts.php (modified) (1 diff)

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

@@ -191 +191 @@
 
     return $wp_scripts->localize( $handle, $object_name, $l10n );
+}
+
+/**
+ * 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 );
 }