Changeset 46661 for trunk/src/wp-includes/class.wp-dependencies.php

Timestamp:

11/05/2019 09:25:53 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Further improve documentation of known return types, plus other docs fixes.

See #48303

File:

• trunk/src/wp-includes/class.wp-dependencies.php (modified) (6 diffs)

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

@@ -26 +26 @@
 
     /**
-     * An array of queued _WP_Dependency handle objects.
+     * An array of handles of queued objects.
      *
      * @since 2.6.8
-     * @var array
+     * @var string[]
      */
     public $queue = array();
 
     /**
-     * An array of _WP_Dependency handle objects to queue.
-     *
-     * @since 2.6.0
-     * @var array
+     * An array of handles of objects to queue.
+     *
+     * @since 2.6.0
+     * @var string[]
      */
     public $to_do = array();
 
     /**
-     * An array of _WP_Dependency handle objects already queued.
-     *
-     * @since 2.6.0
-     * @var array
+     * An array of handles of objects already queued.
+     *
+     * @since 2.6.0
+     * @var string[]
      */
     public $done = array();
@@ -84 +84 @@
      * @since 2.8.0 Added the `$group` parameter.
      *
-     * @param mixed $handles Optional. Items to be processed: Process queue (false), process item (string), process items (array of strings).
-     * @param mixed $group   Group level: level (int), no groups (false).
-     * @return array Handles of items that have been processed.
+     * @param mixed     $handles Optional. Items to be processed: Process queue (false), process item (string), process items (array of strings).
+     * @param int|false $group   Optional. Group level: level (int), no groups (false).
+     * @return string[] Array of handles of items that have been processed.
      */
     public function do_items( $handles = false, $group = false ) {
@@ -137 +137 @@
      * @since 2.8.0 Added the `$group` parameter.
      *
-     * @param mixed     $handles   Item handle and argument (string) or item handles and arguments (array of strings).
-     * @param bool      $recursion Internal flag that function is calling itself.
-     * @param int|false $group     Group level: (int) level, (false) no groups.
+     * @param string|string[] $handles   Item handle and argument (string) or item handles and arguments (array of strings).
+     * @param bool            $recursion Internal flag that function is calling itself.
+     * @param int|false       $group     Group level: (int) level, (false) no groups.
      * @return bool True on success, false on failure.
      */
@@ -271 +271 @@
      * @since 2.6.0 Moved from `WP_Scripts`.
      *
-     * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
+     * @param string|string[] $handles Item handle and argument (string) or item handles and arguments (array of strings).
      * @return void
      */
@@ -291 +291 @@
      * @since 2.6.0 Moved from `WP_Scripts`.
      *
-     * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
+     * @param string|string[] $handles Item handle and argument (string) or item handles and arguments (array of strings).
      */
     public function enqueue( $handles ) {
@@ -314 +314 @@
      * @since 2.6.0 Moved from `WP_Scripts`.
      *
-     * @param mixed $handles Item handle and argument (string) or item handles and arguments (array of strings).
+     * @param string|string[] $handles Item handle and argument (string) or item handles and arguments (array of strings).
      */
     public function dequeue( $handles ) {