Docs: Improve description for `get_blog_post()`.

Props stevenlinx.
Fixes #50655.

git-svn-id: https://develop.svn.wordpress.org/trunk@48467 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-07-14 11:05:01 +00:00
parent 80fae63d57
commit a128b52eb0
1 changed files with 5 additions and 2 deletions

View File

@ -132,13 +132,16 @@ function get_blog_count( $network_id = null ) {
} }
/** /**
* Get a blog post from any site on the network. * Gets a blog post from any site on the network.
*
* This function is similar to get_post(), except that it can retrieve a post
* from any site on the network, not just the current site.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
* @param int $blog_id ID of the blog. * @param int $blog_id ID of the blog.
* @param int $post_id ID of the post being looked for. * @param int $post_id ID of the post being looked for.
* @return WP_Post|null WP_Post on success or null on failure * @return WP_Post|null WP_Post object on success, null on failure
*/ */
function get_blog_post( $blog_id, $post_id ) { function get_blog_post( $blog_id, $post_id ) {
switch_to_blog( $blog_id ); switch_to_blog( $blog_id );