WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Networks and Sites: Improve documentation and variable naming in `switch_to_blog()` and `restore_current_blog()`. 

In `switch_to_blog()`:

* Rename `$blog_id` to `$prev_blog_id` for clarity.
* Rename `$new_blog` to `$new_blog_id` for consistency.
* Pass `$prev_blog_id` as a second parameter to `switch_blog` action, instead of the duplicated `$new_blog_id`. This only clarifies documentation and does not affect functionality, since the values are equal in the context where the DocBlock is located.

In `restore_current_blog()`:

* Rename `$blog` to `$new_blog_id` for clarity.
* Rename `$blog_id` to `$prev_blog_id` for clarity.

Props ChriCo, jeremyfelt, SergeyBiryukov.
Fixes #45594.
Built from https://develop.svn.wordpress.org/trunk@45794


git-svn-id: http://core.svn.wordpress.org/trunk@45605 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2019-08-14 14:29:56 +00:00
parent 428a738f1d
commit d6faa62338
2 changed files with 27 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
wp-includes/ms-blogs.php
View File

@ -484,46 +484,45 @@ function update_blog_option( $id, $option, $value, $deprecated = null ) {
* @global string $table_prefix * @global string $table_prefix
* @global WP_Object_Cache $wp_object_cache * @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 int $new_blog_id The ID of the blog to switch to. Default: current blog.
* @param bool $deprecated Deprecated argument * @param bool $deprecated Not used.
* @return true Always returns True. * @return true Always returns true.
*/ */
function switch_to_blog( $new_blog, $deprecated = null ) { function switch_to_blog( $new_blog_id, $deprecated = null ) {
global $wpdb; global $wpdb;
$blog_id = get_current_blog_id(); $prev_blog_id = get_current_blog_id();
if ( empty( $new_blog ) ) { if ( empty( $new_blog_id ) ) {
$new_blog = $blog_id; $new_blog_id = $prev_blog_id;
} }
$GLOBALS['_wp_switched_stack'][] = $blog_id; $GLOBALS['_wp_switched_stack'][] = $prev_blog_id;
/* /*
* If we're switching to the same blog id that we're on, * If we're switching to the same blog id that we're on,
* set the right vars, do the associated actions, but skip * set the right vars, do the associated actions, but skip
* the extra unnecessary work * the extra unnecessary work
*/ */
if ( $new_blog == $blog_id ) { if ( $new_blog_id == $prev_blog_id ) {
/** /**
* Fires when the blog is switched. * Fires when the blog is switched.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
* @param int $new_blog New blog ID. * @param int $new_blog_id New blog ID.
* @param int $new_blog Blog ID. * @param int $prev_blog_id Previous blog ID.
*/ */
do_action( 'switch_blog', $new_blog, $new_blog ); do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
$GLOBALS['switched'] = true; $GLOBALS['switched'] = true;
return true; return true;
} }
$wpdb->set_blog_id( $new_blog ); $wpdb->set_blog_id( $new_blog_id );
$GLOBALS['table_prefix'] = $wpdb->get_blog_prefix(); $GLOBALS['table_prefix'] = $wpdb->get_blog_prefix();
$prev_blog_id = $blog_id; $GLOBALS['blog_id'] = $new_blog_id;
$GLOBALS['blog_id'] = $new_blog;
if ( function_exists( 'wp_cache_switch_to_blog' ) ) { if ( function_exists( 'wp_cache_switch_to_blog' ) ) {
wp_cache_switch_to_blog( $new_blog ); wp_cache_switch_to_blog( $new_blog_id );
} else { } else {
global $wp_object_cache; global $wp_object_cache;
@ -545,14 +544,14 @@ function switch_to_blog( $new_blog, $deprecated = null ) {
} }
/** This filter is documented in wp-includes/ms-blogs.php */ /** This filter is documented in wp-includes/ms-blogs.php */
do_action( 'switch_blog', $new_blog, $prev_blog_id ); do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
$GLOBALS['switched'] = true; $GLOBALS['switched'] = true;
return true; return true;
} }
/** /**
* Restore the current blog, after calling switch_to_blog() * Restore the current blog, after calling switch_to_blog().
* *
* @see switch_to_blog() * @see switch_to_blog()
* @since MU (3.0.0) * @since MU (3.0.0)
@ -564,7 +563,7 @@ function switch_to_blog( $new_blog, $deprecated = null ) {
* @global string $table_prefix * @global string $table_prefix
* @global WP_Object_Cache $wp_object_cache * @global WP_Object_Cache $wp_object_cache
* *
* @return bool True on success, false if we're already on the current blog * @return bool True on success, false if we're already on the current blog.
*/ */
function restore_current_blog() { function restore_current_blog() {
global $wpdb; global $wpdb;
@ -573,24 +572,23 @@ function restore_current_blog() {
return false; return false;
} }
$blog = array_pop( $GLOBALS['_wp_switched_stack'] ); $new_blog_id = array_pop( $GLOBALS['_wp_switched_stack'] );
$blog_id = get_current_blog_id(); $prev_blog_id = get_current_blog_id();
if ( $blog_id == $blog ) { if ( $new_blog_id == $prev_blog_id ) {
/** This filter is documented in wp-includes/ms-blogs.php */ /** This filter is documented in wp-includes/ms-blogs.php */
do_action( 'switch_blog', $blog, $blog ); do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
// If we still have items in the switched stack, consider ourselves still 'switched' // If we still have items in the switched stack, consider ourselves still 'switched'
$GLOBALS['switched'] = ! empty( $GLOBALS['_wp_switched_stack'] ); $GLOBALS['switched'] = ! empty( $GLOBALS['_wp_switched_stack'] );
return true; return true;
} }
$wpdb->set_blog_id( $blog ); $wpdb->set_blog_id( $new_blog_id );
$prev_blog_id = $blog_id; $GLOBALS['blog_id'] = $new_blog_id;
$GLOBALS['blog_id'] = $blog;
$GLOBALS['table_prefix'] = $wpdb->get_blog_prefix(); $GLOBALS['table_prefix'] = $wpdb->get_blog_prefix();
if ( function_exists( 'wp_cache_switch_to_blog' ) ) { if ( function_exists( 'wp_cache_switch_to_blog' ) ) {
wp_cache_switch_to_blog( $blog ); wp_cache_switch_to_blog( $new_blog_id );
} else { } else {
global $wp_object_cache; global $wp_object_cache;
@ -613,7 +611,7 @@ function restore_current_blog() {
} }
/** This filter is documented in wp-includes/ms-blogs.php */ /** This filter is documented in wp-includes/ms-blogs.php */
do_action( 'switch_blog', $blog, $prev_blog_id ); do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
// If we still have items in the switched stack, consider ourselves still 'switched' // If we still have items in the switched stack, consider ourselves still 'switched'
$GLOBALS['switched'] = ! empty( $GLOBALS['_wp_switched_stack'] ); $GLOBALS['switched'] = ! empty( $GLOBALS['_wp_switched_stack'] );

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.3-alpha-45793'; $wp_version = '5.3-alpha-45794';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.