WordPress.org
Get WordPress

Make WordPress Core

Changeset 53878


Ignore:
Timestamp:
08/11/2022 02:09:04 PM (3 years ago)
Author:
johnbillion
Message:

Docs: Miscellaneous inline documentation improvements.

See #55646

Location:
trunk
Files:
9 edited

Legend:

Unmodified
Added
Removed

  • trunk/README.md

    r50697 r53878  
    5252
    5353```
    54 npm run env:cli <command>
     54npm run env:cli -- <command>
    5555```
    5656
    57 WP-CLI has a lot of [useful commands](https://developer.wordpress.org/cli/commands/) you can use to work on your WordPress site. Where the documentation mentions running `wp`, run `npm run env:cli` instead. For example:
     57WP-CLI has [many useful commands](https://developer.wordpress.org/cli/commands/) you can use to work on your WordPress site. Where the documentation mentions running `wp`, run `npm run env:cli --` instead. For example:
    5858
    5959```
    60 npm run env:cli help
     60npm run env:cli -- help
    6161```
    6262

  • trunk/src/wp-includes/class-wp-block-supports.php

    r52236 r53878  
    7272     *
    7373     * @since 5.6.0
     74     *
     75     * @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-supports/
    7476     *
    7577     * @param string $block_support_name   Block support name.

  • trunk/src/wp-includes/class-wp-customize-control.php

    r51927 r53878  
    168168     * Supplied `$args` override class property defaults.
    169169     *
    170      * If `$args['settings']` is not defined, use the $id as the setting ID.
     170     * If `$args['settings']` is not defined, use the `$id` as the setting ID.
    171171     *
    172172     * @since 3.4.0

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

    r53791 r53878  
    12061206
    12071207/**
    1208  * Upgrade a Cron info array.
    1209  *
    1210  * This function upgrades the Cron info array to version 2.
     1208 * Upgrade a cron info array.
     1209 *
     1210 * This function upgrades the cron info array to version 2.
    12111211 *
    12121212 * @since 2.1.0
    … …  
    12141214 *
    12151215 * @param array $cron Cron info array from _get_cron_array().
    1216  * @return array An upgraded Cron info array.
     1216 * @return array An upgraded cron info array.
    12171217 */
    12181218function _upgrade_cron_array( $cron ) {

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

    r53811 r53878  
    48954895 * @param array $array   An array from which we want to retrieve some information.
    48964896 * @param array $path    An array of keys describing the path with which to retrieve information.
    4897  * @param mixed $default The return value if the path does not exist within the array,
    4898  *                       or if `$array` or `$path` are not arrays.
     4897 * @param mixed $default Optional. The return value if the path does not exist within the array,
     4898 *                       or if `$array` or `$path` are not arrays. Default null.
    48994899 * @return mixed The value from the path specified.
    49004900 */

  • trunk/src/wp-includes/https-detection.php

    r52332 r53878  
    179179 * @access private
    180180 *
    181  * @param array $request The Cron request arguments.
    182  * @return array The filtered Cron request arguments.
     181 * @param array $request The cron request arguments.
     182 * @return array The filtered cron request arguments.
    183183 */
    184184function wp_cron_conditionally_prevent_sslverify( $request ) {

  • trunk/src/wp-includes/link-template.php

    r53877 r53878  
    41624162 *                           user email, WP_User object, WP_Post object, or WP_Comment object.
    41634163 * @param array $args {
    4164  *     Optional. Arguments to return instead of the default arguments.
     4164 *     Optional. Arguments to use instead of the default arguments.
    41654165 *
    41664166 *     @type int    $size           Height and width of the avatar in pixels. Default 96.
    … …  
    42144214 * @since 4.2.0
    42154215 *
    4216  * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
     4216 * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
    42174217 *                           user email, WP_User object, WP_Post object, or WP_Comment object.
    42184218 * @param array $args {
    4219  *     Optional. Arguments to return instead of the default arguments.
     4219 *     Optional. Arguments to use instead of the default arguments.
    42204220 *
    42214221 *     @type int    $size           Height and width of the avatar image file in pixels. Default 96.
    … …  
    43194319     *
    43204320     * @param array $args        Arguments passed to get_avatar_data(), after processing.
    4321      * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
     4321     * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
    43224322     *                           user email, WP_User object, WP_Post object, or WP_Comment object.
    43234323     */
    … …  
    44104410     *
    44114411     * @param string $url         The URL of the avatar.
    4412      * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
     4412     * @param mixed  $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
    44134413     *                            user email, WP_User object, WP_Post object, or WP_Comment object.
    44144414     * @param array  $args        Arguments passed to get_avatar_data(), after processing.
    … …  
    44224422     *
    44234423     * @param array $args        Arguments passed to get_avatar_data(), after processing.
    4424      * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
     4424     * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
    44254425     *                           user email, WP_User object, WP_Post object, or WP_Comment object.
    44264426     */

  • trunk/src/wp-includes/ms-blogs.php

    r53832 r53878  
    7676
    7777/**
    78  * Retrieves a sites ID given its (subdomain or directory) slug.
     78 * Retrieves a site's ID given its (subdomain or directory) slug.
    7979 *
    8080 * @since MU (3.0.0)

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

    r53877 r53878  
    32183218 * Checks a MIME-Type against a list.
    32193219 *
    3220  * If the wildcard_mime_types parameter is a string, it must be comma separated
    3221  * list. If the real_mime_types is a string, it is also comma separated to
     3220 * If the `$wildcard_mime_types` parameter is a string, it must be comma separated
     3221 * list. If the `$real_mime_types` is a string, it is also comma separated to
    32223222 * create the list.
    32233223 *
    32243224 * @since 2.5.0
    32253225 *
    3226  * @param string|string[] $wildcard_mime_types Mime types, e.g. audio/mpeg or image (same as image/*)
    3227  *                                             or flash (same as *flash*).
     3226 * @param string|string[] $wildcard_mime_types Mime types, e.g. `audio/mpeg`, `image` (same as `image/*`),
     3227 *                                             or `flash` (same as `*flash*`).
    32283228 * @param string|string[] $real_mime_types     Real post mime type values.
    32293229 * @return array array(wildcard=>array(real types)).
Note: See TracChangeset for help on using the changeset viewer.