WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
02/03/2020 12:17:38 AM (7 years 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-scripts.php

    r46661 r47170  
    176176         * @since 2.8.0 Added the `$group` parameter.
    177177         *
    178          * @param mixed     $handles Optional. Scripts to be printed. (void) prints queue, (string) prints
    179          *                           that script, (array of strings) prints those scripts. Default false.
    180          * @param int|false $group   Optional. If scripts were queued in groups prints this group number.
    181          *                           Default false.
     178         * @param string|string[]|false $handles Optional. Scripts to be printed: queue (false),
     179         *                                       single script (string), or multiple scripts (array of strings).
     180         *                                       Default false.
     181         * @param int|false             $group   Optional. Group level: level (int), no groups (false).
     182         *                                       Default false.
    182183         * @return string[] Handles of scripts that have been printed.
    183184         */
    … …  
    196197         *
    197198         * @param string $handle The script's registered handle.
    198          * @param bool   $echo   Optional. Whether to echo the extra script instead of just returning it.
    199          *                       Default true.
    200          * @return bool|string|void Void if no data exists, extra scripts if `$echo` is true, true otherwise.
     199         * @param bool   $echo   Optional. Whether to echo the extra script
     200         *                       instead of just returning it. Default true.
     201         * @return bool|string|void Void if no data exists, extra scripts if `$echo` is true,
     202         *                          true otherwise.
    201203         */
    202204        public function print_scripts_l10n( $handle, $echo = true ) {
    … …  
    211213         *
    212214         * @param string $handle The script's registered handle.
    213          * @param bool   $echo   Optional. Whether to echo the extra script instead of just returning it.
    214          *                       Default true.
    215          * @return bool|string|void Void if no data exists, extra scripts if `$echo` is true, true otherwise.
     215         * @param bool   $echo   Optional. Whether to echo the extra script
     216         *                       instead of just returning it. Default true.
     217         * @return bool|string|void Void if no data exists, extra scripts if `$echo` is true,
     218         *                          true otherwise.
    216219         */
    217220        public function print_extra_script( $handle, $echo = true ) {
    … …  
    252255         *
    253256         * @param string    $handle The script's registered handle.
    254          * @param int|false $group  Optional. Group level: (int) level, (false) no groups. Default false.
     257         * @param int|false $group  Optional. Group level: level (int), no groups (false).
     258         *                          Default false.
    255259         * @return bool True on success, false on failure.
    256260         */
    … …  
    410414         * @since 4.5.0
    411415         *
    412          * @param string $handle   Name of the script to add the inline script to. Must be lowercase.
     416         * @param string $handle   Name of the script to add the inline script to.
     417         *                         Must be lowercase.
    413418         * @param string $data     String containing the javascript to be added.
    414          * @param string $position Optional. Whether to add the inline script before the handle
    415          *                         or after. Default 'after'.
     419         * @param string $position Optional. Whether to add the inline script
     420         *                         before the handle or after. Default 'after'.
    416421         * @return bool True on success, false on failure.
    417422         */
    … …  
    436441         * @since 4.5.0
    437442         *
    438          * @param string $handle   Name of the script to add the inline script to. Must be lowercase.
    439          * @param string $position Optional. Whether to add the inline script before the handle
    440          *                         or after. Default 'after'.
    441          * @param bool   $echo     Optional. Whether to echo the script instead of just returning it.
    442          *                         Default true.
     443         * @param string $handle   Name of the script to add the inline script to.
     444         *                         Must be lowercase.
     445         * @param string $position Optional. Whether to add the inline script
     446         *                         before the handle or after. Default 'after'.
     447         * @param bool   $echo     Optional. Whether to echo the script
     448         *                         instead of just returning it. Default true.
    443449         * @return string|false Script on success, false otherwise.
    444450         */
    … …  
    511517         * @param string    $handle    Name of the item. Should be unique.
    512518         * @param bool      $recursion Internal flag that calling function was called recursively.
    513          * @param int|false $group     Optional. Group level: (int) level, (false) no groups. Default false.
    514          * @return bool Not already in the group or a lower group
     519         * @param int|false $group     Optional. Group level: level (int), no groups (false).
     520         *                             Default false.
     521         * @return bool Not already in the group or a lower group.
    515522         */
    516523        public function set_group( $handle, $recursion, $group = false ) {
    … …  
    559566         * @since 5.0.0
    560567         *
    561          * @param string $handle Name of the script to add the inline script to. Must be lowercase.
    562          * @param bool   $echo   Optional. Whether to echo the script instead of just returning it.
    563          *                       Default true.
     568         * @param string $handle Name of the script to add the inline script to.
     569         *                       Must be lowercase.
     570         * @param bool   $echo   Optional. Whether to echo the script
     571         *                       instead of just returning it. Default true.
    564572         * @return string|false Script on success, false otherwise.
    565573         */
    … …  
    601609         * @see WP_Dependencies::all_deps()
    602610         *
    603          * @param mixed     $handles   Item handle and argument (string) or item handles and arguments (array of strings).
    604          * @param bool      $recursion Internal flag that function is calling itself.
    605          * @param int|false $group     Optional. Group level: (int) level, (false) no groups. Default false.
     611         * @param string|string[] $handles   Item handle (string) or item handles (array of strings).
     612         * @param bool            $recursion Optional. Internal flag that function is calling itself.
     613         *                                   Default false.
     614         * @param int|false       $group     Optional. Group level: level (int), no groups (false).
     615         *                                   Default false.
    606616         * @return bool True on success, false on failure.
    607617         */
Note: See TracChangeset for help on using the changeset viewer.