Changeset 27731

Timestamp:

03/26/2014 05:47:16 AM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-includes/class.wp-scripts.php.

Props kpdesign for a wording switcheroo.
Fixes #27518.

File:

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

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

@@ -37 +37 @@
 
     function init() {
+        /**
+         * Fires when the WP_Scripts instance is initialized.
+         *
+         * @since 2.6.0
+         *
+         * @param WP_Scripts &$this WP_Scripts instance, passed by reference.
+         */
         do_action_ref_array( 'wp_default_scripts', array(&$this) );
     }
@@ -98 +105 @@
 
         if ( $this->do_concat ) {
+            /**
+             * Filter the script loader source.
+             *
+             * @since 2.2.0
+             *
+             * @param string $src    Script loader source path.
+             * @param string $handle Script handle.
+             */
             $srce = apply_filters( 'script_loader_src', $src, $handle );
             if ( $this->in_default_dir($srce) ) {
@@ -118 +133 @@
             $src = add_query_arg('ver', $ver, $src);
 
+        /** This filter is documented in wp-includes/class.wp-scripts.php */
         $src = esc_url( apply_filters( 'script_loader_src', $src, $handle ) );
 
@@ -180 +196 @@
     function all_deps( $handles, $recursion = false, $group = false ) {
         $r = parent::all_deps( $handles, $recursion );
-        if ( !$recursion )
+        if ( ! $recursion ) {
+            /**
+             * Filter the list of script dependencies left to print.
+             *
+             * @since 2.3.0
+             *
+             * @param array $to_do An array of script dependencies.
+             */
             $this->to_do = apply_filters( 'print_scripts_array', $this->to_do );
+        }
         return $r;
     }