Changeset 36633 for trunk/src/wp-includes/class.wp-scripts.php

Timestamp:

02/23/2016 04:43:41 PM (9 years ago)

Author:

swissspidy

Message:

Script Loader: Introduce wp_add_inline_script().

This new function can be used to add inline JavaScript before and after enqueued scripts, just like wp_add_inline_style() works for CSS.

Props atimmer, abiralneupane, ocean90, swissspidy.
Fixes #14853.

File:

• trunk/src/wp-includes/class.wp-scripts.php (modified) (7 diffs)

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

@@ -26 +26 @@
     public $do_concat = false;
     public $print_html = '';
+    public $print_html_before = '';
     public $print_code = '';
     public $ext_handles = '';
@@ -143 +144 @@
             $cond_before = "<!--[if {$conditional}]>\n";
             $cond_after = "<![endif]-->\n";
+        }
+
+        $before_handle = $this->print_inline_script( $handle, 'before', false );
+        $after_handle = $this->print_inline_script( $handle, 'after', false );
+
+        if ( $before_handle ) {
+            $before_handle = sprintf( "<script type='text/javascript'>\n%s\n</script>\n", $before_handle );
+        }
+
+        if ( $after_handle ) {
+            $after_handle = sprintf( "<script type='text/javascript'>\n%s\n</script>\n", $after_handle );
         }
 
@@ -155 +167 @@
              */
             $srce = apply_filters( 'script_loader_src', $src, $handle );
-            if ( $this->in_default_dir( $srce ) && ! $conditional ) {
+
+            if ( $before_handle && ! $conditional ) {
+                $this->print_html_before .= $before_handle;
+            }
+
+            if ( $this->in_default_dir( $srce ) && ! $conditional && ! $after_handle ) {
                 $this->print_code .= $this->print_extra_script( $handle, false );
                 $this->concat .= "$handle,";
@@ -196 +213 @@
             return true;
 
-        $tag = "{$cond_before}<script type='text/javascript' src='$src'></script>\n{$cond_after}";
+        $tag = "{$cond_before}{$before_handle}<script type='text/javascript' src='$src'></script>\n{$after_handle}{$cond_after}";
 
         /**
@@ -210 +227 @@
 
         if ( $this->do_concat ) {
-            $this->print_html .= $tag;
+            if ( $after_handle ) {
+                $this->print_html_before .= $tag;
+            } else {
+                $this->print_html .= $tag;
+            }
         } else {
             echo $tag;
@@ -216 +237 @@
 
         return true;
+    }
+
+    /**
+     * Add extra code to a registered script.
+     *
+     * @since 4.5.0
+     *
+     * @param string $handle   Name of the script to add the inline script to. Must be lowercase.
+     * @param string $data     String containing the javascript to be added.
+     * @param string $position Optional. Whether to add the inline script before the handle
+     *                         or after. Default 'after'.
+     *
+     * @return bool True on success, false on failure.
+     */
+    public function add_inline_script( $handle, $data, $position = 'after' ) {
+        if ( ! $data ) {
+            return false;
+        }
+
+        if ( 'after' !== $position ) {
+            $position = 'before';
+        }
+
+        $script   = (array) $this->get_data( $handle, $position );
+        $script[] = $data;
+
+        return $this->add_data( $handle, $position, $script );
+    }
+
+    /**
+     * Print inline scripts registered for a specific handle.
+     *
+     * @since 4.5.0
+     *
+     * @param string $handle   Name of the script to add the inline script to. Must be lowercase.
+     * @param string $position Optional. Whether to add the inline script before the handle
+     *                         or after. Default 'after'.
+     * @param bool $echo       Optional. Whether to echo the script instead of just returning it.
+     *                         Default true.
+     * @return string|false Script on success, false otherwise.
+     */
+    public function print_inline_script( $handle, $position = 'after', $echo = true ) {
+        $output = $this->get_data( $handle, $position );
+
+        if ( empty( $output ) ) {
+            return false;
+        }
+
+        $output = trim( implode( "\n", $output ), "\n" );
+
+        if ( $echo ) {
+            printf( "<script type='text/javascript'>\n%s\n</script>\n", $output );
+        }
+
+        return $output;
     }
 
@@ -340 +416 @@
         $this->concat_version = '';
         $this->print_html = '';
+        $this->print_html_before = '';
         $this->ext_version = '';
         $this->ext_handles = '';