Make WordPress Core

Changeset 51299


Ignore:
Timestamp:
07/01/2021 09:09:04 PM (5 years ago)
Author:
johnbillion
Message:

Docs: Miscellaneous formatting corrections for docblocks.

See #53399

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

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/block-supports/elements.php

    r51051 r51299  
    1313 * @access private
    1414 *
    15  * @param  string $block_content Rendered block content.
    16  * @param  array  $block         Block object.
    17  * @return string                Filtered block content.
     15 * @param string $block_content Rendered block content.
     16 * @param array  $block         Block object.
     17 * @return string Filtered block content.
    1818 */
    1919function wp_render_elements_support( $block_content, $block ) {
     
    2424
    2525        /*
    26         * For now we only care about link color.
    27         * This code in the future when we have a public API
    28         * should take advantage of WP_Theme_JSON::compute_style_properties
    29         * and work for any element and style.
    30         */
     26         * For now we only care about link color.
     27         * This code in the future when we have a public API
     28         * should take advantage of WP_Theme_JSON::compute_style_properties
     29         * and work for any element and style.
     30         */
    3131        if ( null === $link_color ) {
    3232                return $block_content;
  • trunk/src/wp-includes/block-supports/layout.php

    r50991 r51299  
    3636 * @access private
    3737 *
    38  * @param  string $block_content Rendered block content.
    39  * @param  array  $block         Block object.
    40  * @return string                Filtered block content.
     38 * @param string $block_content Rendered block content.
     39 * @param array  $block         Block object.
     40 * @return string Filtered block content.
    4141 */
    4242function wp_render_layout_support_flag( $block_content, $block ) {
  • trunk/src/wp-includes/class-http.php

    r49927 r51299  
    111111         *                                             assumed. Default 'GET'.
    112112         *     @type float        $timeout             How long the connection should stay open in seconds. Default 5.
    113          *     @type int          $redirection         Number of allowed redirects. Not supported by all transports
     113         *     @type int          $redirection         Number of allowed redirects. Not supported by all transports.
    114114         *                                             Default 5.
    115115         *     @type string       $httpversion         Version of the HTTP protocol to use. Accepts '1.0' and '1.1'.
  • trunk/src/wp-includes/class-wp-query.php

    r51285 r51299  
    1919
    2020        /**
    21          * Query vars set by the user
     21         * Query vars set by the user.
    2222         *
    2323         * @since 1.5.0
     
    2727
    2828        /**
    29          * Query vars, after parsing
     29         * Query vars, after parsing.
    3030         *
    3131         * @since 1.5.0
     
    3535
    3636        /**
    37          * Taxonomy query, as passed to get_tax_sql()
     37         * Taxonomy query, as passed to get_tax_sql().
    3838         *
    3939         * @since 3.1.0
     
    4343
    4444        /**
    45          * Metadata query container
     45         * Metadata query container.
    4646         *
    4747         * @since 3.2.0
     
    5151
    5252        /**
    53          * Date query container
     53         * Date query container.
    5454         *
    5555         * @since 3.7.0
     
    9393
    9494        /**
    95          * The amount of posts for the current query.
     95         * The number of posts for the current query.
    9696         *
    9797         * @since 1.5.0
     
    136136
    137137        /**
    138          * The amount of comments for the posts.
     138         * The number of comments for the posts.
    139139         *
    140140         * @since 2.2.0
     
    160160
    161161        /**
    162          * The amount of found posts for the current query.
     162         * The number of found posts for the current query.
    163163         *
    164164         * If limit clause was not used, equals $post_count.
     
    170170
    171171        /**
    172          * The amount of pages.
     172         * The number of pages.
    173173         *
    174174         * @since 2.1.0
     
    178178
    179179        /**
    180          * The amount of comment pages.
     180         * The number of comment pages.
    181181         *
    182182         * @since 2.7.0
  • trunk/src/wp-includes/class-wp-term-query.php

    r51298 r51299  
    9595         *     @type string|array $taxonomy               Taxonomy name, or array of taxonomies, to which results should
    9696         *                                                be limited.
    97          *     @type int|int[]    $object_ids             Optional. Object ID, or array of object IDs. Results will be
     97         *     @type int|int[]    $object_ids             Object ID, or array of object IDs. Results will be
    9898         *                                                limited to terms associated with these objects.
    9999         *     @type string       $orderby                Field(s) to order terms by. Accepts:
    100          *                                                * term fields ('name', 'slug', 'term_group', 'term_id', 'id',
     100         *                                                * Term fields ('name', 'slug', 'term_group', 'term_id', 'id',
    101101         *                                                  'description', 'parent', 'term_order'). Unless `$object_ids`
    102102         *                                                  is not empty, 'term_order' is treated the same as 'term_id'.
    103103         *                                                * 'count' to use the number of objects associated with the term.
    104          *                                                * 'include' to match the 'order' of the $include param.
    105          *                                                * 'slug__in' to match the 'order' of the $slug param.
    106          *                                                * 'meta_value', 'meta_value_num'.
    107          *                                                  the value of `$meta_key`.
    108          *                                                  the array keys of `$meta_query`.
     104         *                                                * 'include' to match the 'order' of the `$include` param.
     105         *                                                * 'slug__in' to match the 'order' of the `$slug` param.
     106         *                                                * 'meta_value'
     107         *                                                * 'meta_value_num'.
     108         *                                                * The value of `$meta_key`.
     109         *                                                * The array keys of `$meta_query`.
    109110         *                                                * 'none' to omit the ORDER BY clause.
    110          *                                                Defaults to 'name'.
     111         *                                                Default 'name'.
    111112         *     @type string       $order                  Whether to order terms in ascending or descending order.
    112113         *                                                Accepts 'ASC' (ascending) or 'DESC' (descending).
     
    117118         *                                                Default empty array.
    118119         *     @type int[]|string $exclude                Array or comma/space-separated string of term IDs to exclude.
    119          *                                                If $include is non-empty, $exclude is ignored.
     120         *                                                If `$include` is non-empty, `$exclude` is ignored.
    120121         *                                                Default empty array.
    121122         *     @type int[]|string $exclude_tree           Array or comma/space-separated string of term IDs to exclude
    122          *                                                along with all of their descendant terms. If $include is
    123          *                                                non-empty, $exclude_tree is ignored. Default empty array.
     123         *                                                along with all of their descendant terms. If `$include` is
     124         *                                                non-empty, `$exclude_tree` is ignored. Default empty array.
    124125         *     @type int|string   $number                 Maximum number of terms to return. Accepts ''|0 (all) or any
    125126         *                                                positive number. Default ''|0 (all). Note that $number may
    126          *                                                not return accurate results when coupled with $object_ids.
     127         *                                                not return accurate results when coupled with `$object_ids`.
    127128         *                                                See #41796 for details.
    128129         *     @type int          $offset                 The number by which to offset the terms query. Default empty.
     
    146147         *     @type bool         $count                  Whether to return a term count. If true, will take precedence
    147148         *                                                over `$fields`. Default false.
    148          *     @type string|array $name                   Optional. Name or array of names to return term(s) for.
     149         *     @type string|array $name                   Name or array of names to return term(s) for.
    149150         *                                                Default empty.
    150          *     @type string|array $slug                   Optional. Slug or array of slugs to return term(s) for.
     151         *     @type string|array $slug                   Slug or array of slugs to return term(s) for.
    151152         *                                                Default empty.
    152          *     @type int|int[]    $term_taxonomy_id       Optional. Term taxonomy ID, or array of term taxonomy IDs,
     153         *     @type int|int[]    $term_taxonomy_id       Term taxonomy ID, or array of term taxonomy IDs,
    153154         *                                                to match when querying terms.
    154155         *     @type bool         $hierarchical           Whether to include terms that have non-empty descendants
    155          *                                                (even if $hide_empty is set to true). Default true.
     156         *                                                (even if `$hide_empty` is set to true). Default true.
    156157         *     @type string       $search                 Search criteria to match terms. Will be SQL-formatted with
    157158         *                                                wildcards before and after. Default empty.
     
    164165         *                                                Default false.
    165166         *     @type string       $get                    Whether to return terms regardless of ancestry or whether the
    166          *                                                terms are empty. Accepts 'all' or empty (disabled).
    167          *                                                Default empty.
     167         *                                                terms are empty. Accepts 'all' or '' (disabled).
     168         *                                                Default ''.
    168169         *     @type int          $child_of               Term ID to retrieve child terms of. If multiple taxonomies
    169170         *                                                are passed, `$child_of` is ignored. Default 0.
     
    174175         *                                                Default false.
    175176         *     @type string       $cache_domain           Unique cache key to be produced when this query is stored in
    176          *                                                an object cache. Default is 'core'.
     177         *                                                an object cache. Default 'core'.
    177178         *     @type bool         $update_term_meta_cache Whether to prime meta caches for matched terms. Default true.
    178          *     @type array        $meta_query             Optional. Meta query clauses to limit retrieved terms by.
     179         *     @type array        $meta_query             Meta query clauses to limit retrieved terms by.
    179180         *                                                See `WP_Meta_Query`. Default empty.
    180181         *     @type string       $meta_key               Limit terms to those matching a specific metadata key.
  • trunk/src/wp-includes/load.php

    r51221 r51299  
    676676         *
    677677         * @param bool $enable_object_cache Whether to enable loading object-cache.php (if present).
    678          *                                    Default true.
     678         *                                  Default true.
    679679         */
    680680        if ( $first_init && apply_filters( 'enable_loading_object_cache_dropin', true ) ) {
  • trunk/src/wp-includes/nav-menu.php

    r50828 r51299  
    160160 * @since 3.0.0
    161161 *
    162  * @return int[] Associative array of egistered navigation menu IDs keyed by their
     162 * @return int[] Associative array of registered navigation menu IDs keyed by their
    163163 *               location name. If none are registered, an empty array.
    164164 */
  • trunk/src/wp-includes/pluggable.php

    r50952 r51299  
    27862786                 * @param string $default     URL for the default image or a default type. Accepts '404', 'retro', 'monsterid',
    27872787                 *                            'wavatar', 'indenticon', 'mystery', 'mm', 'mysteryman', 'blank', or 'gravatar_default'.
    2788                  *                            Default is the value of the 'avatar_default' option, with a fallback of 'mystery'.
    2789                  * @param string $alt         Alternative text to use in the avatar image tag. Default empty.
     2788                 * @param string $alt         Alternative text to use in the avatar image tag.
    27902789                 * @param array  $args        Arguments passed to get_avatar_data(), after processing.
    27912790                 */
  • trunk/src/wp-includes/post.php

    r51298 r51299  
    13921392 *                                               the admin interface or by front-end users. While the default
    13931393 *                                               settings of $exclude_from_search, $publicly_queryable, $show_ui,
    1394  *                                               and $show_in_nav_menus are inherited from public, each does not
     1394 *                                               and $show_in_nav_menus are inherited from $public, each does not
    13951395 *                                               rely on this relationship and controls a very specific intention.
    13961396 *                                               Default false.
     
    14181418 *     @type bool         $show_in_rest          Whether to include the post type in the REST API. Set this to true
    14191419 *                                               for the post type to be available in the block editor.
    1420  *     @type string       $rest_base             To change the base url of REST API route. Default is $post_type.
    1421  *     @type string       $rest_controller_class REST API Controller class name. Default is 'WP_REST_Posts_Controller'.
     1420 *     @type string       $rest_base             To change the base URL of REST API route. Default is $post_type.
     1421 *     @type string       $rest_controller_class REST API controller class name. Default is 'WP_REST_Posts_Controller'.
    14221422 *     @type int          $menu_position         The position in the menu order the post type should appear. To work,
    14231423 *                                               $show_in_menu must be true. Default null (at the bottom).
    1424  *     @type string       $menu_icon             The url to the icon to be used for this menu. Pass a base64-encoded
     1424 *     @type string       $menu_icon             The URL to the icon to be used for this menu. Pass a base64-encoded
    14251425 *                                               SVG using a data URI, which will be colored to match the color scheme
    14261426 *                                               -- this should begin with 'data:image/svg+xml;base64,'. Pass the name
Note: See TracChangeset for help on using the changeset viewer.