X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/f5fcdc7994bb67cce809bc4777944ae8b7fad4a4..refs/tags/wordpress-4.3:/wp-includes/ms-blogs.php?ds=sidebyside diff --git a/wp-includes/ms-blogs.php b/wp-includes/ms-blogs.php index 74885b13..966fb73f 100644 --- a/wp-includes/ms-blogs.php +++ b/wp-includes/ms-blogs.php @@ -12,6 +12,8 @@ * Update the last_updated field for the current blog. * * @since MU + * + * @global wpdb $wpdb */ function wpmu_update_blogs_date() { global $wpdb; @@ -66,6 +68,8 @@ function get_blogaddress_by_name( $blogname ) { * * @since MU * + * @global wpdb $wpdb + * * @param string $slug * @return int A blog id */ @@ -97,8 +101,12 @@ function get_id_from_blogname( $slug ) { * * @since MU * - * @param int|string|array $fields A blog ID, a blog slug, or an array of fields to query against. Optional. If not specified the current blog ID is used. - * @param bool $get_all Whether to retrieve all details or only the details in the blogs table. Default is true. + * @global wpdb $wpdb + * + * @param int|string|array $fields Optional. A blog ID, a blog slug, or an array of fields to query against. + * If not specified the current blog ID is used. + * @param bool $get_all Whether to retrieve all details or only the details in the blogs table. + * Default is true. * @return object|false Blog details on success. False on failure. */ function get_blog_details( $fields = null, $get_all = true ) { @@ -272,7 +280,9 @@ function refresh_blog_details( $blog_id = 0 ) { * * @since MU * - * @param int $blog_id Blog ID + * @global wpdb $wpdb + * + * @param int $blog_id Blog ID * @param array $details Array of details keyed by blogs table field names. * @return bool True if update succeeds, false otherwise. */ @@ -444,9 +454,9 @@ function clean_blog_cache( $blog ) { * * @since MU * - * @param int $id A blog ID. Can be null to refer to the current blog. - * @param string $option Name of option to retrieve. Expected to not be SQL-escaped. - * @param mixed $default Optional. Default value to return if the option does not exist. + * @param int $id A blog ID. Can be null to refer to the current blog. + * @param string $option Name of option to retrieve. Expected to not be SQL-escaped. + * @param mixed $default Optional. Default value to return if the option does not exist. * @return mixed Value set for the option. */ function get_blog_option( $id, $option, $default = false ) { @@ -489,9 +499,9 @@ function get_blog_option( $id, $option, $default = false ) { * * @since MU * - * @param int $id A blog ID. Can be null to refer to the current blog. + * @param int $id A blog ID. Can be null to refer to the current blog. * @param string $option Name of option to add. Expected to not be SQL-escaped. - * @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped. + * @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped. * @return bool False if option was not added and true if option was added. */ function add_blog_option( $id, $option, $value ) { @@ -515,7 +525,7 @@ function add_blog_option( $id, $option, $value ) { * * @since MU * - * @param int $id A blog ID. Can be null to refer to the current blog. + * @param int $id A blog ID. Can be null to refer to the current blog. * @param string $option Name of option to remove. Expected to not be SQL-escaped. * @return bool True, if option is successfully deleted. False on failure. */ @@ -540,9 +550,9 @@ function delete_blog_option( $id, $option ) { * * @since MU * - * @param int $id The blog id + * @param int $id The blog id * @param string $option The option key - * @param mixed $value The option value + * @param mixed $value The option value * @return bool True on success, false on failure. */ function update_blog_option( $id, $option, $value, $deprecated = null ) { @@ -576,12 +586,19 @@ function update_blog_option( $id, $option, $value, $deprecated = null ) { * @see restore_current_blog() * @since MU * - * @param int $new_blog The id of the blog you want to switch to. Default: current blog + * @global wpdb $wpdb + * @global int $blog_id + * @global array $_wp_switched_stack + * @global bool $switched + * @global string $table_prefix + * @global WP_Object_Cache $wp_object_cache + * + * @param int $new_blog The id of the blog you want to switch to. Default: current blog * @param bool $deprecated Deprecated argument - * @return bool Always returns True. + * @return true Always returns True. */ function switch_to_blog( $new_blog, $deprecated = null ) { - global $wpdb, $wp_roles; + global $wpdb; if ( empty( $new_blog ) ) $new_blog = $GLOBALS['blog_id']; @@ -635,7 +652,7 @@ function switch_to_blog( $new_blog, $deprecated = null ) { } if ( did_action( 'init' ) ) { - $wp_roles->reinit(); + wp_roles()->reinit(); $current_user = wp_get_current_user(); $current_user->for_blog( $new_blog ); } @@ -653,10 +670,17 @@ function switch_to_blog( $new_blog, $deprecated = null ) { * @see switch_to_blog() * @since MU * + * @global wpdb $wpdb + * @global array $_wp_switched_stack + * @global int $blog_id + * @global bool $switched + * @global string $table_prefix + * @global WP_Object_Cache $wp_object_cache + * * @return bool True on success, false if we're already on the current blog */ function restore_current_blog() { - global $wpdb, $wp_roles; + global $wpdb; if ( empty( $GLOBALS['_wp_switched_stack'] ) ) return false; @@ -699,7 +723,7 @@ function restore_current_blog() { } if ( did_action( 'init' ) ) { - $wp_roles->reinit(); + wp_roles()->reinit(); $current_user = wp_get_current_user(); $current_user->for_blog( $blog ); } @@ -718,6 +742,8 @@ function restore_current_blog() { * * @since 3.5.0 * + * @global array $_wp_switched_stack + * * @return bool True if switched, false otherwise. */ function ms_is_switched() { @@ -741,7 +767,7 @@ function is_archived( $id ) { * * @since MU * - * @param int $id The blog id + * @param int $id The blog id * @param string $archived The new status * @return string $archived */ @@ -755,10 +781,13 @@ function update_archived( $id, $archived ) { * * @since MU * - * @param int $blog_id BLog ID - * @param string $pref A field name - * @param string $value Value for $pref - * @return string $value + * @global wpdb $wpdb + * + * @param int $blog_id BLog ID + * @param string $pref A field name + * @param string $value Value for $pref + * @param null $deprecated + * @return string|false $value */ function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) { global $wpdb; @@ -828,9 +857,11 @@ function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) { * * @since MU * - * @param int $id The blog id + * @global wpdb $wpdb + * + * @param int $id The blog id * @param string $pref A field name - * @return bool $value + * @return bool|string|null $value */ function get_blog_status( $id, $pref ) { global $wpdb; @@ -847,9 +878,11 @@ function get_blog_status( $id, $pref ) { * * @since MU * + * @global wpdb $wpdb + * * @param mixed $deprecated Not used - * @param int $start The offset - * @param int $quantity The maximum number of blogs to retrieve. Default is 40. + * @param int $start The offset + * @param int $quantity The maximum number of blogs to retrieve. Default is 40. * @return array The list of blogs */ function get_last_updated( $deprecated = '', $start = 0, $quantity = 40 ) { @@ -868,7 +901,7 @@ function get_last_updated( $deprecated = '', $start = 0, $quantity = 40 ) { * * @param string $new_status The new post status * @param string $old_status The old post status - * @param object $post Post object + * @param object $post Post object */ function _update_blog_date_on_post_publish( $new_status, $old_status, $post ) { $post_type_obj = get_post_type_object( $post->post_type );