Make WordPress Core

Changeset 58037


Ignore:
Timestamp:
04/23/2024 12:36:49 PM (6 months ago)
Author:
swissspidy
Message:

Docs: Improve incorrect indentation/alignment in a few docblocks.

See #60699.

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

Legend:

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

    r58033 r58037  
    55945594 * @param string $filename Path to an AVIF file.
    55955595 * @return array {
    5596  *    An array of AVIF image information.
    5597  *
    5598  *    @type int|false $width        Image width on success, false on failure.
    5599  *    @type int|false $height       Image height on success, false on failure.
    5600  *    @type int|false $bit_depth    Image bit depth on success, false on failure.
    5601  *    @type int|false $num_channels Image number of channels on success, false on failure.
     5596 *     An array of AVIF image information.
     5597 *
     5598 *     @type int|false $width        Image width on success, false on failure.
     5599 *     @type int|false $height       Image height on success, false on failure.
     5600 *     @type int|false $bit_depth    Image bit depth on success, false on failure.
     5601 *     @type int|false $num_channels Image number of channels on success, false on failure.
    56025602 * }
    56035603 */
  • trunk/src/wp-includes/script-modules.php

    r57644 r58037  
    3737 * @since 6.5.0
    3838 *
    39  * @param string            $id       The identifier of the script module. Should be unique. It will be used in the
    40  *                                    final import map.
    41  * @param string            $src      Optional. Full URL of the script module, or path of the script module relative
    42  *                                    to the WordPress root directory. If it is provided and the script module has
    43  *                                    not been registered yet, it will be registered.
    44  * @param array             $deps     {
    45  *                                        Optional. List of dependencies.
     39 * @param string            $id      The identifier of the script module. Should be unique. It will be used in the
     40 *                                   final import map.
     41 * @param string            $src     Optional. Full URL of the script module, or path of the script module relative
     42 *                                   to the WordPress root directory. If it is provided and the script module has
     43 *                                   not been registered yet, it will be registered.
     44 * @param array             $deps    {
     45 *                                       Optional. List of dependencies.
    4646 *
    47  *                                        @type string|array ...$0 {
    48  *                                            An array of script module identifiers of the dependencies of this script
    49  *                                            module. The dependencies can be strings or arrays. If they are arrays,
    50  *                                            they need an `id` key with the script module identifier, and can contain
    51  *                                            an `import` key with either `static` or `dynamic`. By default,
    52  *                                            dependencies that don't contain an `import` key are considered static.
     47 *                                       @type string|array ...$0 {
     48 *                                           An array of script module identifiers of the dependencies of this script
     49 *                                           module. The dependencies can be strings or arrays. If they are arrays,
     50 *                                           they need an `id` key with the script module identifier, and can contain
     51 *                                           an `import` key with either `static` or `dynamic`. By default,
     52 *                                           dependencies that don't contain an `import` key are considered static.
    5353 *
    54  *                                            @type string $id     The script module identifier.
    55  *                                            @type string $import Optional. Import type. May be either `static` or
    56  *                                                                 `dynamic`. Defaults to `static`.
    57  *                                        }
    58  *                                    }
    59  * @param string|false|null $version  Optional. String specifying the script module version number. Defaults to false.
    60  *                                    It is added to the URL as a query string for cache busting purposes. If $version
    61  *                                    is set to false, the version number is the currently installed WordPress version.
    62  *                                    If $version is set to null, no version is added.
     54 *                                           @type string $id     The script module identifier.
     55 *                                           @type string $import Optional. Import type. May be either `static` or
     56 *                                                                `dynamic`. Defaults to `static`.
     57 *                                       }
     58 *                                   }
     59 * @param string|false|null $version Optional. String specifying the script module version number. Defaults to false.
     60 *                                   It is added to the URL as a query string for cache busting purposes. If $version
     61 *                                   is set to false, the version number is the currently installed WordPress version.
     62 *                                   If $version is set to null, no version is added.
    6363 */
    6464function wp_register_script_module( string $id, string $src, array $deps = array(), $version = false ) {
     
    7474 * @since 6.5.0
    7575 *
    76  * @param string            $id       The identifier of the script module. Should be unique. It will be used in the
    77  *                                    final import map.
    78  * @param string            $src      Optional. Full URL of the script module, or path of the script module relative
    79  *                                    to the WordPress root directory. If it is provided and the script module has
    80  *                                    not been registered yet, it will be registered.
    81  * @param array             $deps     {
    82  *                                        Optional. List of dependencies.
     76 * @param string            $id      The identifier of the script module. Should be unique. It will be used in the
     77 *                                   final import map.
     78 * @param string            $src     Optional. Full URL of the script module, or path of the script module relative
     79 *                                   to the WordPress root directory. If it is provided and the script module has
     80 *                                   not been registered yet, it will be registered.
     81 * @param array             $deps    {
     82 *                                       Optional. List of dependencies.
    8383 *
    84  *                                        @type string|array ...$0 {
    85  *                                            An array of script module identifiers of the dependencies of this script
    86  *                                            module. The dependencies can be strings or arrays. If they are arrays,
    87  *                                            they need an `id` key with the script module identifier, and can contain
    88  *                                            an `import` key with either `static` or `dynamic`. By default,
    89  *                                            dependencies that don't contain an `import` key are considered static.
     84 *                                       @type string|array ...$0 {
     85 *                                           An array of script module identifiers of the dependencies of this script
     86 *                                           module. The dependencies can be strings or arrays. If they are arrays,
     87 *                                           they need an `id` key with the script module identifier, and can contain
     88 *                                           an `import` key with either `static` or `dynamic`. By default,
     89 *                                           dependencies that don't contain an `import` key are considered static.
    9090 *
    91  *                                            @type string $id     The script module identifier.
    92  *                                            @type string $import Optional. Import type. May be either `static` or
    93  *                                                                 `dynamic`. Defaults to `static`.
    94  *                                        }
    95  *                                    }
    96  * @param string|false|null $version  Optional. String specifying the script module version number. Defaults to false.
    97  *                                    It is added to the URL as a query string for cache busting purposes. If $version
    98  *                                    is set to false, the version number is the currently installed WordPress version.
    99  *                                    If $version is set to null, no version is added.
     91 *                                           @type string $id     The script module identifier.
     92 *                                           @type string $import Optional. Import type. May be either `static` or
     93 *                                                                `dynamic`. Defaults to `static`.
     94 *                                       }
     95 *                                   }
     96 * @param string|false|null $version Optional. String specifying the script module version number. Defaults to false.
     97 *                                   It is added to the URL as a query string for cache busting purposes. If $version
     98 *                                   is set to false, the version number is the currently installed WordPress version.
     99 *                                   If $version is set to null, no version is added.
    100100 */
    101101function wp_enqueue_script_module( string $id, string $src = '', array $deps = array(), $version = false ) {
Note: See TracChangeset for help on using the changeset viewer.