From a128b52eb02d4cb62f31015dd32d98fe9f697998 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Tue, 14 Jul 2020 11:05:01 +0000 Subject: [PATCH] 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 --- src/wp-includes/ms-functions.php | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/wp-includes/ms-functions.php b/src/wp-includes/ms-functions.php index 9707818787..3d670188cd 100644 --- a/src/wp-includes/ms-functions.php +++ b/src/wp-includes/ms-functions.php @@ -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) * * @param int $blog_id ID of the blog. * @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 ) { switch_to_blog( $blog_id );