WordPress.org

Make WordPress Core

Changeset 49942


Ignore:
Timestamp:
01/07/2021 02:15:27 PM (10 months ago)
Author:
johnbillion
Message:

Docs: Miscellaneous docblock corrections and improvements.

See #51800.

Location:
trunk/src
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-list-table.php

    r49599 r49942  
    397397         *
    398398         * The dynamic portion of the hook name, `$this->screen->id`, refers
    399          * to the ID of the current screen, usually a string.
     399         * to the ID of the current screen.
    400400         *
    401401         * @since 3.1.0
  • trunk/src/wp-admin/includes/file.php

    r49936 r49942  
    735735 *     @type string[] $upload_error_strings     The strings that describe the error indicated in
    736736 *                                              `$_FILES[{form field}]['error']`.
    737  *     @type bool     $test_form                Whether to test that the `$_POST['action]` parameter is as expected.
     737 *     @type bool     $test_form                Whether to test that the `$_POST['action']` parameter is as expected.
    738738 *     @type bool     $test_size                Whether to test that the file size is greater than zero bytes.
    739739 *     @type bool     $test_type                Whether to test that the mime type of the file is as expected.
  • trunk/src/wp-includes/option.php

    r49936 r49942  
    23242324 * @global array $wp_registered_settings
    23252325 *
    2326  * @param string   $option_group The settings group name used during registration.
    2327  * @param string   $option_name  The name of the option to unregister.
    2328  * @param callable $deprecated   Deprecated.
     2326 * @param string          $option_group The settings group name used during registration.
     2327 * @param string          $option_name  The name of the option to unregister.
     2328 * @param callable|string $deprecated   Deprecated.
    23292329 */
    23302330function unregister_setting( $option_group, $option_name, $deprecated = '' ) {
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

    r49927 r49942  
    18611861
    18621862        /**
    1863          * Filters the post data for a response.
     1863         * Filters the post data for a REST API response.
    18641864         *
    18651865         * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
     1866         *
     1867         * Possible filter names include:
     1868         *
     1869         *  - `rest_prepare_post`
     1870         *  - `rest_prepare_page`
     1871         *  - `rest_prepare_attachment`
    18661872         *
    18671873         * @since 4.7.0
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

    r49927 r49942  
    829829
    830830        /**
    831          * Filters a term item returned from the REST API.
     831         * Filters the term data for a REST API response.
    832832         *
    833833         * The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
     834         *
     835         * Possible filter names include:
     836         *
     837         *  - `rest_prepare_category`
     838         *  - `rest_prepare_post_tag`
    834839         *
    835840         * Allows modification of the term data right before it is returned.
  • trunk/src/wp-includes/wp-db.php

    r49912 r49942  
    20842084    public function log_query( $query, $query_time, $query_callstack, $query_start, $query_data ) {
    20852085        /**
    2086          * Filters the custom query data being logged.
     2086         * Filters the custom data to log alongside a query.
    20872087         *
    20882088         * Caution should be used when modifying any of this data, it is recommended that any additional
    2089          * information you need to store about a query be added as a new associative entry to the fourth
    2090          * element $query_data.
     2089         * information you need to store about a query be added as a new associative array element.
    20912090         *
    20922091         * @since 5.3.0
     
    36473646
    36483647    /**
    3649      * Retrieves the name of the function that called wpdb.
    3650      *
    3651      * Searches up the list of functions until it reaches the one that would
    3652      * most logically had called this method.
     3648     * Retrieves a comma-separated list of the names of the functions that called wpdb.
    36533649     *
    36543650     * @since 2.5.0
Note: See TracChangeset for help on using the changeset viewer.