From 7d24075a267eb8ba256a3fa15d41f80e227d2003 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Sun, 3 May 2020 19:36:06 +0000 Subject: [PATCH] Docs: Misc docblock corrections and improvements. See #49572 git-svn-id: https://develop.svn.wordpress.org/trunk@47754 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-block-type-registry.php | 1 + src/wp-includes/cron.php | 4 ++-- src/wp-includes/ms-functions.php | 4 ++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/wp-includes/class-wp-block-type-registry.php b/src/wp-includes/class-wp-block-type-registry.php index 0cc3e94c18..2cddfb07e8 100644 --- a/src/wp-includes/class-wp-block-type-registry.php +++ b/src/wp-includes/class-wp-block-type-registry.php @@ -43,6 +43,7 @@ final class WP_Block_Type_Registry { * * @type callable $render_callback Callback used to render blocks of this block type. * @type array $attributes Block attributes mapping, property name to schema. + * Accepts any public property of `WP_Block_Type`. * } * @return WP_Block_Type|false The registered block type on success, or false on failure. */ diff --git a/src/wp-includes/cron.php b/src/wp-includes/cron.php index e6957c35c3..7337ba307e 100644 --- a/src/wp-includes/cron.php +++ b/src/wp-includes/cron.php @@ -130,8 +130,8 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array() ) { * * @since 3.1.0 * - * @param stdClass $event { - * An object containing an event's data. + * @param stdClass|false $event { + * An object containing an event's data, or boolean false to prevent the event from being scheduled. * * @type string $hook Action hook to execute when the event is run. * @type int $timestamp Unix timestamp (UTC) for when to next run the event. diff --git a/src/wp-includes/ms-functions.php b/src/wp-includes/ms-functions.php index 688b758263..dae8d4f742 100644 --- a/src/wp-includes/ms-functions.php +++ b/src/wp-includes/ms-functions.php @@ -176,8 +176,8 @@ function add_user_to_blog( $blog_id, $user_id, $role ) { * * @since 4.9.0 * - * @param bool|WP_Error $retval True if the user should be added to the site, false - * or error object otherwise. + * @param true|WP_Error $retval True if the user should be added to the site, error + * object otherwise. * @param int $user_id User ID. * @param string $role User role. * @param int $blog_id Site ID.