WordPress.org
Get WordPress

Make WordPress Core

Changeset 51851


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

Docs: Miscellaneous docblock corrections and improvements.

See #52217, #53399

Location:
trunk/src/wp-includes
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-wp-http-cookie.php

    r51824 r51851  
    2525         *
    2626         * @since 2.8.0
     27         *
    2728         * @var string
    2829         */
    … …  
    3334         *
    3435         * @since 2.8.0
     36         *
    3537         * @var string
    3638         */
    … …  
    4143         *
    4244         * @since 2.8.0
     45         *
    4346         * @var string|int|null
    4447         */
    … …  
    4952         *
    5053         * @since 2.8.0
     54         *
    5155         * @var string
    5256         */
    … …  
    5761         *
    5862         * @since 2.8.0
     63         *
    5964         * @var string
    6065         */
    … …  
    6267
    6368        /**
     69         * Cookie port or comma-separated list of ports.
     70         *
     71         * @since 2.8.0
     72         *
     73         * @var int|string
     74         */
     75        public $port;
     76
     77        /**
    6478         * host-only flag.
    6579         *
    6680         * @since 5.2.0
     81         *
    6782         * @var bool
    6883         */
    … …  
    86101         *     @type string          $path      Optional. Path. Default '/'.
    87102         *     @type string          $domain    Optional. Domain. Default host of parsed $requested_url.
    88          *     @type int             $port      Optional. Port. Default null.
     103         *     @type int|string      $port      Optional. Port or comma-separated list of ports. Default null.
    89104         *     @type bool            $host_only Optional. host-only storage flag. Default true.
    90105         * }

  • trunk/src/wp-includes/class-wp-user.php

    r50490 r51851  
    3535 * @property string $rich_editing
    3636 * @property string $syntax_highlighting
     37 * @property string $use_ssl
    3738 */
    3839class WP_User {

  • 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         */

  • trunk/src/wp-includes/widgets/class-wp-widget-media.php

    r51789 r51851  
    318318         *
    319319         * @param array $instance Widget instance props.
    320          * @return string
    321320         */
    322321        abstract public function render_media( $instance );

  • trunk/src/wp-includes/wp-db.php

    r51799 r51851  
    6060         *
    6161         * @since 0.71
     62         *
    6263         * @var bool
    6364         */
    … …  
    6869         *
    6970         * @since 2.5.0
     71         *
    7072         * @var bool
    7173         */
    … …  
    7678         *
    7779         * @since 2.5.0
     80         *
    7881         * @var string
    7982         */
    … …  
    8487         *
    8588         * @since 1.2.0
     89         *
    8690         * @var int
    8791         */
    … …  
    9296         *
    9397         * @since 0.71
     98         *
    9499         * @var int
    95100         */
    … …  
    100105         *
    101106         * @since 0.71
     107         *
    102108         * @var int
    103109         */
    … …  
    108114         *
    109115         * @since 0.71
     116         *
    110117         * @var int
    111118         */
    … …  
    116123         *
    117124         * @since 0.71
     125         *
    118126         * @var string
    119127         */
    … …  
    124132         *
    125133         * @since 0.71
     134         *
    126135         * @var array|null
    127136         */
    … …  
    132141         *
    133142         * @since 0.71
     143         *
    134144         * @var mixed
    135145         */
    … …  
    140150         *
    141151         * @since 4.2.0
     152         *
    142153         * @var array
    143154         */
    … …  
    148159         *
    149160         * @since 4.2.0
     161         *
    150162         * @var array
    151163         */
    … …  
    156168         *
    157169         * @since 4.2.0
     170         *
    158171         * @var bool
    159172         */
    … …  
    164177         *
    165178         * @since 4.2.0
     179         *
    166180         * @see wpdb::check_safe_collation()
    167181         * @var bool
    … …  
    173187         *
    174188         * @since 0.71
     189         *
    175190         * @var array
    176191         */
    … …  
    205220         *
    206221         * @since 3.9.0
     222         *
    207223         * @see wpdb::check_connection()
    208224         * @var int
    … …  
    217233         *
    218234         * @since 2.5.0
     235         *
    219236         * @var string
    220237         */
    … …  
    225242         *
    226243         * @since 3.0.0
     244         *
    227245         * @var string
    228246         */
    … …  
    233251         *
    234252         * @since 2.3.2
     253         *
    235254         * @var bool
    236255         */
    … …  
    241260         *
    242261         * @since 3.0.0
     262         *
    243263         * @var int
    244264         */
    … …  
    249269         *
    250270         * @since 3.0.0
     271         *
    251272         * @var int
    252273         */
    … …  
    257278         *
    258279         * @since 2.5.0
     280         *
    259281         * @see wpdb::tables()
    260282         * @var array
    … …  
    279301         *
    280302         * @since 2.9.0
     303         *
    281304         * @see wpdb::tables()
    282305         * @var array
    … …  
    288311         *
    289312         * @since 3.0.0
     313         *
    290314         * @see wpdb::tables()
    291315         * @var array
    … …  
    297321         *
    298322         * @since 3.0.0
     323         *
    299324         * @see wpdb::tables()
    300325         * @var array
    … …  
    314339         *
    315340         * @since 1.5.0
     341         *
    316342         * @var string
    317343         */
    … …  
    322348         *
    323349         * @since 2.9.0
     350         *
    324351         * @var string
    325352         */
    … …  
    330357         *
    331358         * @since 1.5.0
     359         *
    332360         * @var string
    333361         */
    … …  
    338366         *
    339367         * @since 1.5.0
     368         *
    340369         * @var string
    341370         */
    … …  
    346375         *
    347376         * @since 1.5.0
     377         *
    348378         * @var string
    349379         */
    … …  
    354384         *
    355385         * @since 1.5.0
     386         *
    356387         * @var string
    357388         */
    … …  
    362393         *
    363394         * @since 2.3.0
     395         *
    364396         * @var string
    365397         */
    … …  
    370402         *
    371403         * @since 2.3.0
     404         *
    372405         * @var string
    373406         */
    … …  
    378411         *
    379412         * @since 2.3.0
     413         *
    380414         * @var string
    381415         */
    … …  
    386420         *
    387421         * @since 4.4.0
     422         *
    388423         * @var string
    389424         */
    … …  
    398433         *
    399434         * @since 2.3.0
     435         *
    400436         * @var string
    401437         */
    … …  
    406442         *
    407443         * @since 1.5.0
     444         *
    408445         * @var string
    409446         */
    … …  
    414451         *
    415452         * @since 3.0.0
     453         *
    416454         * @var string
    417455         */
    … …  
    422460         *
    423461         * @since 5.1.0
     462         *
    424463         * @var string
    425464         */
    … …  
    430469         *
    431470         * @since 3.0.0
     471         *
    432472         * @var string
    433473         */
    … …  
    438478         *
    439479         * @since 3.0.0
     480         *
    440481         * @var string
    441482         */
    … …  
    446487         *
    447488         * @since 3.0.0
     489         *
    448490         * @var string
    449491         */
    … …  
    454496         *
    455497         * @since 3.0.0
     498         *
    456499         * @var string
    457500         */
    … …  
    462505         *
    463506         * @since 3.0.0
     507         *
    464508         * @var string
    465509         */
    … …  
    473517         *
    474518         * @since 2.8.0
     519         *
    475520         * @see wpdb::prepare()
    476521         * @see wpdb::insert()
    … …  
    486531         *
    487532         * @since 2.2.0
     533         *
    488534         * @var string
    489535         */
    … …  
    494540         *
    495541         * @since 2.2.0
     542         *
    496543         * @var string
    497544         */
    … …  
    502549         *
    503550         * @since 2.9.0
     551         *
    504552         * @var string
    505553         */
    … …  
    510558         *
    511559         * @since 3.1.0
     560         *
    512561         * @var string
    513562         */
    … …  
    518567         *
    519568         * @since 3.1.0
     569         *
    520570         * @var string
    521571         */
    … …  
    526576         *
    527577         * @since 3.1.0
     578         *
    528579         * @var string
    529580         */
    … …  
    534585         *
    535586         * @since 0.71
     587         *
    536588         * @var string
    537589         */
    … …  
    542594         *
    543595         * @since 3.0.0
     596         *
    544597         * @var string
    545598         */
    … …  
    555608         *
    556609         * @since 3.3.0
     610         *
    557611         * @var bool
    558612         */
    … …  
    563617         *
    564618         * @since 3.9.0
     619         *
    565620         * @var array
    566621         */
    … …  
    578633         *
    579634         * @since 3.9.0
     635         *
    580636         * @var bool
    581637         */
    … …  
    586642         *
    587643         * @since 3.9.0
     644         *
    588645         * @var bool
    589646         */
    590647        private $has_connected = false;
     648
     649        /**
     650         * Time when the last query was performed.
     651         *
     652         * Only set when `SAVEQUERIES` is defined and truthy.
     653         *
     654         * @since 1.5.0
     655         *
     656         * @var float
     657         */
     658        public $time_start = null;
     659
     660        /**
     661         * The last SQL error that was encountered.
     662         *
     663         * @since 2.5.0
     664         *
     665         * @var WP_Error|string
     666         */
     667        public $error = null;
    591668
    592669        /**
Note: See TracChangeset for help on using the changeset viewer.