Changeset 38943

Timestamp:

10/26/2016 03:38:48 AM (3 years ago)

Author:

jeremyfelt

Message:

Multisite: Replace get_blog_details() in inline documentation.

Some documentation is now out of date and some can be replaced with a mention of get_site().

Fixes #37102.

Location:

trunk/src/wp-includes

Files:

• ms-blogs.php (modified) (1 diff)
• ms-deprecated.php (modified) (1 diff)
• ms-functions.php (modified) (1 diff)
• ms-load.php (modified) (2 diffs)

trunk/src/wp-includes/ms-blogs.php

@@ -444 +444 @@
  * @since 3.5.0
  *
- * @param WP_Site $blog The blog details as returned from get_blog_details()
+ * @param WP_Site $blog The site object to be cleared from cache.
  */
 function clean_blog_cache( $blog ) {

trunk/src/wp-includes/ms-deprecated.php

@@ -20 +20 @@
  * @since MU
  * @deprecated 3.1.0 Use get_site()
- * @see get_blog_details()
- *
- * @return int Current site ID.
+ * @see get_site()
+ *
+ * @return WP_Site Current site object.
  */
 function get_dashboard_blog() {

trunk/src/wp-includes/ms-functions.php

@@ -1763 +1763 @@
  * WordPress MS stores a blog's post count as an option so as
  * to avoid extraneous COUNTs when a blog's details are fetched
- * with get_blog_details(). This function is called when posts
- * are published or unpublished to make sure the count stays current.
+ * with get_site(). This function is called when posts are published
+ * or unpublished to make sure the count stays current.
  *
  * @since MU

trunk/src/wp-includes/ms-load.php

@@ -212 +212 @@
     /*
      * @todo
-     * get_blog_details(), caching, etc. Consider alternative optimization routes,
+     * caching, etc. Consider alternative optimization routes,
      * perhaps as an opt-in for plugins, rather than using the pre_* filter.
      * For example: The segments filter can expand or ignore paths.
@@ -244 +244 @@
 
     if ( $site ) {
-        // @todo get_blog_details()
         return $site;
     }