WordPress.org

Make WordPress Core


Ignore:
Timestamp:
02/03/2020 12:17:38 AM (17 months ago)
Author:
SergeyBiryukov
Message:

Docs: Improve documentation for WP_Dependencies, WP_Scripts, and WP_Styles methods.

See #48303.

File:
1 edited

Legend:

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

    r47122 r47170  
    8484     * @since 2.8.0 Added the `$group` parameter.
    8585     *
    86      * @param mixed     $handles Optional. Items to be processed: Process queue (false), process item (string), process items (array of strings).
    87      * @param int|false $group   Optional. Group level: level (int), no groups (false).
     86     * @param string|string[]|false $handles Optional. Items to be processed: queue (false),
     87     *                                       single item (string), or multiple items (array of strings).
     88     *                                       Default false.
     89     * @param int|false             $group   Optional. Group level: level (int), no groups (false).
    8890     * @return string[] Array of handles of items that have been processed.
    8991     */
     
    137139     * @since 2.8.0 Added the `$group` parameter.
    138140     *
    139      * @param string|string[] $handles   Item handle and argument (string) or item handles and arguments (array of strings).
    140      * @param bool            $recursion Internal flag that function is calling itself.
    141      * @param int|false       $group     Group level: (int) level, (false) no groups.
     141     * @param string|string[] $handles   Item handle (string) or item handles (array of strings).
     142     * @param bool            $recursion Optional. Internal flag that function is calling itself.
     143     *                                   Default false.
     144     * @param int|false       $group     Optional. Group level: level (int), no groups (false).
     145     *                                   Default false.
    142146     * @return bool True on success, false on failure.
    143147     */
     
    204208     *
    205209     * @param string           $handle Name of the item. Should be unique.
    206      * @param string|bool      $src    Full URL of the item, or path of the item relative to the WordPress root directory.
    207      *                                 If source is set to false, item is an alias of other items it depends on.
    208      * @param string[]         $deps   Optional. An array of registered item handles this item depends on. Default empty array.
    209      * @param string|bool|null $ver    Optional. String specifying item version number, if it has one, which is added to the URL
    210      *                                 as a query string for cache busting purposes. If version is set to false, a version
    211      *                                 number is automatically added equal to current installed WordPress version.
     210     * @param string|bool      $src    Full URL of the item, or path of the item relative
     211     *                                 to the WordPress root directory. If source is set to false,
     212     *                                 item is an alias of other items it depends on.
     213     * @param string[]         $deps   Optional. An array of registered item handles this item depends on.
     214     *                                 Default empty array.
     215     * @param string|bool|null $ver    Optional. String specifying item version number, if it has one,
     216     *                                 which is added to the URL as a query string for cache busting purposes.
     217     *                                 If version is set to false, a version number is automatically added
     218     *                                 equal to current installed WordPress version.
    212219     *                                 If set to null, no version is added.
    213      * @param mixed            $args   Optional. Custom property of the item. NOT the class property $args. Examples: $media, $in_footer.
     220     * @param mixed            $args   Optional. Custom property of the item. NOT the class property $args.
     221     *                                 Examples: $media, $in_footer.
    214222     * @return bool Whether the item has been registered. True on success, false on failure.
    215223     */
     
    231239     * @param string $handle Name of the item. Should be unique.
    232240     * @param string $key    The data key.
    233      * @param mixed $value  The data value.
     241     * @param string $value  The data value.
    234242     * @return bool True on success, false on failure.
    235243     */
     
    251259     * @param string $handle Name of the item. Should be unique.
    252260     * @param string $key    The data key.
    253      * @return mixed Extra item data (string), false otherwise.
     261     * @return string|false Extra item data (string), false otherwise.
    254262     */
    255263    public function get_data( $handle, $key ) {
     
    271279     * @since 2.6.0 Moved from `WP_Scripts`.
    272280     *
    273      * @param string|string[] $handles Item handle and argument (string) or item handles and arguments (array of strings).
    274      * @return void
     281     * @param string|string[] $handles Item handle (string) or item handles (array of strings).
    275282     */
    276283    public function remove( $handles ) {
     
    291298     * @since 2.6.0 Moved from `WP_Scripts`.
    292299     *
    293      * @param string|string[] $handles Item handle and argument (string) or item handles and arguments (array of strings).
     300     * @param string|string[] $handles Item handle (string) or item handles (array of strings).
    294301     */
    295302    public function enqueue( $handles ) {
     
    314321     * @since 2.6.0 Moved from `WP_Scripts`.
    315322     *
    316      * @param string|string[] $handles Item handle and argument (string) or item handles and arguments (array of strings).
     323     * @param string|string[] $handles Item handle (string) or item handles (array of strings).
    317324     */
    318325    public function dequeue( $handles ) {
     
    359366     *
    360367     * @param string $handle Name of the item. Should be unique.
    361      * @param string $list   Property name of list array.
     368     * @param string $list   Optional. Property name of list array. Default 'registered'.
    362369     * @return bool|_WP_Dependency Found, or object Item data.
    363370     */
     
    394401     * @since 2.8.0
    395402     *
    396      * @param string $handle    Name of the item. Should be unique.
    397      * @param bool   $recursion Internal flag that calling function was called recursively.
    398      * @param mixed  $group     Group level.
    399      * @return bool Not already in the group or a lower group
     403     * @param string    $handle    Name of the item. Should be unique.
     404     * @param bool      $recursion Internal flag that calling function was called recursively.
     405     * @param int|false $group     Group level: level (int), no groups (false).
     406     * @return bool Not already in the group or a lower group.
    400407     */
    401408    public function set_group( $handle, $recursion, $group ) {
Note: See TracChangeset for help on using the changeset viewer.