Ticket #14953: switch_to_blog and restore_current_blog inline docs.diff

wp-includes/ms-blogs.php

@@ -370 +370 @@
         wp_cache_set( $id."-".$key."-blog_option", $value, 'site-options');
 }
 
+/**
+ * Switches the blog (also referred to as a site) currently in use 
+ * by WordPress.
+ * 
+ * Beware: If you are running a WP Object cache you may find some
+ * options retain their values from the old blog, you could hook 
+ * the switch_blog action and delete or switch caches to 
+ * address this.
+ * 
+ * @since 3.0.0
+ *
+ * @param int $blog_id The ID of the blog/site to switch to
+ * @param bool $validate Whether to check the existence of the blog before switching
+ * @uses get_blog_details() If validation is required
+ * @uses $wpdb To change the DB tables being queried
+ * @return bool True if the switch was successful, otherwise false
+ **/
 function switch_to_blog( $new_blog, $validate = false ) {
         global $wpdb, $table_prefix, $blog_id, $switched, $switched_stack, $wp_roles, $wp_object_cache;
 
@@ -432 +449 @@
         return true;
 }
 
+/**
+ * Restores the previous blog (also referred to as a site) that was in use 
+ * by WordPress.
+ * 
+ * @since 3.0.0
+ *
+ * @uses $wpdb To change the DB tables being queried
+ * @return bool True if the restoration has been successful, otherwise false
+ **/
 function restore_current_blog() {
         global $table_prefix, $wpdb, $blog_id, $switched, $switched_stack, $wp_roles, $wp_object_cache;