2010-02-13 17:35:11 -05:00
< ? php
/**
* Site / blog functions that work with the blogs table and related data .
*
* @ package WordPress
2010-02-14 20:08:23 -05:00
* @ subpackage Multisite
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-02-13 17:35:11 -05:00
*/
2010-09-30 21:32:31 -04:00
/**
2016-01-27 22:35:27 -05:00
* Update the last_updated field for the current site .
2010-09-30 21:32:31 -04:00
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-09-30 21:32:31 -04:00
*/
2010-02-13 17:35:11 -05:00
function wpmu_update_blogs_date () {
2017-10-01 21:44:47 -04:00
$site_id = get_current_blog_id ();
2010-02-13 17:35:11 -05:00
2017-10-01 21:44:47 -04:00
update_blog_details ( $site_id , array ( 'last_updated' => current_time ( 'mysql' , true ) ) );
2013-12-01 12:32:10 -05:00
/**
* Fires after the blog details are updated .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2013-12-01 12:32:10 -05:00
*
2016-01-27 22:35:27 -05:00
* @ param int $blog_id Site ID .
2013-12-01 12:32:10 -05:00
*/
2017-10-01 21:44:47 -04:00
do_action ( 'wpmu_blog_updated' , $site_id );
2010-02-13 17:35:11 -05:00
}
2010-09-30 21:32:31 -04:00
/**
* Get a full blog URL , given a blog id .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-09-30 21:32:31 -04:00
*
* @ param int $blog_id Blog ID
2015-01-11 21:24:22 -05:00
* @ return string Full URL of the blog if found . Empty string if not .
2010-09-30 21:32:31 -04:00
*/
2010-12-16 14:48:00 -05:00
function get_blogaddress_by_id ( $blog_id ) {
2016-10-25 14:50:30 -04:00
$bloginfo = get_site ( ( int ) $blog_id );
2015-10-29 22:02:24 -04:00
if ( empty ( $bloginfo ) ) {
return '' ;
}
$scheme = parse_url ( $bloginfo -> home , PHP_URL_SCHEME );
$scheme = empty ( $scheme ) ? 'http' : $scheme ;
return esc_url ( $scheme . '://' . $bloginfo -> domain . $bloginfo -> path );
2010-02-13 17:35:11 -05:00
}
2010-09-30 21:32:31 -04:00
/**
* Get a full blog URL , given a blog name .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-09-30 21:32:31 -04:00
*
* @ param string $blogname The ( subdomain or directory ) name
* @ return string
*/
2010-02-13 17:35:11 -05:00
function get_blogaddress_by_name ( $blogname ) {
if ( is_subdomain_install () ) {
2017-11-30 18:11:00 -05:00
if ( $blogname == 'main' ) {
2010-02-13 17:35:11 -05:00
$blogname = 'www' ;
2017-11-30 18:11:00 -05:00
}
2010-05-16 18:21:06 -04:00
$url = rtrim ( network_home_url (), '/' );
2017-11-30 18:11:00 -05:00
if ( ! empty ( $blogname ) ) {
$url = preg_replace ( '|^([^\.]+://)|' , '${1}' . $blogname . '.' , $url );
}
2010-02-13 17:35:11 -05:00
} else {
2010-05-16 18:21:06 -04:00
$url = network_home_url ( $blogname );
2010-02-13 17:35:11 -05:00
}
2010-05-16 18:21:06 -04:00
return esc_url ( $url . '/' );
2010-02-13 17:35:11 -05:00
}
2010-09-30 21:32:31 -04:00
/**
2017-10-16 18:35:47 -04:00
* Retrieves a sites ID given its ( subdomain or directory ) slug .
2010-09-30 21:32:31 -04:00
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2018-02-09 11:55:31 -05:00
* @ since 4.7 . 0 Converted to use `get_sites()` .
2010-09-30 21:32:31 -04:00
*
2016-09-27 14:18:28 -04:00
* @ param string $slug A site ' s slug .
* @ return int | null The site ID , or null if no site is found for the given slug .
2010-09-30 21:32:31 -04:00
*/
2012-09-24 15:31:37 -04:00
function get_id_from_blogname ( $slug ) {
2017-10-16 18:35:47 -04:00
$current_network = get_network ();
2017-11-30 18:11:00 -05:00
$slug = trim ( $slug , '/' );
2012-09-24 15:31:37 -04:00
2017-10-16 18:35:47 -04:00
if ( is_subdomain_install () ) {
$domain = $slug . '.' . preg_replace ( '|^www\.|' , '' , $current_network -> domain );
2017-11-30 18:11:00 -05:00
$path = $current_network -> path ;
2017-10-16 18:35:47 -04:00
} else {
$domain = $current_network -> domain ;
2017-11-30 18:11:00 -05:00
$path = $current_network -> path . $slug . '/' ;
2017-10-16 18:35:47 -04:00
}
2017-11-30 18:11:00 -05:00
$site_ids = get_sites (
array (
'number' => 1 ,
'fields' => 'ids' ,
'domain' => $domain ,
'path' => $path ,
)
);
2017-10-16 18:35:47 -04:00
if ( empty ( $site_ids ) ) {
2016-09-27 14:18:28 -04:00
return null ;
}
2017-10-16 18:35:47 -04:00
return array_shift ( $site_ids );
2010-02-13 17:35:11 -05:00
}
/**
* Retrieve the details for a blog from the blogs table and blog options .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2017-10-16 18:29:48 -04:00
*
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 17:51:31 -04:00
*
* @ 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 .
2016-03-09 02:42:26 -05:00
* @ return WP_Site | false Blog details on success . False on failure .
2010-02-13 17:35:11 -05:00
*/
2012-10-04 08:40:09 -04:00
function get_blog_details ( $fields = null , $get_all = true ) {
2017-10-16 18:29:48 -04:00
global $wpdb ;
2017-11-30 18:11:00 -05:00
if ( is_array ( $fields ) ) {
if ( isset ( $fields [ 'blog_id' ] ) ) {
2017-10-16 18:29:48 -04:00
$blog_id = $fields [ 'blog_id' ];
2017-11-30 18:11:00 -05:00
} elseif ( isset ( $fields [ 'domain' ] ) && isset ( $fields [ 'path' ] ) ) {
$key = md5 ( $fields [ 'domain' ] . $fields [ 'path' ] );
$blog = wp_cache_get ( $key , 'blog-lookup' );
if ( false !== $blog ) {
2017-10-16 18:29:48 -04:00
return $blog ;
2017-11-30 18:11:00 -05:00
}
2017-10-16 18:29:48 -04:00
if ( substr ( $fields [ 'domain' ], 0 , 4 ) == 'www.' ) {
$nowww = substr ( $fields [ 'domain' ], 4 );
2017-11-30 18:11:00 -05:00
$blog = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT * FROM $wpdb->blogs WHERE domain IN (%s,%s) AND path = %s ORDER BY CHAR_LENGTH(domain) DESC " , $nowww , $fields [ 'domain' ], $fields [ 'path' ] ) );
2017-10-16 18:29:48 -04:00
} else {
$blog = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT * FROM $wpdb->blogs WHERE domain = %s AND path = %s " , $fields [ 'domain' ], $fields [ 'path' ] ) );
}
if ( $blog ) {
2017-11-30 18:11:00 -05:00
wp_cache_set ( $blog -> blog_id . 'short' , $blog , 'blog-details' );
2017-10-16 18:29:48 -04:00
$blog_id = $blog -> blog_id ;
} else {
return false ;
}
2017-11-30 18:11:00 -05:00
} elseif ( isset ( $fields [ 'domain' ] ) && is_subdomain_install () ) {
$key = md5 ( $fields [ 'domain' ] );
$blog = wp_cache_get ( $key , 'blog-lookup' );
if ( false !== $blog ) {
2017-10-16 18:29:48 -04:00
return $blog ;
2017-11-30 18:11:00 -05:00
}
2017-10-16 18:29:48 -04:00
if ( substr ( $fields [ 'domain' ], 0 , 4 ) == 'www.' ) {
$nowww = substr ( $fields [ 'domain' ], 4 );
2017-11-30 18:11:00 -05:00
$blog = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT * FROM $wpdb->blogs WHERE domain IN (%s,%s) ORDER BY CHAR_LENGTH(domain) DESC " , $nowww , $fields [ 'domain' ] ) );
2017-10-16 18:29:48 -04:00
} else {
$blog = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT * FROM $wpdb->blogs WHERE domain = %s " , $fields [ 'domain' ] ) );
}
if ( $blog ) {
2017-11-30 18:11:00 -05:00
wp_cache_set ( $blog -> blog_id . 'short' , $blog , 'blog-details' );
2017-10-16 18:29:48 -04:00
$blog_id = $blog -> blog_id ;
} else {
return false ;
}
2010-02-13 18:09:54 -05:00
} else {
return false ;
}
} else {
2017-11-30 18:11:00 -05:00
if ( ! $fields ) {
2017-10-16 18:29:48 -04:00
$blog_id = get_current_blog_id ();
2017-11-30 18:11:00 -05:00
} elseif ( ! is_numeric ( $fields ) ) {
2017-10-16 18:29:48 -04:00
$blog_id = get_id_from_blogname ( $fields );
2017-11-30 18:11:00 -05:00
} else {
2017-10-16 18:29:48 -04:00
$blog_id = $fields ;
2017-11-30 18:11:00 -05:00
}
2010-02-13 17:35:11 -05:00
}
2017-10-16 18:29:48 -04:00
$blog_id = ( int ) $blog_id ;
2010-02-13 18:09:54 -05:00
2017-11-30 18:11:00 -05:00
$all = $get_all == true ? '' : 'short' ;
2017-10-16 18:29:48 -04:00
$details = wp_cache_get ( $blog_id . $all , 'blog-details' );
if ( $details ) {
if ( ! is_object ( $details ) ) {
if ( $details == - 1 ) {
return false ;
} else {
// Clear old pre-serialized objects. Cache clients do better with that.
wp_cache_delete ( $blog_id . $all , 'blog-details' );
2017-11-30 18:11:00 -05:00
unset ( $details );
2017-10-16 18:29:48 -04:00
}
} else {
return $details ;
}
2016-01-25 16:51:26 -05:00
}
2017-10-16 18:29:48 -04:00
// Try the other cache.
2017-10-03 15:40:46 -04:00
if ( $get_all ) {
2017-10-16 18:29:48 -04:00
$details = wp_cache_get ( $blog_id . 'short' , 'blog-details' );
} else {
$details = wp_cache_get ( $blog_id , 'blog-details' );
// If short was requested and full cache is set, we can return.
if ( $details ) {
if ( ! is_object ( $details ) ) {
if ( $details == - 1 ) {
return false ;
} else {
// Clear old pre-serialized objects. Cache clients do better with that.
wp_cache_delete ( $blog_id , 'blog-details' );
2017-11-30 18:11:00 -05:00
unset ( $details );
2017-10-16 18:29:48 -04:00
}
} else {
return $details ;
}
2017-10-03 15:40:46 -04:00
}
2010-02-13 17:35:11 -05:00
}
2017-11-30 18:11:00 -05:00
if ( empty ( $details ) ) {
2017-10-16 18:29:48 -04:00
$details = WP_Site :: get_instance ( $blog_id );
if ( ! $details ) {
// Set the full cache.
wp_cache_set ( $blog_id , - 1 , 'blog-details' );
return false ;
}
}
if ( ! $details instanceof WP_Site ) {
$details = new WP_Site ( $details );
}
if ( ! $get_all ) {
wp_cache_set ( $blog_id . $all , $details , 'blog-details' );
return $details ;
}
switch_to_blog ( $blog_id );
$details -> blogname = get_option ( 'blogname' );
$details -> siteurl = get_option ( 'siteurl' );
$details -> post_count = get_option ( 'post_count' );
$details -> home = get_option ( 'home' );
restore_current_blog ();
/**
* Filters a blog ' s details .
*
* @ since MU ( 3.0 . 0 )
* @ deprecated 4.7 . 0 Use site_details
*
* @ param object $details The blog details .
*/
$details = apply_filters_deprecated ( 'blog_details' , array ( $details ), '4.7.0' , 'site_details' );
wp_cache_set ( $blog_id . $all , $details , 'blog-details' );
$key = md5 ( $details -> domain . $details -> path );
wp_cache_set ( $key , $details , 'blog-lookup' );
return $details ;
2010-02-13 17:35:11 -05:00
}
/**
* Clear the blog details cache .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-02-13 17:35:11 -05:00
*
2014-09-02 03:30:16 -04:00
* @ param int $blog_id Optional . Blog ID . Defaults to current blog .
2010-02-13 17:35:11 -05:00
*/
2014-09-02 03:30:16 -04:00
function refresh_blog_details ( $blog_id = 0 ) {
2010-02-13 17:35:11 -05:00
$blog_id = ( int ) $blog_id ;
2014-09-02 03:30:16 -04:00
if ( ! $blog_id ) {
$blog_id = get_current_blog_id ();
}
2017-10-03 14:41:48 -04:00
clean_blog_cache ( $blog_id );
2010-02-13 17:35:11 -05:00
}
/**
* Update the details for a blog . Updates the blogs table for a given blog id .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-02-13 17:35:11 -05:00
*
2015-10-14 19:44:25 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 17:51:31 -04:00
*
* @ param int $blog_id Blog ID
2010-02-13 17:35:11 -05:00
* @ param array $details Array of details keyed by blogs table field names .
* @ return bool True if update succeeds , false otherwise .
*/
function update_blog_details ( $blog_id , $details = array () ) {
global $wpdb ;
2017-11-30 18:11:00 -05:00
if ( empty ( $details ) ) {
2010-02-13 17:35:11 -05:00
return false ;
2017-11-30 18:11:00 -05:00
}
2010-02-13 17:35:11 -05:00
2017-11-30 18:11:00 -05:00
if ( is_object ( $details ) ) {
$details = get_object_vars ( $details );
}
2010-02-13 17:35:11 -05:00
Multisite: Complete the new CRUD API for managing sites.
New functions `wp_insert_site( $data )`, `wp_update_site( $id, $data )` and `wp_delete_site( $id )` are introduced to manage site rows in the `wp_blogs` table, forming the new CRUD API together with the existing `get_site()` / `get_sites()`. The new API provides various benefits over the previously existing API, fixing several cache invalidation issues and being hook-driven so that normalization and validation of the passed data can be fully customized.
New hooks introduced as part of this are the actions `wp_insert_site`, `wp_update_site`, `wp_delete_site`, `wp_validate_site_data` and the filter `wp_normalize_site_data`.
At this point, `wp_insert_site()` does not handle setting up the site's database tables, and `wp_delete_site()` does not handle dropping the site's database tables, so the two can not yet be used directly as full replacements of `wpmu_create_blog()` and `wpmu_delete_blog()`. Managing the site's database tables will be added via hooks as part of the follow-up ticket #41333.
The existing functions `wpmu_create_blog()`, `update_blog_details()`, and `wpmu_delete_blog()` make use of the respective new counterpart and will be obsolete once #41333 has been completed.
Props flixos90, jeremyfelt, spacedmonkey.
Fixes #40364.
Built from https://develop.svn.wordpress.org/trunk@43548
git-svn-id: http://core.svn.wordpress.org/trunk@43377 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-08-01 09:06:26 -04:00
$site = wp_update_site ( $blog_id , $details );
2015-01-11 20:43:22 -05:00
Multisite: Complete the new CRUD API for managing sites.
New functions `wp_insert_site( $data )`, `wp_update_site( $id, $data )` and `wp_delete_site( $id )` are introduced to manage site rows in the `wp_blogs` table, forming the new CRUD API together with the existing `get_site()` / `get_sites()`. The new API provides various benefits over the previously existing API, fixing several cache invalidation issues and being hook-driven so that normalization and validation of the passed data can be fully customized.
New hooks introduced as part of this are the actions `wp_insert_site`, `wp_update_site`, `wp_delete_site`, `wp_validate_site_data` and the filter `wp_normalize_site_data`.
At this point, `wp_insert_site()` does not handle setting up the site's database tables, and `wp_delete_site()` does not handle dropping the site's database tables, so the two can not yet be used directly as full replacements of `wpmu_create_blog()` and `wpmu_delete_blog()`. Managing the site's database tables will be added via hooks as part of the follow-up ticket #41333.
The existing functions `wpmu_create_blog()`, `update_blog_details()`, and `wpmu_delete_blog()` make use of the respective new counterpart and will be obsolete once #41333 has been completed.
Props flixos90, jeremyfelt, spacedmonkey.
Fixes #40364.
Built from https://develop.svn.wordpress.org/trunk@43548
git-svn-id: http://core.svn.wordpress.org/trunk@43377 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-08-01 09:06:26 -04:00
if ( is_wp_error ( $site ) ) {
2012-10-11 08:37:46 -04:00
return false ;
2017-11-30 18:11:00 -05:00
}
2010-02-13 17:35:11 -05:00
return true ;
}
2012-10-01 14:03:23 -04:00
/**
* Clean the blog cache
*
* @ since 3.5 . 0
*
2017-03-28 15:36:49 -04:00
* @ global bool $_wp_suspend_cache_invalidation
*
2017-10-03 14:41:48 -04:00
* @ param WP_Site | int $blog The site object or ID to be cleared from cache .
2012-10-01 14:03:23 -04:00
*/
function clean_blog_cache ( $blog ) {
2017-03-28 15:36:49 -04:00
global $_wp_suspend_cache_invalidation ;
if ( ! empty ( $_wp_suspend_cache_invalidation ) ) {
return ;
}
2017-10-03 14:41:48 -04:00
if ( empty ( $blog ) ) {
return ;
}
$blog_id = $blog ;
2017-11-30 18:11:00 -05:00
$blog = get_site ( $blog_id );
2017-10-03 14:41:48 -04:00
if ( ! $blog ) {
if ( ! is_numeric ( $blog_id ) ) {
return ;
}
// Make sure a WP_Site object exists even when the site has been deleted.
2017-11-30 18:11:00 -05:00
$blog = new WP_Site (
( object ) array (
'blog_id' => $blog_id ,
'domain' => null ,
'path' => null ,
)
);
2017-10-03 14:41:48 -04:00
}
2017-11-30 18:11:00 -05:00
$blog_id = $blog -> blog_id ;
2012-10-01 14:03:23 -04:00
$domain_path_key = md5 ( $blog -> domain . $blog -> path );
2016-01-25 16:51:26 -05:00
wp_cache_delete ( $blog_id , 'sites' );
2016-06-29 15:32:27 -04:00
wp_cache_delete ( $blog_id , 'site-details' );
2017-03-28 15:36:49 -04:00
wp_cache_delete ( $blog_id , 'blog-details' );
2017-11-30 18:11:00 -05:00
wp_cache_delete ( $blog_id . 'short' , 'blog-details' );
2017-03-28 15:36:49 -04:00
wp_cache_delete ( $domain_path_key , 'blog-lookup' );
wp_cache_delete ( $domain_path_key , 'blog-id-cache' );
2012-10-01 14:03:23 -04:00
wp_cache_delete ( 'current_blog_' . $blog -> domain , 'site-options' );
wp_cache_delete ( 'current_blog_' . $blog -> domain . $blog -> path , 'site-options' );
2018-03-15 22:15:31 -04:00
wp_cache_delete ( $blog_id , 'blog_meta' );
2016-04-14 00:19:27 -04:00
/**
* Fires immediately after a site has been removed from the object cache .
*
* @ since 4.6 . 0
*
2016-07-20 15:33:30 -04:00
* @ param int $id Blog ID .
* @ param WP_Site $blog Site object .
2016-04-14 00:19:27 -04:00
* @ param string $domain_path_key md5 hash of domain and path .
*/
do_action ( 'clean_site_cache' , $blog_id , $blog , $domain_path_key );
2016-06-01 20:59:27 -04:00
wp_cache_set ( 'last_changed' , microtime (), 'sites' );
2017-10-03 14:41:48 -04:00
/**
* Fires after the blog details cache is cleared .
*
* @ since 3.4 . 0
* @ deprecated 4.9 . 0 Use clean_site_cache
*
* @ param int $blog_id Blog ID .
*/
do_action_deprecated ( 'refresh_blog_details' , array ( $blog_id ), '4.9.0' , 'clean_site_cache' );
2012-10-01 14:03:23 -04:00
}
2017-03-19 12:22:45 -04:00
/**
* Cleans the site details cache for a site .
*
* @ since 4.7 . 4
*
* @ param int $site_id Optional . Site ID . Default is the current site ID .
*/
2017-03-25 11:31:43 -04:00
function clean_site_details_cache ( $site_id = 0 ) {
2017-03-19 12:22:45 -04:00
$site_id = ( int ) $site_id ;
if ( ! $site_id ) {
$site_id = get_current_blog_id ();
}
wp_cache_delete ( $site_id , 'site-details' );
wp_cache_delete ( $site_id , 'blog-details' );
}
Multisite: Complete the new CRUD API for managing sites.
New functions `wp_insert_site( $data )`, `wp_update_site( $id, $data )` and `wp_delete_site( $id )` are introduced to manage site rows in the `wp_blogs` table, forming the new CRUD API together with the existing `get_site()` / `get_sites()`. The new API provides various benefits over the previously existing API, fixing several cache invalidation issues and being hook-driven so that normalization and validation of the passed data can be fully customized.
New hooks introduced as part of this are the actions `wp_insert_site`, `wp_update_site`, `wp_delete_site`, `wp_validate_site_data` and the filter `wp_normalize_site_data`.
At this point, `wp_insert_site()` does not handle setting up the site's database tables, and `wp_delete_site()` does not handle dropping the site's database tables, so the two can not yet be used directly as full replacements of `wpmu_create_blog()` and `wpmu_delete_blog()`. Managing the site's database tables will be added via hooks as part of the follow-up ticket #41333.
The existing functions `wpmu_create_blog()`, `update_blog_details()`, and `wpmu_delete_blog()` make use of the respective new counterpart and will be obsolete once #41333 has been completed.
Props flixos90, jeremyfelt, spacedmonkey.
Fixes #40364.
Built from https://develop.svn.wordpress.org/trunk@43548
git-svn-id: http://core.svn.wordpress.org/trunk@43377 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-08-01 09:06:26 -04:00
/**
* Inserts a new site into the database .
*
* @ since 5.0 . 0
*
* @ global wpdb $wpdb WordPress database abstraction object .
*
* @ param array $data {
* Data for the new site that should be inserted .
*
* @ type string $domain Site domain . Default empty string .
* @ type string $path Site path . Default '/' .
* @ type int $network_id The site ' s network ID . Default is the current network ID .
* @ type string $registered When the site was registered , in SQL datetime format . Default is
* the current time .
* @ type string $last_updated When the site was last updated , in SQL datetime format . Default is
* the value of $registered .
* @ type int $public Whether the site is public . Default 1.
* @ type int $archived Whether the site is archived . Default 0.
* @ type int $mature Whether the site is mature . Default 0.
* @ type int $spam Whether the site is spam . Default 0.
* @ type int $deleted Whether the site is deleted . Default 0.
* @ type int $lang_id The site ' s language ID . Currently unused . Default 0.
* }
* @ return int | WP_Error The new site ' s ID on success , or error object on failure .
*/
function wp_insert_site ( array $data ) {
global $wpdb ;
$now = current_time ( 'mysql' , true );
$defaults = array (
'domain' => '' ,
'path' => '/' ,
'network_id' => get_current_network_id (),
'registered' => $now ,
'last_updated' => $now ,
'public' => 1 ,
'archived' => 0 ,
'mature' => 0 ,
'spam' => 0 ,
'deleted' => 0 ,
'lang_id' => 0 ,
);
$data = wp_prepare_site_data ( $data , $defaults );
if ( is_wp_error ( $data ) ) {
return $data ;
}
if ( false === $wpdb -> insert ( $wpdb -> blogs , $data ) ) {
return new WP_Error ( 'db_insert_error' , __ ( 'Could not insert site into the database.' ), $wpdb -> last_error );
}
$new_site = get_site ( $wpdb -> insert_id );
clean_blog_cache ( $new_site );
/**
* Fires once a site has been inserted into the database .
*
* @ since 5.0 . 0
*
* @ param WP_Site $new_site New site object .
*/
do_action ( 'wp_insert_site' , $new_site );
return ( int ) $new_site -> id ;
}
/**
* Updates a site in the database .
*
* @ since 5.0 . 0
*
* @ global wpdb $wpdb WordPress database abstraction object .
*
* @ param int $site_id ID of the site that should be updated .
* @ param array $data Site data to update . See { @ see wp_insert_site ()} for the list of supported keys .
* @ return int | WP_Error The updated site ' s ID on success , or error object on failure .
*/
function wp_update_site ( $site_id , array $data ) {
global $wpdb ;
if ( empty ( $site_id ) ) {
return new WP_Error ( 'site_empty_id' , __ ( 'Site ID must not be empty.' ) );
}
$old_site = get_site ( $site_id );
if ( ! $old_site ) {
return new WP_Error ( 'site_not_exist' , __ ( 'Site does not exist.' ) );
}
$defaults = $old_site -> to_array ();
$defaults [ 'network_id' ] = ( int ) $defaults [ 'site_id' ];
$defaults [ 'last_updated' ] = current_time ( 'mysql' , true );
unset ( $defaults [ 'blog_id' ], $defaults [ 'site_id' ] );
$data = wp_prepare_site_data ( $data , $defaults , $old_site );
if ( is_wp_error ( $data ) ) {
return $data ;
}
if ( false === $wpdb -> update ( $wpdb -> blogs , $data , array ( 'blog_id' => $old_site -> id ) ) ) {
return new WP_Error ( 'db_update_error' , __ ( 'Could not update site in the database.' ), $wpdb -> last_error );
}
clean_blog_cache ( $old_site );
$new_site = get_site ( $old_site -> id );
/**
* Fires once a site has been updated in the database .
*
* @ since 5.0 . 0
*
* @ param WP_Site $new_site New site object .
* @ param WP_Site $old_site Old site object .
*/
do_action ( 'wp_update_site' , $new_site , $old_site );
return ( int ) $new_site -> id ;
}
/**
* Deletes a site from the database .
*
* @ since 5.0 . 0
*
* @ global wpdb $wpdb WordPress database abstraction object .
*
* @ param int $site_id ID of the site that should be deleted .
* @ return WP_Site | WP_Error The deleted site object on success , or error object on failure .
*/
function wp_delete_site ( $site_id ) {
global $wpdb ;
if ( empty ( $site_id ) ) {
return new WP_Error ( 'site_empty_id' , __ ( 'Site ID must not be empty.' ) );
}
$old_site = get_site ( $site_id );
if ( ! $old_site ) {
return new WP_Error ( 'site_not_exist' , __ ( 'Site does not exist.' ) );
}
if ( false === $wpdb -> delete ( $wpdb -> blogs , array ( 'blog_id' => $old_site -> id ) ) ) {
return new WP_Error ( 'db_delete_error' , __ ( 'Could not delete site from the database.' ), $wpdb -> last_error );
}
clean_blog_cache ( $old_site );
/**
* Fires once a site has been deleted from the database .
*
* @ since 5.0 . 0
*
* @ param WP_Site $old_site Deleted site object .
*/
do_action ( 'wp_delete_site' , $old_site );
return $old_site ;
}
2016-05-20 00:41:27 -04:00
/**
* Retrieves site data given a site ID or site object .
*
* Site data will be cached and returned after being passed through a filter .
* If the provided site is empty , the current site global will be used .
*
* @ since 4.6 . 0
*
2016-06-14 14:14:27 -04:00
* @ param WP_Site | int | null $site Optional . Site to retrieve . Default is the current site .
* @ return WP_Site | null The site object or null if not found .
2016-05-20 00:41:27 -04:00
*/
2016-08-09 14:12:31 -04:00
function get_site ( $site = null ) {
2016-08-08 18:33:28 -04:00
if ( empty ( $site ) ) {
$site = get_current_blog_id ();
2016-05-20 00:41:27 -04:00
}
if ( $site instanceof WP_Site ) {
$_site = $site ;
} elseif ( is_object ( $site ) ) {
$_site = new WP_Site ( $site );
} else {
$_site = WP_Site :: get_instance ( $site );
}
if ( ! $_site ) {
return null ;
}
/**
* Fires after a site is retrieved .
*
* @ since 4.6 . 0
*
2016-06-14 14:14:27 -04:00
* @ param WP_Site $_site Site data .
2016-05-20 00:41:27 -04:00
*/
$_site = apply_filters ( 'get_site' , $_site );
return $_site ;
}
2016-05-20 18:04:27 -04:00
/**
* Adds any sites from the given ids to the cache that do not already exist in cache .
*
* @ since 4.6 . 0
2018-03-15 22:15:31 -04:00
* @ since 5.0 . 0 Introduced the `$update_meta_cache` parameter .
2016-05-20 18:04:27 -04:00
* @ access private
*
* @ see update_site_cache ()
* @ global wpdb $wpdb WordPress database abstraction object .
*
2018-03-15 22:15:31 -04:00
* @ param array $ids ID list .
* @ param bool $update_meta_cache Optional . Whether to update the meta cache . Default true .
2016-05-20 18:04:27 -04:00
*/
2018-03-15 22:15:31 -04:00
function _prime_site_caches ( $ids , $update_meta_cache = true ) {
2016-05-20 18:04:27 -04:00
global $wpdb ;
$non_cached_ids = _get_non_cached_ids ( $ids , 'sites' );
if ( ! empty ( $non_cached_ids ) ) {
2017-11-30 18:11:00 -05:00
$fresh_sites = $wpdb -> get_results ( sprintf ( " SELECT * FROM $wpdb->blogs WHERE blog_id IN (%s) " , join ( ',' , array_map ( 'intval' , $non_cached_ids ) ) ) );
2016-05-20 18:04:27 -04:00
2018-03-15 22:15:31 -04:00
update_site_cache ( $fresh_sites , $update_meta_cache );
2016-05-20 18:04:27 -04:00
}
}
/**
* Updates sites in cache .
*
* @ since 4.6 . 0
2018-03-15 22:15:31 -04:00
* @ since 5.0 . 0 Introduced the `$update_meta_cache` parameter .
2016-05-20 18:04:27 -04:00
*
2018-03-15 22:15:31 -04:00
* @ param array $sites Array of site objects .
* @ param bool $update_meta_cache Whether to update site meta cache . Default true .
2016-05-20 18:04:27 -04:00
*/
2018-03-15 22:15:31 -04:00
function update_site_cache ( $sites , $update_meta_cache = true ) {
2016-05-20 18:04:27 -04:00
if ( ! $sites ) {
return ;
}
2018-03-15 22:15:31 -04:00
$site_ids = array ();
2016-05-20 18:04:27 -04:00
foreach ( $sites as $site ) {
2018-03-15 22:15:31 -04:00
$site_ids [] = $site -> blog_id ;
2016-05-20 18:04:27 -04:00
wp_cache_add ( $site -> blog_id , $site , 'sites' );
wp_cache_add ( $site -> blog_id . 'short' , $site , 'blog-details' );
}
2018-03-15 22:15:31 -04:00
if ( $update_meta_cache ) {
update_sitemeta_cache ( $site_ids );
}
}
/**
* Updates metadata cache for list of site IDs .
*
* Performs SQL query to retrieve all metadata for the sites matching `$site_ids` and stores them in the cache .
* Subsequent calls to `get_site_meta()` will not need to query the database .
*
* @ since 5.0 . 0
*
* @ param array $site_ids List of site IDs .
* @ return array | false Returns false if there is nothing to update . Returns an array of metadata on success .
*/
function update_sitemeta_cache ( $site_ids ) {
if ( ! is_site_meta_supported () ) {
return false ;
}
return update_meta_cache ( 'blog' , $site_ids );
2016-05-20 18:04:27 -04:00
}
2016-06-01 19:21:27 -04:00
/**
* Retrieves a list of sites matching requested arguments .
*
* @ since 4.6 . 0
2017-03-27 15:48:52 -04:00
* @ since 4.8 . 0 Introduced the 'lang_id' , 'lang__in' , and 'lang__not_in' parameters .
2016-06-01 19:21:27 -04:00
*
* @ see WP_Site_Query :: parse_query ()
*
* @ param string | array $args {
* Optional . Array or query string of site query parameters . Default empty .
*
* @ type array $site__in Array of site IDs to include . Default empty .
* @ type array $site__not_in Array of site IDs to exclude . Default empty .
* @ type bool $count Whether to return a site count ( true ) or array of site objects .
* Default false .
* @ type array $date_query Date query clauses to limit sites by . See WP_Date_Query .
* Default null .
2016-09-13 09:20:35 -04:00
* @ type string $fields Site fields to return . Accepts 'ids' ( returns an array of site IDs )
* or empty ( returns an array of complete site objects ) . Default empty .
2016-06-01 19:21:27 -04:00
* @ type int $ID A site ID to only return that site . Default empty .
2016-09-13 09:20:35 -04:00
* @ type int $number Maximum number of sites to retrieve . Default 100.
2016-06-01 19:21:27 -04:00
* @ type int $offset Number of sites to offset the query . Used to build LIMIT clause .
* Default 0.
* @ type bool $no_found_rows Whether to disable the `SQL_CALC_FOUND_ROWS` query . Default true .
* @ type string | array $orderby Site status or array of statuses . Accepts 'id' , 'domain' , 'path' ,
* 'network_id' , 'last_updated' , 'registered' , 'domain_length' ,
* 'path_length' , 'site__in' and 'network__in' . Also accepts false ,
* an empty array , or 'none' to disable `ORDER BY` clause .
* Default 'id' .
* @ type string $order How to order retrieved sites . Accepts 'ASC' , 'DESC' . Default 'ASC' .
2016-09-13 09:20:35 -04:00
* @ type int $network_id Limit results to those affiliated with a given network ID . If 0 ,
* include all networks . Default 0.
2016-06-01 19:21:27 -04:00
* @ type array $network__in Array of network IDs to include affiliated sites for . Default empty .
* @ type array $network__not_in Array of network IDs to exclude affiliated sites for . Default empty .
2016-09-13 09:10:32 -04:00
* @ type string $domain Limit results to those affiliated with a given domain . Default empty .
2016-06-01 19:21:27 -04:00
* @ type array $domain__in Array of domains to include affiliated sites for . Default empty .
* @ type array $domain__not_in Array of domains to exclude affiliated sites for . Default empty .
2016-09-13 09:10:32 -04:00
* @ type string $path Limit results to those affiliated with a given path . Default empty .
2016-06-01 19:21:27 -04:00
* @ type array $path__in Array of paths to include affiliated sites for . Default empty .
* @ type array $path__not_in Array of paths to exclude affiliated sites for . Default empty .
* @ type int $public Limit results to public sites . Accepts '1' or '0' . Default empty .
* @ type int $archived Limit results to archived sites . Accepts '1' or '0' . Default empty .
* @ type int $mature Limit results to mature sites . Accepts '1' or '0' . Default empty .
* @ type int $spam Limit results to spam sites . Accepts '1' or '0' . Default empty .
* @ type int $deleted Limit results to deleted sites . Accepts '1' or '0' . Default empty .
2017-03-27 15:48:52 -04:00
* @ type int $lang_id Limit results to a language ID . Default empty .
* @ type array $lang__in Array of language IDs to include affiliated sites for . Default empty .
* @ type array $lang__not_in Array of language IDs to exclude affiliated sites for . Default empty .
2016-06-01 19:21:27 -04:00
* @ type string $search Search term ( s ) to retrieve matching sites for . Default empty .
2016-09-13 09:20:35 -04:00
* @ type array $search_columns Array of column names to be searched . Accepts 'domain' and 'path' .
* Default empty array .
2017-10-09 10:26:49 -04:00
* @ type bool $update_site_cache Whether to prime the cache for found sites . Default true .
2016-06-01 19:21:27 -04:00
* }
2017-10-18 13:39:46 -04:00
* @ return array | int List of WP_Site objects , a list of site ids when 'fields' is set to 'ids' ,
* or the number of sites when 'count' is passed as a query var .
2016-06-01 19:21:27 -04:00
*/
function get_sites ( $args = array () ) {
$query = new WP_Site_Query ();
return $query -> query ( $args );
}
Multisite: Complete the new CRUD API for managing sites.
New functions `wp_insert_site( $data )`, `wp_update_site( $id, $data )` and `wp_delete_site( $id )` are introduced to manage site rows in the `wp_blogs` table, forming the new CRUD API together with the existing `get_site()` / `get_sites()`. The new API provides various benefits over the previously existing API, fixing several cache invalidation issues and being hook-driven so that normalization and validation of the passed data can be fully customized.
New hooks introduced as part of this are the actions `wp_insert_site`, `wp_update_site`, `wp_delete_site`, `wp_validate_site_data` and the filter `wp_normalize_site_data`.
At this point, `wp_insert_site()` does not handle setting up the site's database tables, and `wp_delete_site()` does not handle dropping the site's database tables, so the two can not yet be used directly as full replacements of `wpmu_create_blog()` and `wpmu_delete_blog()`. Managing the site's database tables will be added via hooks as part of the follow-up ticket #41333.
The existing functions `wpmu_create_blog()`, `update_blog_details()`, and `wpmu_delete_blog()` make use of the respective new counterpart and will be obsolete once #41333 has been completed.
Props flixos90, jeremyfelt, spacedmonkey.
Fixes #40364.
Built from https://develop.svn.wordpress.org/trunk@43548
git-svn-id: http://core.svn.wordpress.org/trunk@43377 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-08-01 09:06:26 -04:00
/**
* Prepares site data for insertion or update in the database .
*
* @ since 5.0 . 0
*
* @ param array $data Associative array of site data passed to the respective function .
* See { @ see wp_insert_site ()} for the possibly included data .
* @ param array $defaults Site data defaults to parse $data against .
* @ param WP_Site | null $old_site Optional . Old site object if an update , or null if an insertion .
* Default null .
* @ return array | WP_Error Site data ready for a database transaction , or WP_Error in case a validation
* error occurred .
*/
function wp_prepare_site_data ( $data , $defaults , $old_site = null ) {
// Maintain backward-compatibility with `$site_id` as network ID.
if ( isset ( $data [ 'site_id' ] ) ) {
if ( ! empty ( $data [ 'site_id' ] ) && empty ( $data [ 'network_id' ] ) ) {
$data [ 'network_id' ] = $data [ 'site_id' ];
}
unset ( $data [ 'site_id' ] );
}
/**
* Filters passed site data in order to normalize it .
*
* @ since 5.0 . 0
*
* @ param array $data Associative array of site data passed to the respective function .
* See { @ see wp_insert_site ()} for the possibly included data .
*/
$data = apply_filters ( 'wp_normalize_site_data' , $data );
$whitelist = array ( 'domain' , 'path' , 'network_id' , 'registered' , 'last_updated' , 'public' , 'archived' , 'mature' , 'spam' , 'deleted' , 'lang_id' );
$data = array_intersect_key ( wp_parse_args ( $data , $defaults ), array_flip ( $whitelist ) );
$errors = new WP_Error ();
/**
* Fires when data should be validated for a site prior to inserting or updating in the database .
*
* Plugins should amend the `$errors` object via its `WP_Error::add()` method .
*
* @ since 5.0 . 0
*
* @ param WP_Error $errors Error object to add validation errors to .
* @ param array $data Associative array of complete site data . See { @ see wp_insert_site ()}
* for the included data .
* @ param WP_Site | null $old_site The old site object if the data belongs to a site being updated ,
* or null if it is a new site being inserted .
*/
do_action ( 'wp_validate_site_data' , $errors , $data , $old_site );
if ( ! empty ( $errors -> errors ) ) {
return $errors ;
}
// Prepare for database.
$data [ 'site_id' ] = $data [ 'network_id' ];
unset ( $data [ 'network_id' ] );
return $data ;
}
/**
* Normalizes data for a site prior to inserting or updating in the database .
*
* @ since 5.0 . 0
*
* @ param array $data Associative array of site data passed to the respective function .
* See { @ see wp_insert_site ()} for the possibly included data .
* @ return array Normalized site data .
*/
function wp_normalize_site_data ( $data ) {
// Sanitize domain if passed.
if ( array_key_exists ( 'domain' , $data ) ) {
$data [ 'domain' ] = trim ( $data [ 'domain' ] );
$data [ 'domain' ] = preg_replace ( '/\s+/' , '' , sanitize_user ( $data [ 'domain' ], true ) );
if ( is_subdomain_install () ) {
$data [ 'domain' ] = str_replace ( '@' , '' , $data [ 'domain' ] );
}
}
// Sanitize path if passed.
if ( array_key_exists ( 'path' , $data ) ) {
$data [ 'path' ] = trailingslashit ( '/' . trim ( $data [ 'path' ], '/' ) );
}
// Sanitize network ID if passed.
if ( array_key_exists ( 'network_id' , $data ) ) {
$data [ 'network_id' ] = ( int ) $data [ 'network_id' ];
}
// Sanitize status fields if passed.
$status_fields = array ( 'public' , 'archived' , 'mature' , 'spam' , 'deleted' );
foreach ( $status_fields as $status_field ) {
if ( array_key_exists ( $status_field , $data ) ) {
$data [ $status_field ] = ( int ) $data [ $status_field ];
}
}
// Strip date fields if empty.
$date_fields = array ( 'registered' , 'last_updated' );
foreach ( $date_fields as $date_field ) {
if ( ! array_key_exists ( $date_field , $data ) ) {
continue ;
}
if ( empty ( $data [ $date_field ] ) || '0000-00-00 00:00:00' === $data [ $date_field ] ) {
unset ( $data [ $date_field ] );
}
}
return $data ;
}
/**
* Validates data for a site prior to inserting or updating in the database .
*
* @ since 5.0 . 0
*
* @ param WP_Error $errors Error object , passed by reference . Will contain validation errors if
* any occurred .
* @ param array $data Associative array of complete site data . See { @ see wp_insert_site ()}
* for the included data .
* @ param WP_Site | null $old_site The old site object if the data belongs to a site being updated ,
* or null if it is a new site being inserted .
*/
function wp_validate_site_data ( $errors , $data , $old_site = null ) {
// A domain must always be present.
if ( empty ( $data [ 'domain' ] ) ) {
$errors -> add ( 'site_empty_domain' , __ ( 'Site domain must not be empty.' ) );
}
// A path must always be present.
if ( empty ( $data [ 'path' ] ) ) {
$errors -> add ( 'site_empty_path' , __ ( 'Site path must not be empty.' ) );
}
// A network ID must always be present.
if ( empty ( $data [ 'network_id' ] ) ) {
$errors -> add ( 'site_empty_network_id' , __ ( 'Site network ID must be provided.' ) );
}
// Both registration and last updated dates must always be present and valid.
$date_fields = array ( 'registered' , 'last_updated' );
foreach ( $date_fields as $date_field ) {
if ( empty ( $data [ $date_field ] ) ) {
$errors -> add ( 'site_empty_' . $date_field , __ ( 'Both registration and last updated dates must be provided.' ) );
break ;
}
// Allow '0000-00-00 00:00:00', although it be stripped out at this point.
if ( '0000-00-00 00:00:00' !== $data [ $date_field ] ) {
$month = substr ( $data [ $date_field ], 5 , 2 );
$day = substr ( $data [ $date_field ], 8 , 2 );
$year = substr ( $data [ $date_field ], 0 , 4 );
$valid_date = wp_checkdate ( $month , $day , $year , $data [ $date_field ] );
if ( ! $valid_date ) {
$errors -> add ( 'site_invalid_' . $date_field , __ ( 'Both registration and last updated dates must be valid dates.' ) );
break ;
}
}
}
if ( ! empty ( $errors -> errors ) ) {
return ;
}
// If a new site, or domain/path/network ID have changed, ensure uniqueness.
if ( ! $old_site
|| $data [ 'domain' ] !== $old_site -> domain
|| $data [ 'path' ] !== $old_site -> path
|| $data [ 'network_id' ] !== $old_site -> network_id
) {
if ( domain_exists ( $data [ 'domain' ], $data [ 'path' ], $data [ 'network_id' ] ) ) {
$errors -> add ( 'site_taken' , __ ( 'Sorry, that site already exists!' ) );
}
}
}
2012-08-08 13:11:15 -04:00
/**
* Retrieve option value for a given blog id based on name of option .
*
* If the option does not exist or does not have a value , then the return value
* will be false . This is useful to check whether you need to install an option
* and is commonly used during installation of plugin options and to test
* whether upgrading is required .
*
* If the option was serialized then it will be unserialized when it is returned .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2012-08-08 13:11:15 -04:00
*
2015-05-26 17:51:31 -04:00
* @ 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 .
2012-08-08 13:11:15 -04:00
* @ return mixed Value set for the option .
*/
function get_blog_option ( $id , $option , $default = false ) {
$id = ( int ) $id ;
2017-11-30 18:11:00 -05:00
if ( empty ( $id ) ) {
2012-08-08 13:11:15 -04:00
$id = get_current_blog_id ();
2017-11-30 18:11:00 -05:00
}
2012-08-08 13:11:15 -04:00
2017-11-30 18:11:00 -05:00
if ( get_current_blog_id () == $id ) {
2012-08-08 13:11:15 -04:00
return get_option ( $option , $default );
2017-11-30 18:11:00 -05:00
}
2012-08-08 13:11:15 -04:00
switch_to_blog ( $id );
2012-08-23 12:04:39 -04:00
$value = get_option ( $option , $default );
2012-08-08 13:11:15 -04:00
restore_current_blog ();
2013-12-01 12:32:10 -05:00
/**
2016-05-22 14:50:28 -04:00
* Filters a blog option value .
2013-12-01 12:32:10 -05:00
*
2014-11-30 07:10:23 -05:00
* The dynamic portion of the hook name , `$option` , refers to the blog option name .
2013-12-01 12:32:10 -05:00
*
* @ since 3.5 . 0
*
* @ param string $value The option value .
* @ param int $id Blog ID .
*/
return apply_filters ( " blog_option_ { $option } " , $value , $id );
2012-08-08 13:11:15 -04:00
}
/**
* Add a new option for a given blog id .
*
* You do not need to serialize values . If the value needs to be serialized , then
* it will be serialized before it is inserted into the database . Remember ,
* resources can not be serialized or added as an option .
*
* You can create options without values and then update the values later .
* Existing options will not be updated and checks are performed to ensure that you
* aren ' t adding a protected WordPress option . Care should be taken to not name
* options the same as the ones which are protected .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2012-08-08 13:11:15 -04:00
*
2015-05-26 17:51:31 -04:00
* @ param int $id A blog ID . Can be null to refer to the current blog .
2012-08-08 13:11:15 -04:00
* @ param string $option Name of option to add . Expected to not be SQL - escaped .
2015-05-26 17:51:31 -04:00
* @ param mixed $value Optional . Option value , can be anything . Expected to not be SQL - escaped .
2012-08-08 13:11:15 -04:00
* @ return bool False if option was not added and true if option was added .
*/
function add_blog_option ( $id , $option , $value ) {
$id = ( int ) $id ;
2017-11-30 18:11:00 -05:00
if ( empty ( $id ) ) {
2012-08-08 13:11:15 -04:00
$id = get_current_blog_id ();
2017-11-30 18:11:00 -05:00
}
2012-08-08 13:11:15 -04:00
2017-11-30 18:11:00 -05:00
if ( get_current_blog_id () == $id ) {
2012-08-08 13:11:15 -04:00
return add_option ( $option , $value );
2017-11-30 18:11:00 -05:00
}
2012-08-08 13:11:15 -04:00
switch_to_blog ( $id );
$return = add_option ( $option , $value );
restore_current_blog ();
return $return ;
}
/**
* Removes option by name for a given blog id . Prevents removal of protected WordPress options .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2012-08-08 13:11:15 -04:00
*
2015-05-26 17:51:31 -04:00
* @ param int $id A blog ID . Can be null to refer to the current blog .
2012-08-08 13:11:15 -04:00
* @ 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 .
*/
function delete_blog_option ( $id , $option ) {
$id = ( int ) $id ;
2017-11-30 18:11:00 -05:00
if ( empty ( $id ) ) {
2012-08-08 13:11:15 -04:00
$id = get_current_blog_id ();
2017-11-30 18:11:00 -05:00
}
2012-08-08 13:11:15 -04:00
2017-11-30 18:11:00 -05:00
if ( get_current_blog_id () == $id ) {
2012-08-08 13:11:15 -04:00
return delete_option ( $option );
2017-11-30 18:11:00 -05:00
}
2012-08-08 13:11:15 -04:00
switch_to_blog ( $id );
$return = delete_option ( $option );
restore_current_blog ();
return $return ;
}
/**
* Update an option for a particular blog .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2012-08-08 13:11:15 -04:00
*
2016-01-08 20:45:26 -05:00
* @ param int $id The blog id .
* @ param string $option The option key .
* @ param mixed $value The option value .
* @ param mixed $deprecated Not used .
2013-04-29 08:49:33 -04:00
* @ return bool True on success , false on failure .
2012-08-08 13:11:15 -04:00
*/
function update_blog_option ( $id , $option , $value , $deprecated = null ) {
$id = ( int ) $id ;
2017-11-30 18:11:00 -05:00
if ( null !== $deprecated ) {
2016-07-06 08:40:29 -04:00
_deprecated_argument ( __FUNCTION__ , '3.1.0' );
2017-11-30 18:11:00 -05:00
}
2012-08-08 13:11:15 -04:00
2017-11-30 18:11:00 -05:00
if ( get_current_blog_id () == $id ) {
2012-08-08 13:11:15 -04:00
return update_option ( $option , $value );
2017-11-30 18:11:00 -05:00
}
2012-08-08 13:11:15 -04:00
switch_to_blog ( $id );
$return = update_option ( $option , $value );
restore_current_blog ();
return $return ;
}
2018-03-15 22:15:31 -04:00
/**
* Adds metadata to a site .
*
* @ since 5.0 . 0
*
* @ param int $site_id Site ID .
* @ param string $meta_key Metadata name .
* @ param mixed $meta_value Metadata value . Must be serializable if non - scalar .
* @ param bool $unique Optional . Whether the same key should not be added .
* Default false .
* @ return int | false Meta ID on success , false on failure .
*/
function add_site_meta ( $site_id , $meta_key , $meta_value , $unique = false ) {
// Bail if site meta table is not installed.
if ( ! is_site_meta_supported () ) {
/* translators: %s: database table name */
_doing_it_wrong ( __FUNCTION__ , sprintf ( __ ( 'The %s table is not installed. Please run the network database upgrade.' ), $GLOBALS [ 'wpdb' ] -> blogmeta ), '5.0.0' );
return false ;
}
$added = add_metadata ( 'blog' , $site_id , $meta_key , $meta_value , $unique );
// Bust site query cache.
if ( $added ) {
wp_cache_set ( 'last_changed' , microtime (), 'sites' );
}
return $added ;
}
/**
* Removes metadata matching criteria from a site .
*
* You can match based on the key , or key and value . Removing based on key and
* value , will keep from removing duplicate metadata with the same key . It also
* allows removing all metadata matching key , if needed .
*
* @ since 5.0 . 0
*
* @ param int $site_id Site ID .
* @ param string $meta_key Metadata name .
* @ param mixed $meta_value Optional . Metadata value . Must be serializable if
* non - scalar . Default empty .
* @ return bool True on success , false on failure .
*/
function delete_site_meta ( $site_id , $meta_key , $meta_value = '' ) {
// Bail if site meta table is not installed.
if ( ! is_site_meta_supported () ) {
/* translators: %s: database table name */
_doing_it_wrong ( __FUNCTION__ , sprintf ( __ ( 'The %s table is not installed. Please run the network database upgrade.' ), $GLOBALS [ 'wpdb' ] -> blogmeta ), '5.0.0' );
return false ;
}
$deleted = delete_metadata ( 'blog' , $site_id , $meta_key , $meta_value );
// Bust site query cache.
if ( $deleted ) {
wp_cache_set ( 'last_changed' , microtime (), 'sites' );
}
return $deleted ;
}
/**
* Retrieves metadata for a site .
*
* @ since 5.0 . 0
*
* @ param int $site_id Site ID .
* @ param string $key Optional . The meta key to retrieve . By default , returns
* data for all keys . Default empty .
* @ param bool $single Optional . Whether to return a single value . Default false .
* @ return mixed Will be an array if $single is false . Will be value of meta data
* field if $single is true .
*/
function get_site_meta ( $site_id , $key = '' , $single = false ) {
// Bail if site meta table is not installed.
if ( ! is_site_meta_supported () ) {
/* translators: %s: database table name */
_doing_it_wrong ( __FUNCTION__ , sprintf ( __ ( 'The %s table is not installed. Please run the network database upgrade.' ), $GLOBALS [ 'wpdb' ] -> blogmeta ), '5.0.0' );
return false ;
}
return get_metadata ( 'blog' , $site_id , $key , $single );
}
/**
* Updates metadata for a site .
*
* Use the $prev_value parameter to differentiate between meta fields with the
* same key and site ID .
*
* If the meta field for the site does not exist , it will be added .
*
* @ since 5.0 . 0
*
* @ param int $site_id Site ID .
* @ param string $meta_key Metadata key .
* @ param mixed $meta_value Metadata value . Must be serializable if non - scalar .
* @ param mixed $prev_value Optional . Previous value to check before removing .
* Default empty .
* @ return int | bool Meta ID if the key didn ' t exist , true on successful update ,
* false on failure .
*/
function update_site_meta ( $site_id , $meta_key , $meta_value , $prev_value = '' ) {
// Bail if site meta table is not installed.
if ( ! is_site_meta_supported () ) {
/* translators: %s: database table name */
_doing_it_wrong ( __FUNCTION__ , sprintf ( __ ( 'The %s table is not installed. Please run the network database upgrade.' ), $GLOBALS [ 'wpdb' ] -> blogmeta ), '5.0.0' );
return false ;
}
$updated = update_metadata ( 'blog' , $site_id , $meta_key , $meta_value , $prev_value );
// Bust site query cache.
if ( $updated ) {
wp_cache_set ( 'last_changed' , microtime (), 'sites' );
}
return $updated ;
}
/**
* Deletes everything from site meta matching meta key .
*
* @ since 5.0 . 0
*
* @ param string $meta_key Metadata key to search for when deleting .
* @ return bool Whether the site meta key was deleted from the database .
*/
function delete_site_meta_by_key ( $meta_key ) {
// Bail if site meta table is not installed.
if ( ! is_site_meta_supported () ) {
/* translators: %s: database table name */
_doing_it_wrong ( __FUNCTION__ , sprintf ( __ ( 'The %s table is not installed. Please run the network database upgrade.' ), $GLOBALS [ 'wpdb' ] -> blogmeta ), '5.0.0' );
return false ;
}
$deleted = delete_metadata ( 'blog' , null , $meta_key , '' , true );
// Bust site query cache.
if ( $deleted ) {
wp_cache_set ( 'last_changed' , microtime (), 'sites' );
}
return $deleted ;
}
2010-09-30 21:32:31 -04:00
/**
* Switch the current blog .
*
* This function is useful if you need to pull posts , or other information ,
* from other blogs . You can switch back afterwards using restore_current_blog () .
*
* Things that aren ' t switched :
* - plugins . See #14941
*
* @ see restore_current_blog ()
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-09-30 21:32:31 -04:00
*
2015-05-26 17:51:31 -04:00
* @ 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
2012-08-15 11:56:14 -04:00
* @ param bool $deprecated Deprecated argument
2015-05-26 17:51:31 -04:00
* @ return true Always returns True .
2010-09-30 21:32:31 -04:00
*/
2012-08-09 12:28:15 -04:00
function switch_to_blog ( $new_blog , $deprecated = null ) {
2017-09-27 17:44:44 -04:00
global $wpdb ;
2010-02-13 17:35:11 -05:00
2016-08-31 00:55:54 -04:00
$blog_id = get_current_blog_id ();
if ( empty ( $new_blog ) ) {
$new_blog = $blog_id ;
}
2010-02-13 17:35:11 -05:00
2016-08-31 00:55:54 -04:00
$GLOBALS [ '_wp_switched_stack' ][] = $blog_id ;
2010-02-13 17:35:11 -05:00
2013-12-01 12:32:10 -05:00
/*
* If we 're switching to the same blog id that we' re on ,
* set the right vars , do the associated actions , but skip
* the extra unnecessary work
*/
2016-08-31 00:55:54 -04:00
if ( $new_blog == $blog_id ) {
2013-12-01 12:32:10 -05:00
/**
* Fires when the blog is switched .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2013-12-01 12:32:10 -05:00
*
* @ param int $new_blog New blog ID .
* @ param int $new_blog Blog ID .
*/
2012-08-09 12:28:15 -04:00
do_action ( 'switch_blog' , $new_blog , $new_blog );
2012-08-21 23:34:00 -04:00
$GLOBALS [ 'switched' ] = true ;
2010-02-13 17:35:11 -05:00
return true ;
}
2012-08-09 12:28:15 -04:00
$wpdb -> set_blog_id ( $new_blog );
2013-09-24 19:41:10 -04:00
$GLOBALS [ 'table_prefix' ] = $wpdb -> get_blog_prefix ();
2017-11-30 18:11:00 -05:00
$prev_blog_id = $blog_id ;
$GLOBALS [ 'blog_id' ] = $new_blog ;
2010-10-19 03:48:22 -04:00
2012-08-02 14:31:14 -04:00
if ( function_exists ( 'wp_cache_switch_to_blog' ) ) {
2012-08-09 12:28:15 -04:00
wp_cache_switch_to_blog ( $new_blog );
2012-08-02 14:31:14 -04:00
} else {
2012-08-09 12:28:15 -04:00
global $wp_object_cache ;
2016-08-31 00:55:54 -04:00
if ( is_object ( $wp_object_cache ) && isset ( $wp_object_cache -> global_groups ) ) {
2012-08-02 14:31:14 -04:00
$global_groups = $wp_object_cache -> global_groups ;
2016-08-31 00:55:54 -04:00
} else {
2012-08-02 14:31:14 -04:00
$global_groups = false ;
2016-08-31 00:55:54 -04:00
}
2012-08-02 14:31:14 -04:00
wp_cache_init ();
2012-08-09 12:28:15 -04:00
if ( function_exists ( 'wp_cache_add_global_groups' ) ) {
2015-02-05 22:24:23 -05:00
if ( is_array ( $global_groups ) ) {
2012-08-02 14:31:14 -04:00
wp_cache_add_global_groups ( $global_groups );
2015-02-05 22:24:23 -05:00
} else {
2018-03-15 22:15:31 -04:00
wp_cache_add_global_groups ( array ( 'users' , 'userlogins' , 'usermeta' , 'user_meta' , 'useremail' , 'userslugs' , 'site-transient' , 'site-options' , 'blog-lookup' , 'blog-details' , 'rss' , 'global-posts' , 'blog-id-cache' , 'networks' , 'sites' , 'site-details' , 'blog_meta' ) );
2015-02-05 22:24:23 -05:00
}
2016-06-01 17:26:27 -04:00
wp_cache_add_non_persistent_groups ( array ( 'counts' , 'plugins' ) );
2012-08-02 14:31:14 -04:00
}
2010-02-13 17:35:11 -05:00
}
2013-12-01 12:32:10 -05:00
/** This filter is documented in wp-includes/ms-blogs.php */
2012-08-09 12:28:15 -04:00
do_action ( 'switch_blog' , $new_blog , $prev_blog_id );
2012-08-21 23:34:00 -04:00
$GLOBALS [ 'switched' ] = true ;
2012-08-09 12:28:15 -04:00
2010-02-13 17:35:11 -05:00
return true ;
}
2010-09-30 21:32:31 -04:00
/**
* Restore the current blog , after calling switch_to_blog ()
*
* @ see switch_to_blog ()
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-09-30 21:32:31 -04:00
*
2015-05-26 17:51:31 -04:00
* @ 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
*
2012-08-15 11:56:14 -04:00
* @ return bool True on success , false if we ' re already on the current blog
2010-09-30 21:32:31 -04:00
*/
2010-02-13 17:35:11 -05:00
function restore_current_blog () {
2017-09-27 17:44:44 -04:00
global $wpdb ;
2010-02-13 17:35:11 -05:00
2016-08-31 00:55:54 -04:00
if ( empty ( $GLOBALS [ '_wp_switched_stack' ] ) ) {
2010-02-13 17:35:11 -05:00
return false ;
2016-08-31 00:55:54 -04:00
}
2010-02-13 17:35:11 -05:00
2017-11-30 18:11:00 -05:00
$blog = array_pop ( $GLOBALS [ '_wp_switched_stack' ] );
2016-08-31 00:55:54 -04:00
$blog_id = get_current_blog_id ();
2010-02-13 17:35:11 -05:00
2016-08-31 00:55:54 -04:00
if ( $blog_id == $blog ) {
2013-12-01 12:32:10 -05:00
/** This filter is documented in wp-includes/ms-blogs.php */
2010-02-13 17:35:11 -05:00
do_action ( 'switch_blog' , $blog , $blog );
2012-08-09 12:28:15 -04:00
// If we still have items in the switched stack, consider ourselves still 'switched'
2012-08-21 23:34:00 -04:00
$GLOBALS [ 'switched' ] = ! empty ( $GLOBALS [ '_wp_switched_stack' ] );
2010-02-13 17:35:11 -05:00
return true ;
}
2012-08-09 12:28:15 -04:00
$wpdb -> set_blog_id ( $blog );
2017-11-30 18:11:00 -05:00
$prev_blog_id = $blog_id ;
$GLOBALS [ 'blog_id' ] = $blog ;
2013-09-24 19:41:10 -04:00
$GLOBALS [ 'table_prefix' ] = $wpdb -> get_blog_prefix ();
2010-02-13 17:35:11 -05:00
2012-08-02 14:31:14 -04:00
if ( function_exists ( 'wp_cache_switch_to_blog' ) ) {
2012-08-09 12:28:15 -04:00
wp_cache_switch_to_blog ( $blog );
2012-08-02 14:31:14 -04:00
} else {
2012-08-09 12:28:15 -04:00
global $wp_object_cache ;
2016-08-31 00:55:54 -04:00
if ( is_object ( $wp_object_cache ) && isset ( $wp_object_cache -> global_groups ) ) {
2012-08-02 14:31:14 -04:00
$global_groups = $wp_object_cache -> global_groups ;
2016-08-31 00:55:54 -04:00
} else {
2012-08-02 14:31:14 -04:00
$global_groups = false ;
2016-08-31 00:55:54 -04:00
}
2012-11-17 10:11:29 -05:00
2012-08-02 14:31:14 -04:00
wp_cache_init ();
2012-08-09 12:28:15 -04:00
if ( function_exists ( 'wp_cache_add_global_groups' ) ) {
2015-02-05 22:24:23 -05:00
if ( is_array ( $global_groups ) ) {
2012-08-02 14:31:14 -04:00
wp_cache_add_global_groups ( $global_groups );
2015-02-05 22:24:23 -05:00
} else {
2018-03-15 22:15:31 -04:00
wp_cache_add_global_groups ( array ( 'users' , 'userlogins' , 'usermeta' , 'user_meta' , 'useremail' , 'userslugs' , 'site-transient' , 'site-options' , 'blog-lookup' , 'blog-details' , 'rss' , 'global-posts' , 'blog-id-cache' , 'networks' , 'sites' , 'site-details' , 'blog_meta' ) );
2015-02-05 22:24:23 -05:00
}
2016-06-01 17:26:27 -04:00
wp_cache_add_non_persistent_groups ( array ( 'counts' , 'plugins' ) );
2012-08-02 14:31:14 -04:00
}
2010-02-13 17:35:11 -05:00
}
2013-12-01 12:32:10 -05:00
/** This filter is documented in wp-includes/ms-blogs.php */
2012-08-09 12:28:15 -04:00
do_action ( 'switch_blog' , $blog , $prev_blog_id );
// If we still have items in the switched stack, consider ourselves still 'switched'
2012-08-21 23:34:00 -04:00
$GLOBALS [ 'switched' ] = ! empty ( $GLOBALS [ '_wp_switched_stack' ] );
2010-02-13 17:35:11 -05:00
return true ;
}
2017-09-27 17:44:44 -04:00
/**
* Switches the initialized roles and current user capabilities to another site .
*
* @ since 4.9 . 0
*
* @ param int $new_site_id New site ID .
* @ param int $old_site_id Old site ID .
*/
function wp_switch_roles_and_user ( $new_site_id , $old_site_id ) {
if ( $new_site_id == $old_site_id ) {
return ;
}
if ( ! did_action ( 'init' ) ) {
return ;
}
wp_roles () -> for_site ( $new_site_id );
wp_get_current_user () -> for_site ( $new_site_id );
}
2012-08-20 16:48:35 -04:00
/**
* Determines if switch_to_blog () is in effect
*
* @ since 3.5 . 0
*
2015-05-26 17:51:31 -04:00
* @ global array $_wp_switched_stack
*
2012-08-20 16:48:35 -04:00
* @ return bool True if switched , false otherwise .
*/
2012-08-20 16:56:34 -04:00
function ms_is_switched () {
2012-09-26 13:02:44 -04:00
return ! empty ( $GLOBALS [ '_wp_switched_stack' ] );
2012-08-20 16:48:35 -04:00
}
2010-09-30 21:32:31 -04:00
/**
* Check if a particular blog is archived .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-09-30 21:32:31 -04:00
*
* @ param int $id The blog id
2010-10-07 22:35:06 -04:00
* @ return string Whether the blog is archived or not
2010-09-30 21:32:31 -04:00
*/
2010-02-13 17:35:11 -05:00
function is_archived ( $id ) {
2017-11-30 18:11:00 -05:00
return get_blog_status ( $id , 'archived' );
2010-02-13 17:35:11 -05:00
}
2010-09-30 21:32:31 -04:00
/**
* Update the 'archived' status of a particular blog .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-09-30 21:32:31 -04:00
*
2015-05-26 17:51:31 -04:00
* @ param int $id The blog id
2010-09-30 21:32:31 -04:00
* @ param string $archived The new status
* @ return string $archived
*/
2010-02-13 17:35:11 -05:00
function update_archived ( $id , $archived ) {
2017-11-30 18:11:00 -05:00
update_blog_status ( $id , 'archived' , $archived );
2010-02-13 17:35:11 -05:00
return $archived ;
}
/**
* Update a blog details field .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
Multisite: Complete the new CRUD API for managing sites.
New functions `wp_insert_site( $data )`, `wp_update_site( $id, $data )` and `wp_delete_site( $id )` are introduced to manage site rows in the `wp_blogs` table, forming the new CRUD API together with the existing `get_site()` / `get_sites()`. The new API provides various benefits over the previously existing API, fixing several cache invalidation issues and being hook-driven so that normalization and validation of the passed data can be fully customized.
New hooks introduced as part of this are the actions `wp_insert_site`, `wp_update_site`, `wp_delete_site`, `wp_validate_site_data` and the filter `wp_normalize_site_data`.
At this point, `wp_insert_site()` does not handle setting up the site's database tables, and `wp_delete_site()` does not handle dropping the site's database tables, so the two can not yet be used directly as full replacements of `wpmu_create_blog()` and `wpmu_delete_blog()`. Managing the site's database tables will be added via hooks as part of the follow-up ticket #41333.
The existing functions `wpmu_create_blog()`, `update_blog_details()`, and `wpmu_delete_blog()` make use of the respective new counterpart and will be obsolete once #41333 has been completed.
Props flixos90, jeremyfelt, spacedmonkey.
Fixes #40364.
Built from https://develop.svn.wordpress.org/trunk@43548
git-svn-id: http://core.svn.wordpress.org/trunk@43377 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-08-01 09:06:26 -04:00
* @ since 5.0 . 0 Use wp_update_site () internally .
2010-02-13 17:35:11 -05:00
*
2015-10-14 19:44:25 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 17:51:31 -04:00
*
* @ 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
2010-02-13 17:35:11 -05:00
*/
2010-12-01 17:12:09 -05:00
function update_blog_status ( $blog_id , $pref , $value , $deprecated = null ) {
2010-02-13 17:35:11 -05:00
global $wpdb ;
2017-11-30 18:11:00 -05:00
if ( null !== $deprecated ) {
2016-07-06 08:40:29 -04:00
_deprecated_argument ( __FUNCTION__ , '3.1.0' );
2017-11-30 18:11:00 -05:00
}
2010-12-01 17:12:09 -05:00
2017-11-30 18:11:00 -05:00
if ( ! in_array ( $pref , array ( 'site_id' , 'domain' , 'path' , 'registered' , 'last_updated' , 'public' , 'archived' , 'mature' , 'spam' , 'deleted' , 'lang_id' ) ) ) {
2010-02-13 17:35:11 -05:00
return $value ;
2017-11-30 18:11:00 -05:00
}
2010-02-13 17:35:11 -05:00
Multisite: Complete the new CRUD API for managing sites.
New functions `wp_insert_site( $data )`, `wp_update_site( $id, $data )` and `wp_delete_site( $id )` are introduced to manage site rows in the `wp_blogs` table, forming the new CRUD API together with the existing `get_site()` / `get_sites()`. The new API provides various benefits over the previously existing API, fixing several cache invalidation issues and being hook-driven so that normalization and validation of the passed data can be fully customized.
New hooks introduced as part of this are the actions `wp_insert_site`, `wp_update_site`, `wp_delete_site`, `wp_validate_site_data` and the filter `wp_normalize_site_data`.
At this point, `wp_insert_site()` does not handle setting up the site's database tables, and `wp_delete_site()` does not handle dropping the site's database tables, so the two can not yet be used directly as full replacements of `wpmu_create_blog()` and `wpmu_delete_blog()`. Managing the site's database tables will be added via hooks as part of the follow-up ticket #41333.
The existing functions `wpmu_create_blog()`, `update_blog_details()`, and `wpmu_delete_blog()` make use of the respective new counterpart and will be obsolete once #41333 has been completed.
Props flixos90, jeremyfelt, spacedmonkey.
Fixes #40364.
Built from https://develop.svn.wordpress.org/trunk@43548
git-svn-id: http://core.svn.wordpress.org/trunk@43377 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-08-01 09:06:26 -04:00
$result = wp_update_site ( $blog_id , array (
$pref => $value ,
) );
2010-02-13 17:35:11 -05:00
Multisite: Complete the new CRUD API for managing sites.
New functions `wp_insert_site( $data )`, `wp_update_site( $id, $data )` and `wp_delete_site( $id )` are introduced to manage site rows in the `wp_blogs` table, forming the new CRUD API together with the existing `get_site()` / `get_sites()`. The new API provides various benefits over the previously existing API, fixing several cache invalidation issues and being hook-driven so that normalization and validation of the passed data can be fully customized.
New hooks introduced as part of this are the actions `wp_insert_site`, `wp_update_site`, `wp_delete_site`, `wp_validate_site_data` and the filter `wp_normalize_site_data`.
At this point, `wp_insert_site()` does not handle setting up the site's database tables, and `wp_delete_site()` does not handle dropping the site's database tables, so the two can not yet be used directly as full replacements of `wpmu_create_blog()` and `wpmu_delete_blog()`. Managing the site's database tables will be added via hooks as part of the follow-up ticket #41333.
The existing functions `wpmu_create_blog()`, `update_blog_details()`, and `wpmu_delete_blog()` make use of the respective new counterpart and will be obsolete once #41333 has been completed.
Props flixos90, jeremyfelt, spacedmonkey.
Fixes #40364.
Built from https://develop.svn.wordpress.org/trunk@43548
git-svn-id: http://core.svn.wordpress.org/trunk@43377 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-08-01 09:06:26 -04:00
if ( is_wp_error ( $result ) ) {
2012-10-11 08:37:46 -04:00
return false ;
2017-11-30 18:11:00 -05:00
}
2012-10-11 08:37:46 -04:00
2010-02-13 17:35:11 -05:00
return $value ;
}
2010-09-30 21:32:31 -04:00
/**
* Get a blog details field .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-09-30 21:32:31 -04:00
*
2015-10-14 19:44:25 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 17:51:31 -04:00
*
* @ param int $id The blog id
2010-09-30 21:32:31 -04:00
* @ param string $pref A field name
2015-05-26 17:51:31 -04:00
* @ return bool | string | null $value
2010-09-30 21:32:31 -04:00
*/
2010-02-13 17:35:11 -05:00
function get_blog_status ( $id , $pref ) {
global $wpdb ;
2016-10-25 14:50:30 -04:00
$details = get_site ( $id );
2017-11-30 18:11:00 -05:00
if ( $details ) {
2010-02-13 17:35:11 -05:00
return $details -> $pref ;
2017-11-30 18:11:00 -05:00
}
2010-02-13 17:35:11 -05:00
2017-11-30 18:11:00 -05:00
return $wpdb -> get_var ( $wpdb -> prepare ( " SELECT %s FROM { $wpdb -> blogs } WHERE blog_id = %d " , $pref , $id ) );
2010-02-13 17:35:11 -05:00
}
2010-09-30 21:32:31 -04:00
/**
* Get a list of most recently updated blogs .
*
2017-08-01 16:44:43 -04:00
* @ since MU ( 3.0 . 0 )
2010-10-19 03:48:22 -04:00
*
2015-10-14 19:44:25 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 17:51:31 -04:00
*
2010-11-18 14:12:48 -05:00
* @ param mixed $deprecated Not used
2015-05-26 17:51:31 -04:00
* @ param int $start The offset
* @ param int $quantity The maximum number of blogs to retrieve . Default is 40.
2010-09-30 21:32:31 -04:00
* @ return array The list of blogs
*/
2010-02-13 17:35:11 -05:00
function get_last_updated ( $deprecated = '' , $start = 0 , $quantity = 40 ) {
global $wpdb ;
2010-12-13 16:21:50 -05:00
2017-11-30 18:11:00 -05:00
if ( ! empty ( $deprecated ) ) {
2010-11-18 14:12:48 -05:00
_deprecated_argument ( __FUNCTION__ , 'MU' ); // never used
2017-11-30 18:11:00 -05:00
}
2010-12-13 16:21:50 -05:00
2017-08-12 09:11:43 -04:00
return $wpdb -> get_results ( $wpdb -> prepare ( " SELECT blog_id, domain, path FROM $wpdb->blogs WHERE site_id = %d AND public = '1' AND archived = '0' AND mature = '0' AND spam = '0' AND deleted = '0' AND last_updated != '0000-00-00 00:00:00' ORDER BY last_updated DESC limit %d, %d " , get_current_network_id (), $start , $quantity ), ARRAY_A );
2010-02-13 17:35:11 -05:00
}
2016-06-28 17:28:29 -04:00
/**
* Retrieves a list of networks .
*
* @ since 4.6 . 0
*
2016-07-13 12:04:29 -04:00
* @ param string | array $args Optional . Array or string of arguments . See WP_Network_Query :: parse_query ()
* for information on accepted arguments . Default empty array .
2017-10-18 14:13:50 -04:00
* @ return array | int List of WP_Network objects , a list of network ids when 'fields' is set to 'ids' ,
* or the number of networks when 'count' is passed as a query var .
2016-06-28 17:28:29 -04:00
*/
2016-07-13 01:30:29 -04:00
function get_networks ( $args = array () ) {
2016-06-28 17:28:29 -04:00
$query = new WP_Network_Query ();
return $query -> query ( $args );
}
2016-06-28 17:18:30 -04:00
/**
* Retrieves network data given a network ID or network object .
*
* Network data will be cached and returned after being passed through a filter .
* If the provided network is empty , the current network global will be used .
*
* @ since 4.6 . 0
*
2016-09-20 17:39:29 -04:00
* @ global WP_Network $current_site
*
2016-08-09 14:12:31 -04:00
* @ param WP_Network | int | null $network Optional . Network to retrieve . Default is the current network .
2016-06-28 17:18:30 -04:00
* @ return WP_Network | null The network object or null if not found .
*/
2016-08-09 14:12:31 -04:00
function get_network ( $network = null ) {
2016-09-20 17:39:29 -04:00
global $current_site ;
2016-06-28 17:18:30 -04:00
if ( empty ( $network ) && isset ( $current_site ) ) {
$network = $current_site ;
}
if ( $network instanceof WP_Network ) {
$_network = $network ;
} elseif ( is_object ( $network ) ) {
$_network = new WP_Network ( $network );
} else {
$_network = WP_Network :: get_instance ( $network );
}
if ( ! $_network ) {
return null ;
}
/**
* Fires after a network is retrieved .
*
* @ since 4.6 . 0
*
* @ param WP_Network $_network Network data .
*/
$_network = apply_filters ( 'get_network' , $_network );
return $_network ;
}
2016-06-28 17:27:30 -04:00
/**
* Removes a network from the object cache .
*
* @ since 4.6 . 0
*
2017-03-28 15:36:49 -04:00
* @ global bool $_wp_suspend_cache_invalidation
*
2016-06-28 17:27:30 -04:00
* @ param int | array $ids Network ID or an array of network IDs to remove from cache .
*/
function clean_network_cache ( $ids ) {
2017-03-28 15:36:49 -04:00
global $_wp_suspend_cache_invalidation ;
if ( ! empty ( $_wp_suspend_cache_invalidation ) ) {
return ;
}
2016-06-28 17:27:30 -04:00
foreach ( ( array ) $ids as $id ) {
wp_cache_delete ( $id , 'networks' );
/**
* Fires immediately after a network has been removed from the object cache .
*
* @ since 4.6 . 0
*
* @ param int $id Network ID .
*/
do_action ( 'clean_network_cache' , $id );
}
wp_cache_set ( 'last_changed' , microtime (), 'networks' );
}
/**
* Updates the network cache of given networks .
*
* Will add the networks in $networks to the cache . If network ID already exists
* in the network cache then it will not be updated . The network is added to the
* cache using the network group with the key using the ID of the networks .
*
* @ since 4.6 . 0
*
* @ param array $networks Array of network row objects .
*/
function update_network_cache ( $networks ) {
foreach ( ( array ) $networks as $network ) {
wp_cache_add ( $network -> id , $network , 'networks' );
}
}
/**
* Adds any networks from the given IDs to the cache that do not already exist in cache .
*
* @ since 4.6 . 0
* @ access private
*
* @ see update_network_cache ()
* @ global wpdb $wpdb WordPress database abstraction object .
*
* @ param array $network_ids Array of network IDs .
*/
function _prime_network_caches ( $network_ids ) {
global $wpdb ;
$non_cached_ids = _get_non_cached_ids ( $network_ids , 'networks' );
2017-11-30 18:11:00 -05:00
if ( ! empty ( $non_cached_ids ) ) {
$fresh_networks = $wpdb -> get_results ( sprintf ( " SELECT $wpdb->site .* FROM $wpdb->site WHERE id IN (%s) " , join ( ',' , array_map ( 'intval' , $non_cached_ids ) ) ) );
2016-06-28 17:27:30 -04:00
update_network_cache ( $fresh_networks );
}
}
2011-11-03 13:06:45 -04:00
/**
2017-10-01 23:20:47 -04:00
* Handler for updating the site ' s last updated date when a post is published or
* an already published post is changed .
2011-11-03 13:06:45 -04:00
*
* @ since 3.3 . 0
*
* @ param string $new_status The new post status
* @ param string $old_status The old post status
2015-05-26 17:51:31 -04:00
* @ param object $post Post object
2011-11-03 13:06:45 -04:00
*/
function _update_blog_date_on_post_publish ( $new_status , $old_status , $post ) {
$post_type_obj = get_post_type_object ( $post -> post_type );
2014-07-28 20:51:17 -04:00
if ( ! $post_type_obj || ! $post_type_obj -> public ) {
2011-11-03 13:06:45 -04:00
return ;
2014-07-28 20:51:17 -04:00
}
2011-11-03 13:06:45 -04:00
2014-07-28 20:51:17 -04:00
if ( 'publish' != $new_status && 'publish' != $old_status ) {
2011-11-03 13:06:45 -04:00
return ;
2014-07-28 20:51:17 -04:00
}
2011-11-03 13:06:45 -04:00
// Post was freshly published, published post was saved, or published post was unpublished.
wpmu_update_blogs_date ();
}
2012-04-13 13:30:37 -04:00
/**
2017-10-01 23:20:47 -04:00
* Handler for updating the current site ' s last updated date when a published
* post is deleted .
2012-04-13 13:30:37 -04:00
*
* @ since 3.4 . 0
*
* @ param int $post_id Post ID
*/
function _update_blog_date_on_post_delete ( $post_id ) {
$post = get_post ( $post_id );
$post_type_obj = get_post_type_object ( $post -> post_type );
2014-07-28 20:51:17 -04:00
if ( ! $post_type_obj || ! $post_type_obj -> public ) {
2012-04-13 13:30:37 -04:00
return ;
2014-07-28 20:51:17 -04:00
}
2012-04-13 13:30:37 -04:00
2014-07-28 20:51:17 -04:00
if ( 'publish' != $post -> post_status ) {
2012-04-13 13:30:37 -04:00
return ;
2014-07-28 20:51:17 -04:00
}
2012-04-13 13:30:37 -04:00
wpmu_update_blogs_date ();
}
2014-06-25 20:53:15 -04:00
/**
2017-10-01 23:20:47 -04:00
* Handler for updating the current site ' s posts count when a post is deleted .
2014-06-25 20:53:15 -04:00
*
2014-07-28 20:59:16 -04:00
* @ since 4.0 . 0
2014-06-25 20:53:15 -04:00
*
2014-07-13 21:02:15 -04:00
* @ param int $post_id Post ID .
2014-06-25 20:53:15 -04:00
*/
function _update_posts_count_on_delete ( $post_id ) {
2014-09-02 03:17:17 -04:00
$post = get_post ( $post_id );
2017-10-01 23:09:44 -04:00
if ( ! $post || 'publish' !== $post -> post_status || 'post' !== $post -> post_type ) {
2014-06-25 20:53:15 -04:00
return ;
}
2014-06-28 00:07:16 -04:00
2014-06-25 20:53:15 -04:00
update_posts_count ();
}
/**
2017-10-01 23:20:47 -04:00
* Handler for updating the current site ' s posts count when a post status changes .
2014-06-25 20:53:15 -04:00
*
2014-07-28 20:59:16 -04:00
* @ since 4.0 . 0
2017-10-01 23:09:44 -04:00
* @ since 4.9 . 0 Added the `$post` parameter .
2014-06-25 20:53:15 -04:00
*
2017-10-01 23:09:44 -04:00
* @ param string $new_status The status the post is changing to .
* @ param string $old_status The status the post is changing from .
* @ param WP_Post $post Post object
2014-06-25 20:53:15 -04:00
*/
2017-10-01 23:09:44 -04:00
function _update_posts_count_on_transition_post_status ( $new_status , $old_status , $post = null ) {
2014-06-25 20:53:15 -04:00
if ( $new_status === $old_status ) {
return ;
}
2017-10-01 23:09:44 -04:00
if ( 'post' !== get_post_type ( $post ) ) {
return ;
}
2014-06-25 20:53:15 -04:00
if ( 'publish' !== $new_status && 'publish' !== $old_status ) {
return ;
}
update_posts_count ();
}
Multisite: Complete the new CRUD API for managing sites.
New functions `wp_insert_site( $data )`, `wp_update_site( $id, $data )` and `wp_delete_site( $id )` are introduced to manage site rows in the `wp_blogs` table, forming the new CRUD API together with the existing `get_site()` / `get_sites()`. The new API provides various benefits over the previously existing API, fixing several cache invalidation issues and being hook-driven so that normalization and validation of the passed data can be fully customized.
New hooks introduced as part of this are the actions `wp_insert_site`, `wp_update_site`, `wp_delete_site`, `wp_validate_site_data` and the filter `wp_normalize_site_data`.
At this point, `wp_insert_site()` does not handle setting up the site's database tables, and `wp_delete_site()` does not handle dropping the site's database tables, so the two can not yet be used directly as full replacements of `wpmu_create_blog()` and `wpmu_delete_blog()`. Managing the site's database tables will be added via hooks as part of the follow-up ticket #41333.
The existing functions `wpmu_create_blog()`, `update_blog_details()`, and `wpmu_delete_blog()` make use of the respective new counterpart and will be obsolete once #41333 has been completed.
Props flixos90, jeremyfelt, spacedmonkey.
Fixes #40364.
Built from https://develop.svn.wordpress.org/trunk@43548
git-svn-id: http://core.svn.wordpress.org/trunk@43377 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2018-08-01 09:06:26 -04:00
/**
* Updates the count of sites for a network based on a changed site .
*
* @ since 5.0 . 0
*
* @ param WP_Site $new_site The site object that has been inserted , updated or deleted .
* @ param WP_Site | null $old_site Optional . If $new_site has been updated , this must be the previous
* state of that site . Default null .
*/
function wp_maybe_update_network_site_counts_on_update ( $new_site , $old_site = null ) {
if ( null === $old_site ) {
wp_maybe_update_network_site_counts ( $new_site -> network_id );
return ;
}
if ( $new_site -> network_id != $old_site -> network_id ) {
wp_maybe_update_network_site_counts ( $new_site -> network_id );
wp_maybe_update_network_site_counts ( $old_site -> network_id );
}
}
/**
* Triggers actions on site status updates .
*
* @ since 5.0 . 0
*
* @ param WP_Site $new_site The site object after the update .
* @ param WP_Site | null $old_site Optional . If $new_site has been updated , this must be the previous
* state of that site . Default null .
*/
function wp_maybe_transition_site_statuses_on_update ( $new_site , $old_site = null ) {
$site_id = $new_site -> id ;
// Use the default values for a site if no previous state is given.
if ( ! $old_site ) {
$old_site = new WP_Site ( new stdClass () );
}
if ( $new_site -> spam != $old_site -> spam ) {
if ( $new_site -> spam == 1 ) {
/**
* Fires when the 'spam' status is added to a site .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $site_id Site ID .
*/
do_action ( 'make_spam_blog' , $site_id );
} else {
/**
* Fires when the 'spam' status is removed from a site .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $site_id Site ID .
*/
do_action ( 'make_ham_blog' , $site_id );
}
}
if ( $new_site -> mature != $old_site -> mature ) {
if ( $new_site -> mature == 1 ) {
/**
* Fires when the 'mature' status is added to a site .
*
* @ since 3.1 . 0
*
* @ param int $site_id Site ID .
*/
do_action ( 'mature_blog' , $site_id );
} else {
/**
* Fires when the 'mature' status is removed from a site .
*
* @ since 3.1 . 0
*
* @ param int $site_id Site ID .
*/
do_action ( 'unmature_blog' , $site_id );
}
}
if ( $new_site -> archived != $old_site -> archived ) {
if ( $new_site -> archived == 1 ) {
/**
* Fires when the 'archived' status is added to a site .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $site_id Site ID .
*/
do_action ( 'archive_blog' , $site_id );
} else {
/**
* Fires when the 'archived' status is removed from a site .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $site_id Site ID .
*/
do_action ( 'unarchive_blog' , $site_id );
}
}
if ( $new_site -> deleted != $old_site -> deleted ) {
if ( $new_site -> deleted == 1 ) {
/**
* Fires when the 'deleted' status is added to a site .
*
* @ since 3.5 . 0
*
* @ param int $site_id Site ID .
*/
do_action ( 'make_delete_blog' , $site_id );
} else {
/**
* Fires when the 'deleted' status is removed from a site .
*
* @ since 3.5 . 0
*
* @ param int $site_id Site ID .
*/
do_action ( 'make_undelete_blog' , $site_id );
}
}
if ( $new_site -> public != $old_site -> public ) {
/**
* Fires after the current blog 's ' public ' setting is updated .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $site_id Site ID .
* @ param string $value The value of the site status .
*/
do_action ( 'update_blog_public' , $site_id , $new_site -> public );
}
}
/**
* Cleans the necessary caches after specific site data has been updated .
*
* @ since 5.0 . 0
*
* @ param WP_Site $new_site The site object after the update .
* @ param WP_Site $old_site The site obejct prior to the update .
*/
function wp_maybe_clean_new_site_cache_on_update ( $new_site , $old_site ) {
if ( $old_site -> domain !== $new_site -> domain || $old_site -> path !== $new_site -> path ) {
clean_blog_cache ( $new_site );
}
}
/**
* Updates the `blog_public` option for a given site ID .
*
* @ since 5.0 . 0
*
* @ param int $site_id Site ID .
* @ param string $public The value of the site status .
*/
function wp_update_blog_public_option_on_site_update ( $site_id , $public ) {
update_blog_option ( $site_id , 'blog_public' , $public );
}