WordPress.org

Make WordPress Core

Changeset 48462


Ignore:
Timestamp:
07/13/2020 10:08:16 PM (3 months ago)
Author:
johnbillion
Message:

Docs: Miscellaneous docblock corrections and improvements.

See #49572

Location:
trunk/src
Files:
7 edited

Legend:

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

    r48450 r48462  
    798798         * Filters the number of items to be displayed on each page of the list table.
    799799         *
    800          * The dynamic hook name, $option, refers to the `per_page` option depending
    801          * on the type of list table in use. Possible values include: 'edit_comments_per_page',
    802          * 'sites_network_per_page', 'site_themes_network_per_page', 'themes_network_per_page',
    803          * 'users_network_per_page', 'edit_post_per_page', 'edit_page_per_page',
    804          * 'edit_{$post_type}_per_page', etc.
     800         * The dynamic hook name, `$option`, refers to the `per_page` option depending
     801         * on the type of list table in use. Possible filter names include:
     802         *
     803         *  - `edit_comments_per_page`
     804         *  - `sites_network_per_page`
     805         *  - `site_themes_network_per_page`
     806         *  - `themes_network_per_page'`
     807         *  - `users_network_per_page`
     808         *  - `edit_post_per_page`
     809         *  - `edit_page_per_page'`
     810         *  - `edit_{$post_type}_per_page`
     811         *  - `edit_post_tag_per_page`
     812         *  - `edit_category_per_page`
     813         *  - `edit_{$taxonomy}_per_page`
     814         *  - `site_users_network_per_page`
     815         *  - `users_per_page`
    805816         *
    806817         * @since 2.9.0
  • trunk/src/wp-includes/class-http.php

    r48109 r48462  
    238238
    239239        /**
    240          * Filters whether to preempt an HTTP request's return value.
     240         * Filters the preemptive return value of an HTTP request.
    241241         *
    242242         * Returning a non-false value from the filter will short-circuit the HTTP request and return
    243          * early with that value. A filter should return either:
     243         * early with that value. A filter should return one of:
    244244         *
    245245         *  - An array containing 'headers', 'body', 'response', 'cookies', and 'filename' elements
    246246         *  - A WP_Error instance
    247          *  - boolean false (to avoid short-circuiting the response)
     247         *  - boolean false to avoid short-circuiting the response
    248248         *
    249249         * Returning any other value may result in unexpected behaviour.
     
    251251         * @since 2.9.0
    252252         *
    253          * @param false|array|WP_Error $preempt     Whether to preempt an HTTP request's return value. Default false.
     253         * @param false|array|WP_Error $preempt     A preemptive return value of an HTTP request. Default false.
    254254         * @param array                $parsed_args HTTP request arguments.
    255255         * @param string               $url         The request URL.
  • trunk/src/wp-includes/class-wp-date-query.php

    r48121 r48462  
    4646     *
    4747     * @since 3.7.0
    48      * @var array
     48     * @var string
    4949     */
    5050    public $compare = '=';
  • trunk/src/wp-includes/class-wp-dependency.php

    r47399 r48462  
    2222     *
    2323     * @since 2.6.0
    24      * @var null
     24     * @var string
    2525     */
    2626    public $handle;
     
    3030     *
    3131     * @since 2.6.0
    32      * @var null
     32     * @var string
    3333     */
    3434    public $src;
     
    5656     *
    5757     * @since 2.6.0
    58      * @var null
     58     * @var array
    5959     */
    6060    public $args = null;  // Custom property, such as $in_footer or $media.
  • trunk/src/wp-includes/class-wp-post-type.php

    r47808 r48462  
    201201     *
    202202     * @since 4.6.0
    203      * @var string $register_meta_box_cb
     203     * @var callable $register_meta_box_cb
    204204     */
    205205    public $register_meta_box_cb = null;
  • trunk/src/wp-includes/class-wp-query.php

    r48426 r48462  
    656656     *     @type int|bool     $ignore_sticky_posts     Whether to ignore sticky posts or not. Setting this to false
    657657     *                                                 excludes stickies from 'post__in'. Accepts 1|true, 0|false.
    658      *                                                 Default 0|false.
     658     *                                                 Default false.
    659659     *     @type int          $m                       Combination YearMonth. Accepts any four-digit year and month
    660660     *                                                 numbers 1-12. Default empty.
     
    686686     *                                                 of `$meta_query`. Default is 'date', except when a search
    687687     *                                                 is being performed, when the default is 'relevance'.
    688      *
    689688     *     @type int          $p                       Post ID.
    690689     *     @type int          $page                    Show the number of posts that would show up on page X of a
     
    34353434     * @since 1.5.0
    34363435     *
     3436     * @see WP_Query::parse_query() for all available arguments.
     3437     *
    34373438     * @param string|array $query URL query string or array of query arguments.
    34383439     * @return WP_Post[]|int[] Array of post objects or post IDs.
     
    35463547     *
    35473548     * @since 1.5.0
     3549     *
     3550     * @see WP_Query::parse_query() for all available arguments.
    35483551     *
    35493552     * @param string|array $query URL query string or array of vars.
  • trunk/src/wp-includes/post.php

    r48356 r48462  
    23562356
    23572357/**
    2358  * Sanitize post field based on context.
     2358 * Sanitizes a post field based on context.
    23592359 *
    23602360 * Possible context values are:  'raw', 'edit', 'db', 'display', 'attribute' and
     
    23682368 * @param mixed  $value   The Post Object value.
    23692369 * @param int    $post_id Post ID.
    2370  * @param string $context Optional. How to sanitize post fields. Looks for 'raw', 'edit',
     2370 * @param string $context Optional. How to sanitize the field. Possible values are 'raw', 'edit',
    23712371 *                        'db', 'display', 'attribute' and 'js'. Default 'display'.
    23722372 * @return mixed Sanitized value.
     
    24952495             * @param int    $post_id Post ID.
    24962496             * @param string $context Context for how to sanitize the field. Possible
    2497              *                        values include 'raw', 'edit', 'db', 'display',
     2497             *                        values include 'edit', 'display',
    24982498             *                        'attribute' and 'js'.
    24992499             */
Note: See TracChangeset for help on using the changeset viewer.