Changeset 43583

Timestamp:

08/27/2018 02:33:35 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Improve inline documentation for WP_Scripts.

Props desrosj

See #42505

File:

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

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

@@ -205 +205 @@
         }
 
-        echo "<script type='text/javascript'>\n"; // CDATA and type='text/javascript' is not needed for HTML 5
+        echo "<script type='text/javascript'>\n"; // CDATA and type='text/javascript' is not needed for HTML 5.
         echo "/* <![CDATA[ */\n";
         echo "$output\n";
@@ -222 +222 @@
      * @see WP_Dependencies::do_item()
      *
-     * @param string $handle    The script's registered handle.
+     * @param string    $handle The script's registered handle.
      * @param int|false $group  Optional. Group level: (int) level, (false) no groups. Default false.
      * @return bool True on success, false on failure.
@@ -402 +402 @@
      * @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.
+     * @param bool   $echo     Optional. Whether to echo the script instead of just returning it.
      *                         Default true.
      * @return string|false Script on success, false otherwise.
@@ -427 +427 @@
      * @since 2.1.0
      *
-     * @param string $handle
-     * @param string $object_name
-     * @param array $l10n
-     * @return bool
+     * @param string $handle      Name of the script to attach data to.
+     * @param string $object_name Name of the variable that will contain the data.
+     * @param array  $l10n        Array of data to localize.
+     * @return bool True on success, false on failure.
      */
     public function localize( $handle, $object_name, $l10n ) {
@@ -437 +437 @@
         }
 
-        if ( is_array( $l10n ) && isset( $l10n['l10n_print_after'] ) ) { // back compat, preserve the code in 'l10n_print_after' if present
+        if ( is_array( $l10n ) && isset( $l10n['l10n_print_after'] ) ) { // back compat, preserve the code in 'l10n_print_after' if present.
             $after = $l10n['l10n_print_after'];
             unset( $l10n['l10n_print_after'] );