Docs: Various docblock corrections.

See #53399

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


git-svn-id: http://core.svn.wordpress.org/trunk@51891 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2021-12-01 12:17:00 +00:00
parent 15d7d368f3
commit 9a982b4ae8
11 changed files with 27 additions and 23 deletions

View File

@ -687,8 +687,8 @@ function wp_exif_frac2dec( $str ) {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param string $str * @param string $str A date string expected to be in Exif format (Y:m:d H:i:s).
* @return int * @return int|false The unix timestamp, or false on failure.
*/ */
function wp_exif_date2ts( $str ) { function wp_exif_date2ts( $str ) {
list( $date, $time ) = explode( ' ', trim( $str ) ); list( $date, $time ) = explode( ' ', trim( $str ) );

View File

@ -209,8 +209,8 @@ function _wp_translate_postdata( $update = false, $post_data = null ) {
* *
* @since 5.0.1 * @since 5.0.1
* *
* @param array|null $post_data Optional. The array of post data to process. * @param array|WP_Error|null $post_data The array of post data to process, or an error object.
* Defaults to the `$_POST` superglobal. * Defaults to the `$_POST` superglobal.
* @return array|WP_Error Array of post data on success, WP_Error on failure. * @return array|WP_Error Array of post data on success, WP_Error on failure.
*/ */
function _wp_get_allowed_postdata( $post_data = null ) { function _wp_get_allowed_postdata( $post_data = null ) {

View File

@ -196,9 +196,9 @@ class WP_Block {
* @since 5.5.0 * @since 5.5.0
* *
* @param array $options { * @param array $options {
* Optional options object. * Optional options object.
* *
* @type bool $dynamic Defaults to 'true'. Optionally set to false to avoid using the block's render_callback. * @type bool $dynamic Defaults to 'true'. Optionally set to false to avoid using the block's render_callback.
* } * }
* @return string Rendered block output. * @return string Rendered block output.
*/ */

View File

@ -44,10 +44,12 @@ class WP_HTTP_Proxy {
/** /**
* Whether proxy connection should be used. * Whether proxy connection should be used.
* *
* @since 2.8.0 * Constants which control this behaviour:
* *
* @use WP_PROXY_HOST * - `WP_PROXY_HOST`
* @use WP_PROXY_PORT * - `WP_PROXY_PORT`
*
* @since 2.8.0
* *
* @return bool * @return bool
*/ */
@ -58,10 +60,12 @@ class WP_HTTP_Proxy {
/** /**
* Whether authentication should be used. * Whether authentication should be used.
* *
* @since 2.8.0 * Constants which control this behaviour:
* *
* @use WP_PROXY_USERNAME * - `WP_PROXY_USERNAME`
* @use WP_PROXY_PASSWORD * - `WP_PROXY_PASSWORD`
*
* @since 2.8.0
* *
* @return bool * @return bool
*/ */

View File

@ -2826,7 +2826,7 @@ class WP_Query {
* Filters all query clauses at once, for convenience. * Filters all query clauses at once, for convenience.
* *
* Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT, * Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT,
* fields (SELECT), and LIMITS clauses. * fields (SELECT), and LIMIT clauses.
* *
* @since 3.1.0 * @since 3.1.0
* *
@ -2950,7 +2950,7 @@ class WP_Query {
* For use by caching plugins. * For use by caching plugins.
* *
* Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT, * Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT,
* fields (SELECT), and LIMITS clauses. * fields (SELECT), and LIMIT clauses.
* *
* @since 3.1.0 * @since 3.1.0
* *

View File

@ -366,7 +366,7 @@ function get_lastcommentmodified( $timezone = 'server' ) {
* *
* @param int $post_id Optional. Restrict the comment counts to the given post. Default 0, which indicates that * @param int $post_id Optional. Restrict the comment counts to the given post. Default 0, which indicates that
* comment counts for the whole site will be retrieved. * comment counts for the whole site will be retrieved.
* @return array() { * @return array {
* The number of comments keyed by their status. * The number of comments keyed by their status.
* *
* @type int $approved The number of approved comments. * @type int $approved The number of approved comments.

View File

@ -4224,7 +4224,7 @@ function wp_prepare_attachment_for_js( $attachment ) {
* @param array $args { * @param array $args {
* Arguments for enqueuing media scripts. * Arguments for enqueuing media scripts.
* *
* @type int|WP_Post A post object or ID. * @type int|WP_Post $post A post object or ID.
* } * }
*/ */
function wp_enqueue_media( $args = array() ) { function wp_enqueue_media( $args = array() ) {

View File

@ -1307,7 +1307,7 @@ function wp_delete_signup_on_user_delete( $id, $reassign, $user ) {
* This function runs when a user self-registers as well as when * This function runs when a user self-registers as well as when
* a Super Admin creates a new user. Hook to {@see 'wpmu_new_user'} for events * a Super Admin creates a new user. Hook to {@see 'wpmu_new_user'} for events
* that should affect all new users, but only on Multisite (otherwise * that should affect all new users, but only on Multisite (otherwise
* use {@see'user_register'}). * use {@see 'user_register'}).
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *

View File

@ -16,7 +16,7 @@ if ( ! class_exists( 'Translation_Entry', false ) ) :
/** /**
* Whether the entry contains a string and its plural form, default is false * Whether the entry contains a string and its plural form, default is false
* *
* @var boolean * @var bool
*/ */
public $is_plural = false; public $is_plural = false;

View File

@ -4636,10 +4636,10 @@ function get_term_link( $term, $taxonomy = '' ) {
* Arguments about which post to use and how to format the output. Shares all of the arguments * Arguments about which post to use and how to format the output. Shares all of the arguments
* supported by get_the_taxonomies(), in addition to the following. * supported by get_the_taxonomies(), in addition to the following.
* *
* @type int|WP_Post $post Post ID or object to get taxonomies of. Default current post. * @type int|WP_Post $post Post ID or object to get taxonomies of. Default current post.
* @type string $before Displays before the taxonomies. Default empty string. * @type string $before Displays before the taxonomies. Default empty string.
* @type string $sep Separates each taxonomy. Default is a space. * @type string $sep Separates each taxonomy. Default is a space.
* @type string $after Displays after the taxonomies. Default empty string. * @type string $after Displays after the taxonomies. Default empty string.
* } * }
*/ */
function the_taxonomies( $args = array() ) { function the_taxonomies( $args = array() ) {

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.9-beta1-52298'; $wp_version = '5.9-beta1-52299';
/** /**
* 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.