Make WordPress Core


Ignore:
Timestamp:
09/22/2021 09:21:40 PM (4 months ago)
Author:
johnbillion
Message:

Docs: Miscellaneous docblock corrections and improvements.

See #52217, #53399

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class.wp-dependencies.php

    r47769 r51851  
    1818class WP_Dependencies {
    1919    /**
    20      * An array of registered handle objects.
     20     * An array of all registered dependencies keyed by handle.
    2121     *
    2222     * @since 2.6.8
     23     *
     24     * @var _WP_Dependency[]
     25     */
     26    public $registered = array();
     27
     28    /**
     29     * An array of handles of queued dependencies.
     30     *
     31     * @since 2.6.8
     32     *
     33     * @var string[]
     34     */
     35    public $queue = array();
     36
     37    /**
     38     * An array of handles of dependencies to queue.
     39     *
     40     * @since 2.6.0
     41     *
     42     * @var string[]
     43     */
     44    public $to_do = array();
     45
     46    /**
     47     * An array of handles of dependencies already queued.
     48     *
     49     * @since 2.6.0
     50     *
     51     * @var string[]
     52     */
     53    public $done = array();
     54
     55    /**
     56     * An array of additional arguments passed when a handle is registered.
     57     *
     58     * Arguments are appended to the item query string.
     59     *
     60     * @since 2.6.0
     61     *
    2362     * @var array
    2463     */
    25     public $registered = array();
    26 
    27     /**
    28      * An array of handles of queued objects.
    29      *
    30      * @since 2.6.8
    31      * @var string[]
    32      */
    33     public $queue = array();
    34 
    35     /**
    36      * An array of handles of objects to queue.
    37      *
    38      * @since 2.6.0
    39      * @var string[]
    40      */
    41     public $to_do = array();
    42 
    43     /**
    44      * An array of handles of objects already queued.
    45      *
    46      * @since 2.6.0
    47      * @var string[]
    48      */
    49     public $done = array();
    50 
    51     /**
    52      * An array of additional arguments passed when a handle is registered.
    53      *
    54      * Arguments are appended to the item query string.
    55      *
    56      * @since 2.6.0
    57      * @var array
    58      */
    5964    public $args = array();
    6065
    6166    /**
    62      * An array of handle groups to enqueue.
     67     * An array of dependency groups to enqueue.
     68     *
     69     * Each entry is keyed by handle and represents the integer group level or boolean
     70     * false if the handle has no group.
    6371     *
    6472     * @since 2.8.0
    65      * @var array
     73     *
     74     * @var (int|false)[]
    6675     */
    6776    public $groups = array();
     
    7180     *
    7281     * @since 2.8.0
     82     *
    7383     * @deprecated 4.5.0
    7484     * @var int
     
    8090     *
    8191     * @since 5.4.0
     92     *
    8293     * @var array
    8394     */
     
    95106     *                                       single item (string), or multiple items (array of strings).
    96107     *                                       Default false.
    97      * @param int|false             $group   Optional. Group level: level (int), no groups (false).
     108     * @param int|false             $group   Optional. Group level: level (int), no group (false).
    98109     * @return string[] Array of handles of items that have been processed.
    99110     */
     
    132143     *
    133144     * @param string    $handle Name of the item. Should be unique.
    134      * @param int|false $group  Optional. Group level: level (int), no groups (false).
     145     * @param int|false $group  Optional. Group level: level (int), no group (false).
    135146     *                          Default false.
    136147     * @return bool True on success, false if not set.
     
    153164     * @param bool            $recursion Optional. Internal flag that function is calling itself.
    154165     *                                   Default false.
    155      * @param int|false       $group     Optional. Group level: level (int), no groups (false).
     166     * @param int|false       $group     Optional. Group level: level (int), no group (false).
    156167     *                                   Default false.
    157168     * @return bool True on success, false on failure.
     
    355366
    356367    /**
    357      * Recursively search the passed dependency tree for $handle.
     368     * Recursively search the passed dependency tree for a handle.
    358369     *
    359370     * @since 4.0.0
     
    435446     * @param string    $handle    Name of the item. Should be unique.
    436447     * @param bool      $recursion Internal flag that calling function was called recursively.
    437      * @param int|false $group     Group level: level (int), no groups (false).
     448     * @param int|false $group     Group level: level (int), no group (false).
    438449     * @return bool Not already in the group or a lower group.
    439450     */
Note: See TracChangeset for help on using the changeset viewer.