Docs: Improve description for `add_user_to_blog()`.

Props stevenlinx.
Fixes #50701.

git-svn-id: https://develop.svn.wordpress.org/trunk@48511 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-07-20 11:52:59 +00:00
parent 030f2a4eee
commit 0c19e1abd0
1 changed files with 2 additions and 2 deletions

View File

@ -152,7 +152,7 @@ function get_blog_post( $blog_id, $post_id ) {
}
/**
* Adds a user to a blog.
* Adds a user to a blog, along with specifying the user's role.
*
* Use the {@see 'add_user_to_blog'} action to fire an event when users are added to a blog.
*
@ -160,7 +160,7 @@ function get_blog_post( $blog_id, $post_id ) {
*
* @param int $blog_id ID of the blog the user is being added to.
* @param int $user_id ID of the user being added.
* @param string $role The role you want the user to have
* @param string $role The role you want the user to have.
* @return true|WP_Error True on success or a WP_Error object if the user doesn't exist
* or could not be added.
*/