Docs: Misc docblock corrections and improvements.

See #49572

git-svn-id: https://develop.svn.wordpress.org/trunk@47754 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2020-05-03 19:36:06 +00:00
parent ef05acdfaa
commit 7d24075a26
3 changed files with 5 additions and 4 deletions

View File

@ -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.
*/

View File

@ -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.

View File

@ -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.