WordPress.org
Get WordPress

Make WordPress Core

Changeset 52422


Ignore:
Timestamp:
12/29/2021 05:26:26 PM (5 years ago)
Author:
johnbillion
Message:

Docs: Miscellaneous inline documentation improvements.

See #53399

Location:
trunk/src
Files:
12 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/plugin-install.php

    r52419 r52422  
    137137         * Filters the response for the current WordPress.org Plugin Installation API request.
    138138         *
    139          * Passing a non-false value will effectively short-circuit the WordPress.org API request.
     139         * Returning a non-false value will effectively short-circuit the WordPress.org API request.
    140140         *
    141141         * If `$action` is 'query_plugins' or 'plugin_information', an object MUST be passed.

  • trunk/src/wp-admin/includes/theme.php

    r52406 r52422  
    522522         * Filters whether to override the WordPress.org Themes API.
    523523         *
    524          * Passing a non-false value will effectively short-circuit the WordPress.org API request.
     524         * Returning a non-false value will effectively short-circuit the WordPress.org API request.
    525525         *
    526526         * If `$action` is 'query_themes', 'theme_information', or 'feature_list', an object MUST

  • trunk/src/wp-admin/options-reading.php

    r51475 r52422  
    192192         * By default the privacy options form displays a single checkbox to 'discourage' search
    193193         * engines from indexing the site. Hooking to this action serves a dual purpose:
     194         *
    194195         * 1. Disable the single checkbox in favor of a multiple-choice list of radio buttons.
    195196         * 2. Open the door to adding additional radio button choices to the list.

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

    r52328 r52422  
    436436
    437437                /**
    438                  * Filters the HTTP API response immediately before the response is returned.
     438                 * Filters a successful HTTP API response immediately before the response is returned.
    439439                 *
    440440                 * @since 2.9.0

  • trunk/src/wp-includes/class-wp-list-util.php

    r52066 r52422  
    1010 * List utility.
    1111 *
    12  * Utility class to handle operations on an array of objects.
     12 * Utility class to handle operations on an array of objects or arrays.
    1313 *
    1414 * @since 4.7.0
    … …  
    141141
    142142        /**
    143          * Plucks a certain field out of each object in the list.
     143         * Plucks a certain field out of each element in the input array.
    144144         *
    145145         * This has the same functionality and prototype of
    … …  
    148148         * @since 4.7.0
    149149         *
    150          * @param int|string $field     Field from the object to place instead of the entire object
    151          * @param int|string $index_key Optional. Field from the object to use as keys for the new array.
     150         * @param int|string $field     Field to fetch from the object or array.
     151         * @param int|string $index_key Optional. Field from the element to use as keys for the new array.
    152152         *                              Default null.
    153153         * @return array Array of found values. If `$index_key` is set, an array of found values with keys
    … …  
    202202
    203203        /**
    204          * Sorts the list, based on one or more orderby arguments.
     204         * Sorts the input array based on one or more orderby arguments.
    205205         *
    206206         * @since 4.7.0
    … …  
    240240
    241241        /**
    242          * Callback to sort the list by specific fields.
     242         * Callback to sort an array by specific fields.
    243243         *
    244244         * @since 4.7.0

  • trunk/src/wp-includes/class-wp-xmlrpc-server.php

    r52026 r52422  
    64006400                 * Filters whether to preempt the XML-RPC media upload.
    64016401                 *
    6402                  * Passing a truthy value will effectively short-circuit the media upload,
     6402                 * Returning a truthy value will effectively short-circuit the media upload,
    64036403                 * returning that value as a 500 error instead.
    64046404                 *

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

    r52416 r52422  
    51075107
    51085108/**
    5109  * Pluck a certain field out of each object in a list.
     5109 * Plucks a certain field out of each object or array in an array.
    51105110 *
    51115111 * This has the same functionality and prototype of
    … …  
    51315131
    51325132/**
    5133  * Sorts a list of objects, based on one or more orderby arguments.
     5133 * Sorts an array of objects or arrays based on one or more orderby arguments.
    51345134 *
    51355135 * @since 4.7.0

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

    r52208 r52422  
    27212721                 * Allows the HTML for a user's avatar to be returned early.
    27222722                 *
    2723                  * Passing a non-null value will effectively short-circuit get_avatar(), passing
     2723                 * Returning a non-null value will effectively short-circuit get_avatar(), passing
    27242724                 * the value through the {@see 'get_avatar'} filter and returning early.
    27252725                 *

  • trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php

    r52204 r52422  
    7676                 * Filters the posts URL list before it is generated.
    7777                 *
    78                  * Passing a non-null value will effectively short-circuit the generation,
     78                 * Returning a non-null value will effectively short-circuit the generation,
    7979                 * returning that value instead.
    8080                 *

  • trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php

    r52204 r52422  
    7272                 * Filters the taxonomies URL list before it is generated.
    7373                 *
    74                  * Passing a non-null value will effectively short-circuit the generation,
     74                 * Returning a non-null value will effectively short-circuit the generation,
    7575                 * returning that value instead.
    7676                 *

  • trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-users.php

    r52204 r52422  
    4141                 * Filters the users URL list before it is generated.
    4242                 *
    43                  * Passing a non-null value will effectively short-circuit the generation,
     43                 * Returning a non-null value will effectively short-circuit the generation,
    4444                 * returning that value instead.
    4545                 *
    … …  
    102102                 * Filters the max number of pages for a user sitemap before it is generated.
    103103                 *
    104                  * Passing a non-null value will effectively short-circuit the generation,
     104                 * Returning a non-null value will effectively short-circuit the generation,
    105105                 * returning that value instead.
    106106                 *

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

    r52373 r52422  
    28772877                 * Filters the table charset value before the DB is checked.
    28782878                 *
    2879                  * Passing a non-null value to the filter will effectively short-circuit
     2879                 * Returning a non-null value from the filter will effectively short-circuit
    28802880                 * checking the DB for the charset, returning that value instead.
    28812881                 *
Note: See TracChangeset for help on using the changeset viewer.