WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Miscellaneous formatting corrections for docblocks. 

See #53399

Built from https://develop.svn.wordpress.org/trunk@51299


git-svn-id: http://core.svn.wordpress.org/trunk@50908 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2021-07-01 21:10:56 +00:00
parent 79685db062
commit 9146628ae1
10 changed files with 51 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
wp-includes/block-supports/elements.php
View File

@ -12,9 +12,9 @@
* @since 5.8.0 * @since 5.8.0
* @access private * @access private
* *
* @param string $block_content Rendered block content. * @param string $block_content Rendered block content.
* @param array $block Block object. * @param array $block Block object.
* @return string Filtered block content. * @return string Filtered block content.
*/ */
function wp_render_elements_support( $block_content, $block ) { function wp_render_elements_support( $block_content, $block ) {
$link_color = null; $link_color = null;
@ -23,11 +23,11 @@ function wp_render_elements_support( $block_content, $block ) {
} }
/* /*
* For now we only care about link color. * For now we only care about link color.
* This code in the future when we have a public API * This code in the future when we have a public API
* should take advantage of WP_Theme_JSON::compute_style_properties * should take advantage of WP_Theme_JSON::compute_style_properties
* and work for any element and style. * and work for any element and style.
*/ */
if ( null === $link_color ) { if ( null === $link_color ) {
return $block_content; return $block_content;
} }

6
wp-includes/block-supports/layout.php
View File

@ -35,9 +35,9 @@ function wp_register_layout_support( $block_type ) {
* @since 5.8.0 * @since 5.8.0
* @access private * @access private
* *
* @param string $block_content Rendered block content. * @param string $block_content Rendered block content.
* @param array $block Block object. * @param array $block Block object.
* @return string Filtered block content. * @return string Filtered block content.
*/ */
function wp_render_layout_support_flag( $block_content, $block ) { function wp_render_layout_support_flag( $block_content, $block ) {
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] ); $block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );

2
wp-includes/class-http.php
View File

@ -110,7 +110,7 @@ class WP_Http {
* Some transports technically allow others, but should not be * Some transports technically allow others, but should not be
* assumed. Default 'GET'. * assumed. Default 'GET'.
* @type float $timeout How long the connection should stay open in seconds. Default 5. * @type float $timeout How long the connection should stay open in seconds. Default 5.
* @type int $redirection Number of allowed redirects. Not supported by all transports * @type int $redirection Number of allowed redirects. Not supported by all transports.
* Default 5. * Default 5.
* @type string $httpversion Version of the HTTP protocol to use. Accepts '1.0' and '1.1'. * @type string $httpversion Version of the HTTP protocol to use. Accepts '1.0' and '1.1'.
* Default '1.0'. * Default '1.0'.

20
wp-includes/class-wp-query.php
View File

@ -18,7 +18,7 @@
class WP_Query { class WP_Query {
/** /**
* Query vars set by the user * Query vars set by the user.
* *
* @since 1.5.0 * @since 1.5.0
* @var array * @var array
@ -26,7 +26,7 @@ class WP_Query {
public $query; public $query;
/** /**
* Query vars, after parsing * Query vars, after parsing.
* *
* @since 1.5.0 * @since 1.5.0
* @var array * @var array
@ -34,7 +34,7 @@ class WP_Query {
public $query_vars = array(); public $query_vars = array();
/** /**
* Taxonomy query, as passed to get_tax_sql() * Taxonomy query, as passed to get_tax_sql().
* *
* @since 3.1.0 * @since 3.1.0
* @var WP_Tax_Query A taxonomy query instance. * @var WP_Tax_Query A taxonomy query instance.
@ -42,7 +42,7 @@ class WP_Query {
public $tax_query; public $tax_query;
/** /**
* Metadata query container * Metadata query container.
* *
* @since 3.2.0 * @since 3.2.0
* @var WP_Meta_Query A meta query instance. * @var WP_Meta_Query A meta query instance.
@ -50,7 +50,7 @@ class WP_Query {
public $meta_query = false; public $meta_query = false;
/** /**
* Date query container * Date query container.
* *
* @since 3.7.0 * @since 3.7.0
* @var WP_Date_Query A date query instance. * @var WP_Date_Query A date query instance.
@ -92,7 +92,7 @@ class WP_Query {
public $posts; public $posts;
/** /**
* The amount of posts for the current query. * The number of posts for the current query.
* *
* @since 1.5.0 * @since 1.5.0
* @var int * @var int
@ -135,7 +135,7 @@ class WP_Query {
public $comments; public $comments;
/** /**
* The amount of comments for the posts. * The number of comments for the posts.
* *
* @since 2.2.0 * @since 2.2.0
* @var int * @var int
@ -159,7 +159,7 @@ class WP_Query {
public $comment; public $comment;
/** /**
* The amount of found posts for the current query. * The number of found posts for the current query.
* *
* If limit clause was not used, equals $post_count. * If limit clause was not used, equals $post_count.
* *
@ -169,7 +169,7 @@ class WP_Query {
public $found_posts = 0; public $found_posts = 0;
/** /**
* The amount of pages. * The number of pages.
* *
* @since 2.1.0 * @since 2.1.0
* @var int * @var int
@ -177,7 +177,7 @@ class WP_Query {
public $max_num_pages = 0; public $max_num_pages = 0;
/** /**
* The amount of comment pages. * The number of comment pages.
* *
* @since 2.7.0 * @since 2.7.0
* @var int * @var int

41
wp-includes/class-wp-term-query.php
View File

@ -94,20 +94,21 @@ class WP_Term_Query {
* *
* @type string|array $taxonomy Taxonomy name, or array of taxonomies, to which results should * @type string|array $taxonomy Taxonomy name, or array of taxonomies, to which results should
* be limited. * be limited.
* @type int|int[] $object_ids Optional. Object ID, or array of object IDs. Results will be * @type int|int[] $object_ids Object ID, or array of object IDs. Results will be
* limited to terms associated with these objects. * limited to terms associated with these objects.
* @type string $orderby Field(s) to order terms by. Accepts: * @type string $orderby Field(s) to order terms by. Accepts:
* * term fields ('name', 'slug', 'term_group', 'term_id', 'id', * * Term fields ('name', 'slug', 'term_group', 'term_id', 'id',
* 'description', 'parent', 'term_order'). Unless `$object_ids` * 'description', 'parent', 'term_order'). Unless `$object_ids`
* is not empty, 'term_order' is treated the same as 'term_id'. * is not empty, 'term_order' is treated the same as 'term_id'.
* * 'count' to use the number of objects associated with the term. * * 'count' to use the number of objects associated with the term.
* * 'include' to match the 'order' of the $include param. * * 'include' to match the 'order' of the `$include` param.
* * 'slug__in' to match the 'order' of the $slug param. * * 'slug__in' to match the 'order' of the `$slug` param.
* * 'meta_value', 'meta_value_num'. * * 'meta_value'
* the value of `$meta_key`. * * 'meta_value_num'.
* the array keys of `$meta_query`. * * The value of `$meta_key`.
* * The array keys of `$meta_query`.
* * 'none' to omit the ORDER BY clause. * * 'none' to omit the ORDER BY clause.
* Defaults to 'name'. * Default 'name'.
* @type string $order Whether to order terms in ascending or descending order. * @type string $order Whether to order terms in ascending or descending order.
* Accepts 'ASC' (ascending) or 'DESC' (descending). * Accepts 'ASC' (ascending) or 'DESC' (descending).
* Default 'ASC'. * Default 'ASC'.
@ -116,14 +117,14 @@ class WP_Term_Query {
* @type int[]|string $include Array or comma/space-separated string of term IDs to include. * @type int[]|string $include Array or comma/space-separated string of term IDs to include.
* Default empty array. * Default empty array.
* @type int[]|string $exclude Array or comma/space-separated string of term IDs to exclude. * @type int[]|string $exclude Array or comma/space-separated string of term IDs to exclude.
* If $include is non-empty, $exclude is ignored. * If `$include` is non-empty, `$exclude` is ignored.
* Default empty array. * Default empty array.
* @type int[]|string $exclude_tree Array or comma/space-separated string of term IDs to exclude * @type int[]|string $exclude_tree Array or comma/space-separated string of term IDs to exclude
* along with all of their descendant terms. If $include is * along with all of their descendant terms. If `$include` is
* non-empty, $exclude_tree is ignored. Default empty array. * non-empty, `$exclude_tree` is ignored. Default empty array.
* @type int|string $number Maximum number of terms to return. Accepts ''|0 (all) or any * @type int|string $number Maximum number of terms to return. Accepts ''|0 (all) or any
* positive number. Default ''|0 (all). Note that $number may * positive number. Default ''|0 (all). Note that $number may
* not return accurate results when coupled with $object_ids. * not return accurate results when coupled with `$object_ids`.
* See #41796 for details. * See #41796 for details.
* @type int $offset The number by which to offset the terms query. Default empty. * @type int $offset The number by which to offset the terms query. Default empty.
* @type string $fields Term fields to query for. Accepts: * @type string $fields Term fields to query for. Accepts:
@ -145,14 +146,14 @@ class WP_Term_Query {
* Default 'all'. * Default 'all'.
* @type bool $count Whether to return a term count. If true, will take precedence * @type bool $count Whether to return a term count. If true, will take precedence
* over `$fields`. Default false. * over `$fields`. Default false.
* @type string|array $name Optional. Name or array of names to return term(s) for. * @type string|array $name Name or array of names to return term(s) for.
* Default empty. * Default empty.
* @type string|array $slug Optional. Slug or array of slugs to return term(s) for. * @type string|array $slug Slug or array of slugs to return term(s) for.
* Default empty. * Default empty.
* @type int|int[] $term_taxonomy_id Optional. Term taxonomy ID, or array of term taxonomy IDs, * @type int|int[] $term_taxonomy_id Term taxonomy ID, or array of term taxonomy IDs,
* to match when querying terms. * to match when querying terms.
* @type bool $hierarchical Whether to include terms that have non-empty descendants * @type bool $hierarchical Whether to include terms that have non-empty descendants
* (even if $hide_empty is set to true). Default true. * (even if `$hide_empty` is set to true). Default true.
* @type string $search Search criteria to match terms. Will be SQL-formatted with * @type string $search Search criteria to match terms. Will be SQL-formatted with
* wildcards before and after. Default empty. * wildcards before and after. Default empty.
* @type string $name__like Retrieve terms with criteria by which a term is LIKE * @type string $name__like Retrieve terms with criteria by which a term is LIKE
@ -163,8 +164,8 @@ class WP_Term_Query {
* quantity of each term's "count" object variable. * quantity of each term's "count" object variable.
* Default false. * Default false.
* @type string $get Whether to return terms regardless of ancestry or whether the * @type string $get Whether to return terms regardless of ancestry or whether the
* terms are empty. Accepts 'all' or empty (disabled). * terms are empty. Accepts 'all' or '' (disabled).
* Default empty. * Default ''.
* @type int $child_of Term ID to retrieve child terms of. If multiple taxonomies * @type int $child_of Term ID to retrieve child terms of. If multiple taxonomies
* are passed, `$child_of` is ignored. Default 0. * are passed, `$child_of` is ignored. Default 0.
* @type int $parent Parent term ID to retrieve direct-child terms of. * @type int $parent Parent term ID to retrieve direct-child terms of.
@ -173,9 +174,9 @@ class WP_Term_Query {
* This parameter has no effect on non-hierarchical taxonomies. * This parameter has no effect on non-hierarchical taxonomies.
* Default false. * Default false.
* @type string $cache_domain Unique cache key to be produced when this query is stored in * @type string $cache_domain Unique cache key to be produced when this query is stored in
* an object cache. Default is 'core'. * an object cache. Default 'core'.
* @type bool $update_term_meta_cache Whether to prime meta caches for matched terms. Default true. * @type bool $update_term_meta_cache Whether to prime meta caches for matched terms. Default true.
* @type array $meta_query Optional. Meta query clauses to limit retrieved terms by. * @type array $meta_query Meta query clauses to limit retrieved terms by.
* See `WP_Meta_Query`. Default empty. * See `WP_Meta_Query`. Default empty.
* @type string $meta_key Limit terms to those matching a specific metadata key. * @type string $meta_key Limit terms to those matching a specific metadata key.
* Can be used in conjunction with `$meta_value`. Default empty. * Can be used in conjunction with `$meta_value`. Default empty.

2
wp-includes/load.php
View File

@ -675,7 +675,7 @@ function wp_start_object_cache() {
* @since 5.8.0 * @since 5.8.0
* *
* @param bool $enable_object_cache Whether to enable loading object-cache.php (if present). * @param bool $enable_object_cache Whether to enable loading object-cache.php (if present).
* Default true. * Default true.
*/ */
if ( $first_init && apply_filters( 'enable_loading_object_cache_dropin', true ) ) { if ( $first_init && apply_filters( 'enable_loading_object_cache_dropin', true ) ) {
if ( ! function_exists( 'wp_cache_init' ) ) { if ( ! function_exists( 'wp_cache_init' ) ) {

2
wp-includes/nav-menu.php
View File

@ -159,7 +159,7 @@ function get_registered_nav_menus() {
* *
* @since 3.0.0 * @since 3.0.0
* *
* @return int[] Associative array of egistered navigation menu IDs keyed by their * @return int[] Associative array of registered navigation menu IDs keyed by their
* location name. If none are registered, an empty array. * location name. If none are registered, an empty array.
*/ */
function get_nav_menu_locations() { function get_nav_menu_locations() {

3
wp-includes/pluggable.php
View File

@ -2785,8 +2785,7 @@ if ( ! function_exists( 'get_avatar' ) ) :
* @param int $size Square avatar width and height in pixels to retrieve. * @param int $size Square avatar width and height in pixels to retrieve.
* @param string $default URL for the default image or a default type. Accepts '404', 'retro', 'monsterid', * @param string $default URL for the default image or a default type. Accepts '404', 'retro', 'monsterid',
* 'wavatar', 'indenticon', 'mystery', 'mm', 'mysteryman', 'blank', or 'gravatar_default'. * 'wavatar', 'indenticon', 'mystery', 'mm', 'mysteryman', 'blank', or 'gravatar_default'.
* Default is the value of the 'avatar_default' option, with a fallback of 'mystery'. * @param string $alt Alternative text to use in the avatar image tag.
* @param string $alt Alternative text to use in the avatar image tag. Default empty.
* @param array $args Arguments passed to get_avatar_data(), after processing. * @param array $args Arguments passed to get_avatar_data(), after processing.
*/ */
return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args ); return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );

8
wp-includes/post.php
View File

@ -1391,7 +1391,7 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
* @type bool $public Whether a post type is intended for use publicly either via * @type bool $public Whether a post type is intended for use publicly either via
* the admin interface or by front-end users. While the default * the admin interface or by front-end users. While the default
* settings of $exclude_from_search, $publicly_queryable, $show_ui, * settings of $exclude_from_search, $publicly_queryable, $show_ui,
* and $show_in_nav_menus are inherited from public, each does not * and $show_in_nav_menus are inherited from $public, each does not
* rely on this relationship and controls a very specific intention. * rely on this relationship and controls a very specific intention.
* Default false. * Default false.
* @type bool $hierarchical Whether the post type is hierarchical (e.g. page). Default false. * @type bool $hierarchical Whether the post type is hierarchical (e.g. page). Default false.
@ -1417,11 +1417,11 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
* of $show_in_menu. * of $show_in_menu.
* @type bool $show_in_rest Whether to include the post type in the REST API. Set this to true * @type bool $show_in_rest Whether to include the post type in the REST API. Set this to true
* for the post type to be available in the block editor. * for the post type to be available in the block editor.
* @type string $rest_base To change the base url of REST API route. Default is $post_type. * @type string $rest_base To change the base URL of REST API route. Default is $post_type.
* @type string $rest_controller_class REST API Controller class name. Default is 'WP_REST_Posts_Controller'. * @type string $rest_controller_class REST API controller class name. Default is 'WP_REST_Posts_Controller'.
* @type int $menu_position The position in the menu order the post type should appear. To work, * @type int $menu_position The position in the menu order the post type should appear. To work,
* $show_in_menu must be true. Default null (at the bottom). * $show_in_menu must be true. Default null (at the bottom).
* @type string $menu_icon The url to the icon to be used for this menu. Pass a base64-encoded * @type string $menu_icon The URL to the icon to be used for this menu. Pass a base64-encoded
* SVG using a data URI, which will be colored to match the color scheme * SVG using a data URI, which will be colored to match the color scheme
* -- this should begin with 'data:image/svg+xml;base64,'. Pass the name * -- this should begin with 'data:image/svg+xml;base64,'. Pass the name
* of a Dashicons helper class to use a font icon, e.g. * of a Dashicons helper class to use a font icon, e.g.

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.9-alpha-51298'; $wp_version = '5.9-alpha-51299';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.