Ticket #31281: 31281.diff

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

@@ -312 +312 @@
                         }
                 }
 
+                // Even if the script itself is being concatenated and printed later, we
+                // may as well print the templates now.
+                $this->print_templates( $handle );
+
                 $has_conditional_data = $conditional && $this->get_data( $handle, 'data' );
 
                 if ( $has_conditional_data ) {
@@ -421 +425 @@
         }
 
         /**
+         * Add a javascript `text/html` template to print out before the specified script.
+         *
+         * @since 4.?.0
+         * @access public
+         *
+         * @param string $script_handle   Name of the script to add the template to. Must be lowercase.
+         * @param string $template_handle The handle of the template. Will be prefixed with `tmpl-`.
+         * @param string $data            String containing the markup to be added.
+         * @return bool True on success, false on failure.
+         */
+        public function add_template( $script_handle, $template_handle, $data ) {
+                $templates = $this->get_data( $script_handle, 'templates' );
+                if ( ! $templates ) {
+                        $templates = array();
+                }
+
+                $templates[ $template_handle ] = $data;
+
+                return $this->add_data( $script_handle, 'templates', $templates );
+        }
+
+        /**
+         * Print the javascript templates before the script that they are attached to.
+         *
+         * @since 4.?.0
+         *
+         * @param string $script_handle Name of the script to print the templates for. Must be lowercase.
+         * @param bool $echo            Optional. Whether to echo the script instead of just returning it.
+         *                              Default true.
+         * @return null|string The templates, or null if there weren't any.
+         */
+        public function print_templates( $script_handle, $echo = true ) {
+                $templates = $this->get_data( $script_handle, 'templates' );
+                $output = '';
+
+                if ( empty( $templates ) ) {
+                        return null;
+                }
+
+                foreach ( $templates as $handle => $template ) {
+                        $output .= sprintf( "<script type='text/html' id='tmpl-%s'>\n%s\n</script>\n", esc_attr( $handle ), $template );
+                }
+
+                if ( $echo ) {
+                        echo $output;
+                }
+
+                return $output;
+        }
+
+        /**
          * Localizes a script, only if the script has already been added.
          *
          * @since 2.1.0

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

@@ -328 +328 @@
 function wp_script_add_data( $handle, $key, $value ){
         return wp_scripts()->add_data( $handle, $key, $value );
 }
+
+/**
+ * Add a template to a script.
+ *
+ * Works only if the script has already been added.
+ *
+ * @since 4.?.0
+ *
+ * @param string $handle    Name of the script.
+ * @param string $key       ID of template. Will be prefixed with `tmpl-`.
+ * @param mixed  $template  String containing the template to be added.
+ * @return bool True on success, false on failure.
+ */
+function wp_script_add_template( $handle, $key, $template ){
+        return wp_scripts()->add_template( $handle, $key, $template );
+}

tests/phpunit/tests/dependencies/scripts.php

@@ -724 +724 @@
 
                 $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );
         }
+
+        /**
+         * Testing `wp_script_add_template`
+         * @ticket 31281
+         */
+        function test_wp_script_add_template() {
+                // Enqueue & add data
+                $template_code = '<h1>test <em>template</em></h1>';
+                wp_enqueue_script( 'test-only-data', 'example.com', array(), null );
+                wp_script_add_template( 'test-only-data', 'test-template', $template_code );
+                $expected  = "<script type='text/html' id='tmpl-test-template'>\n{$template_code}\n</script>\n";
+                $expected .= "<script type='text/javascript' src='http://example.com'></script>\n";
+
+                // Go!
+                $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );
+
+                // No scripts left to print
+                $this->assertEquals( '', get_echo( 'wp_print_scripts' ) );
+        }
 }