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
2010-09-30 21:32:31 -04:00
* @ since MU
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
*
* @ since MU
2015-05-26 17:51:31 -04:00
*
2015-10-14 19:44:25 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2010-09-30 21:32:31 -04:00
*/
2010-02-13 17:35:11 -05:00
function wpmu_update_blogs_date () {
global $wpdb ;
2011-08-25 14:01:49 -04:00
update_blog_details ( $wpdb -> blogid , array ( 'last_updated' => current_time ( 'mysql' , true )) );
2013-12-01 12:32:10 -05:00
/**
* Fires after the blog details are updated .
*
* @ since MU
*
2016-01-27 22:35:27 -05:00
* @ param int $blog_id Site ID .
2013-12-01 12:32:10 -05:00
*/
2010-02-13 17:35:11 -05:00
do_action ( 'wpmu_blog_updated' , $wpdb -> blogid );
}
2010-09-30 21:32:31 -04:00
/**
* Get a full blog URL , given a blog id .
*
* @ since MU
*
* @ 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 ) {
2015-10-29 22:02:24 -04:00
$bloginfo = get_blog_details ( ( int ) $blog_id );
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 .
*
* @ since MU
*
* @ 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 () ) {
if ( $blogname == 'main' )
$blogname = 'www' ;
2010-05-16 18:21:06 -04:00
$url = rtrim ( network_home_url (), '/' );
if ( ! empty ( $blogname ) )
2013-03-13 12:00:38 -04:00
$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
/**
2012-12-20 10:55:32 -05:00
* Given a blog ' s ( subdomain or directory ) slug , retrieve its id .
2010-09-30 21:32:31 -04:00
*
* @ since MU
*
2015-10-14 19:44:25 -04:00
* @ global wpdb $wpdb WordPress database abstraction object .
2015-05-26 17:51:31 -04:00
*
2012-09-24 15:31:37 -04:00
* @ param string $slug
2010-09-30 21:32:31 -04:00
* @ return int A blog id
*/
2012-09-24 15:31:37 -04:00
function get_id_from_blogname ( $slug ) {
2013-11-12 22:23:10 -05:00
global $wpdb ;
2012-09-24 15:31:37 -04:00
2013-11-12 22:23:10 -05:00
$current_site = get_current_site ();
2012-09-24 15:31:37 -04:00
$slug = trim ( $slug , '/' );
$blog_id = wp_cache_get ( 'get_id_from_blogname_' . $slug , 'blog-details' );
2010-02-13 17:35:11 -05:00
if ( $blog_id )
return $blog_id ;
if ( is_subdomain_install () ) {
2012-09-24 15:31:37 -04:00
$domain = $slug . '.' . $current_site -> domain ;
2010-02-13 17:35:11 -05:00
$path = $current_site -> path ;
} else {
$domain = $current_site -> domain ;
2012-09-24 15:31:37 -04:00
$path = $current_site -> path . $slug . '/' ;
2010-02-13 17:35:11 -05:00
}
2012-09-24 15:31:37 -04:00
2010-02-13 17:35:11 -05:00
$blog_id = $wpdb -> get_var ( $wpdb -> prepare ( " SELECT blog_id FROM { $wpdb -> blogs } WHERE domain = %s AND path = %s " , $domain , $path ) );
2012-09-24 15:31:37 -04:00
wp_cache_set ( 'get_id_from_blogname_' . $slug , $blog_id , 'blog-details' );
2010-02-13 17:35:11 -05:00
return $blog_id ;
}
/**
* Retrieve the details for a blog from the blogs table and blog options .
*
2010-09-30 21:32:31 -04:00
* @ since MU
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
*
* @ 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 ) {
2010-02-13 17:35:11 -05:00
global $wpdb ;
2010-02-13 18:09:54 -05:00
if ( is_array ( $fields ) ) {
if ( isset ( $fields [ 'blog_id' ]) ) {
$blog_id = $fields [ 'blog_id' ];
} elseif ( isset ( $fields [ 'domain' ]) && isset ( $fields [ 'path' ]) ) {
$key = md5 ( $fields [ 'domain' ] . $fields [ 'path' ] );
$blog = wp_cache_get ( $key , 'blog-lookup' );
if ( false !== $blog )
return $blog ;
2010-05-02 19:33:02 -04:00
if ( substr ( $fields [ 'domain' ], 0 , 4 ) == 'www.' ) {
$nowww = substr ( $fields [ 'domain' ], 4 );
2010-05-02 17:34:11 -04: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' ] ) );
} else {
$blog = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT * FROM $wpdb->blogs WHERE domain = %s AND path = %s " , $fields [ 'domain' ], $fields [ 'path' ] ) );
}
2010-02-13 18:09:54 -05:00
if ( $blog ) {
wp_cache_set ( $blog -> blog_id . 'short' , $blog , 'blog-details' );
$blog_id = $blog -> blog_id ;
} else {
return false ;
}
} elseif ( isset ( $fields [ 'domain' ]) && is_subdomain_install () ) {
$key = md5 ( $fields [ 'domain' ] );
$blog = wp_cache_get ( $key , 'blog-lookup' );
if ( false !== $blog )
return $blog ;
2010-05-02 17:40:31 -04:00
if ( substr ( $fields [ 'domain' ], 0 , 4 ) == 'www.' ) {
$nowww = substr ( $fields [ 'domain' ], 4 );
$blog = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT * FROM $wpdb->blogs WHERE domain IN (%s,%s) ORDER BY CHAR_LENGTH(domain) DESC " , $nowww , $fields [ 'domain' ] ) );
2010-05-02 17:34:11 -04:00
} else {
$blog = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT * FROM $wpdb->blogs WHERE domain = %s " , $fields [ 'domain' ] ) );
}
2010-02-13 18:09:54 -05:00
if ( $blog ) {
wp_cache_set ( $blog -> blog_id . 'short' , $blog , 'blog-details' );
$blog_id = $blog -> blog_id ;
} else {
return false ;
}
} else {
return false ;
}
} else {
2012-10-04 08:40:09 -04:00
if ( ! $fields )
$blog_id = get_current_blog_id ();
elseif ( ! is_numeric ( $fields ) )
2010-02-13 18:09:54 -05:00
$blog_id = get_id_from_blogname ( $fields );
else
$blog_id = $fields ;
}
2010-02-13 17:35:11 -05:00
$blog_id = ( int ) $blog_id ;
$all = $get_all == true ? '' : 'short' ;
$details = wp_cache_get ( $blog_id . $all , 'blog-details' );
if ( $details ) {
if ( ! is_object ( $details ) ) {
2010-04-13 08:43:40 -04:00
if ( $details == - 1 ) {
2010-02-13 17:35:11 -05:00
return false ;
2010-04-13 08:43:40 -04:00
} else {
2010-02-13 17:35:11 -05:00
// Clear old pre-serialized objects. Cache clients do better with that.
wp_cache_delete ( $blog_id . $all , 'blog-details' );
2010-04-13 08:43:40 -04:00
unset ( $details );
}
} else {
return $details ;
2010-02-13 17:35:11 -05:00
}
}
2010-02-13 18:09:54 -05:00
// Try the other cache.
if ( $get_all ) {
$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 ) ) {
2010-04-13 08:43:40 -04:00
if ( $details == - 1 ) {
2010-02-13 18:09:54 -05:00
return false ;
2010-04-13 08:43:40 -04:00
} else {
2010-02-13 18:09:54 -05:00
// Clear old pre-serialized objects. Cache clients do better with that.
2010-04-13 08:43:40 -04:00
wp_cache_delete ( $blog_id , 'blog-details' );
unset ( $details );
}
} else {
return $details ;
2010-02-13 18:09:54 -05:00
}
}
}
2010-04-13 08:43:40 -04:00
if ( empty ( $details ) ) {
2016-01-25 16:51:26 -05:00
$details = WP_Site :: get_instance ( $blog_id );
2010-02-13 18:09:54 -05:00
if ( ! $details ) {
// Set the full cache.
wp_cache_set ( $blog_id , - 1 , 'blog-details' );
return false ;
}
2010-02-13 17:35:11 -05:00
}
2016-01-25 16:51:26 -05:00
if ( ! $details instanceof WP_Site ) {
$details = new WP_Site ( $details );
}
2010-02-13 17:35:11 -05:00
if ( ! $get_all ) {
wp_cache_set ( $blog_id . $all , $details , 'blog-details' );
return $details ;
}
2012-08-03 13:51:42 -04:00
switch_to_blog ( $blog_id );
2015-10-29 22:02:24 -04:00
$details -> blogname = get_option ( 'blogname' );
$details -> siteurl = get_option ( 'siteurl' );
$details -> post_count = get_option ( 'post_count' );
$details -> home = get_option ( 'home' );
2012-08-03 13:51:42 -04:00
restore_current_blog ();
2010-02-13 17:35:11 -05:00
2013-12-01 12:32:10 -05:00
/**
2016-05-22 14:50:28 -04:00
* Filters a blog ' s details .
2013-12-01 12:32:10 -05:00
*
* @ since MU
*
* @ param object $details The blog details .
*/
2010-02-13 17:35:11 -05:00
$details = apply_filters ( 'blog_details' , $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 ;
}
/**
* Clear the blog details cache .
*
2010-09-30 21:32:31 -04:00
* @ since MU
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 ();
}
2010-02-13 17:35:11 -05:00
$details = get_blog_details ( $blog_id , false );
2013-03-19 01:05:19 -04:00
if ( ! $details ) {
// Make sure clean_blog_cache() gets the blog ID
// when the blog has been previously cached as
// non-existent.
$details = ( object ) array (
'blog_id' => $blog_id ,
'domain' => null ,
'path' => null
);
}
2010-02-13 17:35:11 -05:00
2012-10-01 14:03:23 -04:00
clean_blog_cache ( $details );
2012-02-09 14:53:53 -05:00
2013-12-01 12:32:10 -05:00
/**
* Fires after the blog details cache is cleared .
*
* @ since 3.4 . 0
*
* @ param int $blog_id Blog ID .
*/
2012-02-09 14:53:53 -05:00
do_action ( 'refresh_blog_details' , $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 .
*
2010-09-30 21:32:31 -04:00
* @ since MU
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 ;
if ( empty ( $details ) )
return false ;
if ( is_object ( $details ) )
$details = get_object_vars ( $details );
$current_details = get_blog_details ( $blog_id , false );
if ( empty ( $current_details ) )
return false ;
$current_details = get_object_vars ( $current_details );
$details = array_merge ( $current_details , $details );
$details [ 'last_updated' ] = current_time ( 'mysql' , true );
$update_details = array ();
$fields = array ( 'site_id' , 'domain' , 'path' , 'registered' , 'last_updated' , 'public' , 'archived' , 'mature' , 'spam' , 'deleted' , 'lang_id' );
2015-01-11 20:43:22 -05:00
foreach ( array_intersect ( array_keys ( $details ), $fields ) as $field ) {
if ( 'path' === $field ) {
2015-01-11 23:21:22 -05:00
$details [ $field ] = trailingslashit ( '/' . trim ( $details [ $field ], '/' ) );
2015-01-11 20:43:22 -05:00
}
$update_details [ $field ] = $details [ $field ];
}
2010-02-13 17:35:11 -05:00
2012-10-11 08:37:46 -04:00
$result = $wpdb -> update ( $wpdb -> blogs , $update_details , array ( 'blog_id' => $blog_id ) );
if ( false === $result )
return false ;
2010-02-13 17:35:11 -05:00
// If spam status changed, issue actions.
2013-12-01 12:32:10 -05:00
if ( $details [ 'spam' ] != $current_details [ 'spam' ] ) {
if ( $details [ 'spam' ] == 1 ) {
/**
* Fires when the blog status is changed to 'spam' .
*
* @ since MU
*
* @ param int $blog_id Blog ID .
*/
2012-10-11 08:37:46 -04:00
do_action ( 'make_spam_blog' , $blog_id );
2013-12-01 12:32:10 -05:00
} else {
/**
* Fires when the blog status is changed to 'ham' .
*
* @ since MU
*
* @ param int $blog_id Blog ID .
*/
2012-10-11 08:37:46 -04:00
do_action ( 'make_ham_blog' , $blog_id );
2013-12-01 12:32:10 -05:00
}
2012-10-11 08:37:46 -04:00
}
// If mature status changed, issue actions.
2013-12-01 12:32:10 -05:00
if ( $details [ 'mature' ] != $current_details [ 'mature' ] ) {
if ( $details [ 'mature' ] == 1 ) {
/**
* Fires when the blog status is changed to 'mature' .
*
* @ since 3.1 . 0
*
* @ param int $blog_id Blog ID .
*/
2012-10-11 08:37:46 -04:00
do_action ( 'mature_blog' , $blog_id );
2013-12-01 12:32:10 -05:00
} else {
/**
* Fires when the blog status is changed to 'unmature' .
*
* @ since 3.1 . 0
*
* @ param int $blog_id Blog ID .
*/
2012-10-11 08:37:46 -04:00
do_action ( 'unmature_blog' , $blog_id );
2013-12-01 12:32:10 -05:00
}
2012-10-11 08:37:46 -04:00
}
// If archived status changed, issue actions.
2013-12-01 12:32:10 -05:00
if ( $details [ 'archived' ] != $current_details [ 'archived' ] ) {
if ( $details [ 'archived' ] == 1 ) {
/**
* Fires when the blog status is changed to 'archived' .
*
* @ since MU
*
* @ param int $blog_id Blog ID .
*/
2012-10-11 08:37:46 -04:00
do_action ( 'archive_blog' , $blog_id );
2013-12-01 12:32:10 -05:00
} else {
/**
* Fires when the blog status is changed to 'unarchived' .
*
* @ since MU
*
* @ param int $blog_id Blog ID .
*/
2012-10-11 08:37:46 -04:00
do_action ( 'unarchive_blog' , $blog_id );
2013-12-01 12:32:10 -05:00
}
2010-02-13 17:35:11 -05:00
}
2012-10-11 08:37:46 -04:00
// If deleted status changed, issue actions.
2013-12-01 12:32:10 -05:00
if ( $details [ 'deleted' ] != $current_details [ 'deleted' ] ) {
if ( $details [ 'deleted' ] == 1 ) {
/**
* Fires when the blog status is changed to 'deleted' .
*
* @ since 3.5 . 0
*
* @ param int $blog_id Blog ID .
*/
2012-10-11 08:37:46 -04:00
do_action ( 'make_delete_blog' , $blog_id );
2013-12-01 12:32:10 -05:00
} else {
/**
* Fires when the blog status is changed to 'undeleted' .
*
* @ since 3.5 . 0
*
* @ param int $blog_id Blog ID .
*/
2012-10-11 08:37:46 -04:00
do_action ( 'make_undelete_blog' , $blog_id );
2013-12-01 12:32:10 -05:00
}
2012-11-17 10:11:29 -05:00
}
2013-12-01 12:32:10 -05:00
if ( isset ( $details [ 'public' ] ) ) {
2012-08-03 13:51:42 -04:00
switch_to_blog ( $blog_id );
2013-12-01 12:32:10 -05:00
update_option ( 'blog_public' , $details [ 'public' ] );
2012-08-03 13:51:42 -04:00
restore_current_blog ();
}
2010-02-13 17:35:11 -05:00
refresh_blog_details ( $blog_id );
return true ;
}
2012-10-01 14:03:23 -04:00
/**
* Clean the blog cache
*
* @ since 3.5 . 0
*
2016-03-09 02:42:26 -05:00
* @ param WP_Site $blog The blog details as returned from get_blog_details ()
2012-10-01 14:03:23 -04:00
*/
function clean_blog_cache ( $blog ) {
$blog_id = $blog -> blog_id ;
$domain_path_key = md5 ( $blog -> domain . $blog -> path );
2016-01-25 16:51:26 -05:00
wp_cache_delete ( $blog_id , 'sites' );
2012-10-01 14:03:23 -04:00
wp_cache_delete ( $blog_id , 'blog-details' );
wp_cache_delete ( $blog_id . 'short' , 'blog-details' );
wp_cache_delete ( $domain_path_key , 'blog-lookup' );
wp_cache_delete ( 'current_blog_' . $blog -> domain , 'site-options' );
wp_cache_delete ( 'current_blog_' . $blog -> domain . $blog -> path , 'site-options' );
wp_cache_delete ( 'get_id_from_blogname_' . trim ( $blog -> path , '/' ), 'blog-details' );
wp_cache_delete ( $domain_path_key , 'blog-id-cache' );
2016-04-14 00:19:27 -04:00
/**
* Fires immediately after a site has been removed from the object cache .
*
* @ since 4.6 . 0
*
* @ param int $id Blog ID .
* @ param WP_Site $blog
* @ param string $domain_path_key md5 hash of domain and path .
*/
do_action ( 'clean_site_cache' , $blog_id , $blog , $domain_path_key );
2012-10-01 14:03:23 -04:00
}
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
*
* @ global WP_Site $current_blog The current site .
*
* @ param WP_Site | int $site Site to retrieve .
* @ param string $output Optional . Type of output to return . OBJECT or ARRAY_A or ARRAY_N constants .
* @ return WP_Site | array | null Depends on $output value .
*/
function get_site ( & $site = null , $output = OBJECT ) {
global $current_blog ;
if ( empty ( $site ) && isset ( $current_blog ) ) {
$site = $current_blog ;
}
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
*
* @ param mixed $_site Site data .
*/
$_site = apply_filters ( 'get_site' , $_site );
if ( $output == OBJECT ) {
return $_site ;
} elseif ( $output == ARRAY_A ) {
return $_site -> to_array ();
} elseif ( $output == ARRAY_N ) {
return array_values ( $_site -> to_array () );
}
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
* @ access private
*
* @ see update_site_cache ()
*
* @ global wpdb $wpdb WordPress database abstraction object .
*
* @ param array $ids ID list .
*/
function _prime_site_caches ( $ids ) {
global $wpdb ;
$non_cached_ids = _get_non_cached_ids ( $ids , 'sites' );
if ( ! empty ( $non_cached_ids ) ) {
$fresh_sites = $wpdb -> get_results ( sprintf ( " SELECT * FROM $wpdb->blogs WHERE blog_id IN (%s) " , join ( " , " , array_map ( 'intval' , $non_cached_ids ) ) ) );
update_site_cache ( $fresh_sites );
}
}
/**
* Updates sites in cache .
*
* @ since 4.6 . 0
*
* @ param array $sites Array of site objects , passed by reference .
*/
function update_site_cache ( & $sites ) {
if ( ! $sites ) {
return ;
}
foreach ( $sites as $site ) {
wp_cache_add ( $site -> blog_id , $site , 'sites' );
wp_cache_add ( $site -> blog_id . 'short' , $site , 'blog-details' );
}
}
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 .
*
* @ since MU
*
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 ;
if ( empty ( $id ) )
$id = get_current_blog_id ();
if ( get_current_blog_id () == $id )
return get_option ( $option , $default );
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 .
*
* @ since MU
*
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 ;
if ( empty ( $id ) )
$id = get_current_blog_id ();
if ( get_current_blog_id () == $id )
return add_option ( $option , $value );
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 .
*
* @ since MU
*
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 ;
if ( empty ( $id ) )
$id = get_current_blog_id ();
if ( get_current_blog_id () == $id )
return delete_option ( $option );
switch_to_blog ( $id );
$return = delete_option ( $option );
restore_current_blog ();
return $return ;
}
/**
* Update an option for a particular blog .
*
* @ since MU
*
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 ;
if ( null !== $deprecated )
_deprecated_argument ( __FUNCTION__ , '3.1' );
if ( get_current_blog_id () == $id )
return update_option ( $option , $value );
switch_to_blog ( $id );
$return = update_option ( $option , $value );
restore_current_blog ();
refresh_blog_details ( $id );
return $return ;
}
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 :
* - autoloaded options . See #14992
* - plugins . See #14941
*
* @ see restore_current_blog ()
* @ since MU
*
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 ) {
2015-05-26 17:51:31 -04:00
global $wpdb ;
2010-02-13 17:35:11 -05:00
2012-08-09 12:28:15 -04:00
if ( empty ( $new_blog ) )
$new_blog = $GLOBALS [ 'blog_id' ];
2010-02-13 17:35:11 -05:00
2012-08-09 12:28:15 -04:00
$GLOBALS [ '_wp_switched_stack' ][] = $GLOBALS [ '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
*/
2012-08-09 12:28:15 -04:00
if ( $new_blog == $GLOBALS [ 'blog_id' ] ) {
2013-12-01 12:32:10 -05:00
/**
* Fires when the blog is switched .
*
* @ since MU
*
* @ 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 ();
2012-08-09 12:28:15 -04:00
$prev_blog_id = $GLOBALS [ '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 ;
2012-08-02 14:31:14 -04:00
if ( is_object ( $wp_object_cache ) && isset ( $wp_object_cache -> global_groups ) )
$global_groups = $wp_object_cache -> global_groups ;
2010-02-13 17:35:11 -05:00
else
2012-08-02 14:31:14 -04:00
$global_groups = false ;
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 {
2016-01-25 16:51:26 -05:00
wp_cache_add_global_groups ( array ( 'users' , 'userlogins' , 'usermeta' , 'user_meta' , 'useremail' , 'userslugs' , 'site-transient' , 'site-options' , 'site-lookup' , 'blog-lookup' , 'blog-details' , 'rss' , 'global-posts' , 'blog-id-cache' , 'networks' , 'sites' ) );
2015-02-05 22:24:23 -05:00
}
2012-08-09 12:28:15 -04:00
wp_cache_add_non_persistent_groups ( array ( 'comment' , 'counts' , 'plugins' ) );
2012-08-02 14:31:14 -04:00
}
2010-02-13 17:35:11 -05:00
}
2012-10-01 10:25:31 -04:00
if ( did_action ( 'init' ) ) {
2015-05-26 17:51:31 -04:00
wp_roles () -> reinit ();
2012-10-01 10:25:31 -04:00
$current_user = wp_get_current_user ();
$current_user -> for_blog ( $new_blog );
}
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 ()
* @ since MU
*
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 () {
2015-05-26 17:51:31 -04:00
global $wpdb ;
2010-02-13 17:35:11 -05:00
2012-09-26 13:02:44 -04:00
if ( empty ( $GLOBALS [ '_wp_switched_stack' ] ) )
2010-02-13 17:35:11 -05:00
return false ;
2012-08-09 12:28:15 -04:00
$blog = array_pop ( $GLOBALS [ '_wp_switched_stack' ] );
2010-02-13 17:35:11 -05:00
2012-08-09 12:28:15 -04:00
if ( $GLOBALS [ '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 );
$prev_blog_id = $GLOBALS [ '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 ;
2012-08-02 14:31:14 -04:00
if ( is_object ( $wp_object_cache ) && isset ( $wp_object_cache -> global_groups ) )
$global_groups = $wp_object_cache -> global_groups ;
2010-02-13 17:35:11 -05:00
else
2012-08-02 14:31:14 -04:00
$global_groups = false ;
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 {
2016-01-27 08:51:26 -05:00
wp_cache_add_global_groups ( array ( 'users' , 'userlogins' , 'usermeta' , 'user_meta' , 'useremail' , 'userslugs' , 'site-transient' , 'site-options' , 'site-lookup' , 'blog-lookup' , 'blog-details' , 'rss' , 'global-posts' , 'blog-id-cache' , 'networks' , 'sites' ) );
2015-02-05 22:24:23 -05:00
}
2012-08-09 12:28:15 -04:00
wp_cache_add_non_persistent_groups ( array ( 'comment' , 'counts' , 'plugins' ) );
2012-08-02 14:31:14 -04:00
}
2010-02-13 17:35:11 -05:00
}
2012-10-01 10:25:31 -04:00
if ( did_action ( 'init' ) ) {
2015-05-26 17:51:31 -04:00
wp_roles () -> reinit ();
2012-10-01 10:25:31 -04:00
$current_user = wp_get_current_user ();
$current_user -> for_blog ( $blog );
}
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 ;
}
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 .
*
* @ since MU
*
* @ 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 ) {
return get_blog_status ( $id , 'archived' );
}
2010-09-30 21:32:31 -04:00
/**
* Update the 'archived' status of a particular blog .
*
* @ since MU
*
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 ) {
update_blog_status ( $id , 'archived' , $archived );
return $archived ;
}
/**
* Update a blog details field .
*
2010-09-30 21:32:31 -04:00
* @ since MU
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 ;
2010-12-01 17:12:09 -05:00
if ( null !== $deprecated )
2010-12-15 06:27:38 -05:00
_deprecated_argument ( __FUNCTION__ , '3.1' );
2010-12-01 17:12:09 -05:00
2012-10-11 08:37:46 -04: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 ;
2012-10-11 08:37:46 -04:00
$result = $wpdb -> update ( $wpdb -> blogs , array ( $pref => $value , 'last_updated' => current_time ( 'mysql' , true )), array ( 'blog_id' => $blog_id ) );
2010-02-13 17:35:11 -05:00
2012-10-11 08:37:46 -04:00
if ( false === $result )
return false ;
refresh_blog_details ( $blog_id );
2010-02-13 17:35:11 -05:00
2013-12-01 12:32:10 -05:00
if ( 'spam' == $pref ) {
if ( $value == 1 ) {
/** This filter is documented in wp-includes/ms-blogs.php */
do_action ( 'make_spam_blog' , $blog_id );
} else {
/** This filter is documented in wp-includes/ms-blogs.php */
do_action ( 'make_ham_blog' , $blog_id );
}
} elseif ( 'mature' == $pref ) {
if ( $value == 1 ) {
/** This filter is documented in wp-includes/ms-blogs.php */
do_action ( 'mature_blog' , $blog_id );
} else {
/** This filter is documented in wp-includes/ms-blogs.php */
do_action ( 'unmature_blog' , $blog_id );
}
} elseif ( 'archived' == $pref ) {
if ( $value == 1 ) {
/** This filter is documented in wp-includes/ms-blogs.php */
do_action ( 'archive_blog' , $blog_id );
} else {
/** This filter is documented in wp-includes/ms-blogs.php */
do_action ( 'unarchive_blog' , $blog_id );
}
} elseif ( 'deleted' == $pref ) {
if ( $value == 1 ) {
/** This filter is documented in wp-includes/ms-blogs.php */
do_action ( 'make_delete_blog' , $blog_id );
} else {
/** This filter is documented in wp-includes/ms-blogs.php */
do_action ( 'make_undelete_blog' , $blog_id );
}
} elseif ( 'public' == $pref ) {
/**
* Fires after the current blog 's ' public ' setting is updated .
*
* @ since MU
*
* @ param int $blog_id Blog ID .
* @ param string $value The value of blog status .
*/
2013-03-25 05:29:58 -04:00
do_action ( 'update_blog_public' , $blog_id , $value ); // Moved here from update_blog_public().
2013-12-01 12:32:10 -05:00
}
2010-02-13 17:35:11 -05:00
return $value ;
}
2010-09-30 21:32:31 -04:00
/**
* Get a blog details field .
*
* @ since MU
*
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 ;
$details = get_blog_details ( $id , false );
if ( $details )
return $details -> $pref ;
return $wpdb -> get_var ( $wpdb -> prepare ( " SELECT %s FROM { $wpdb -> blogs } WHERE blog_id = %d " , $pref , $id ) );
}
2010-09-30 21:32:31 -04:00
/**
* Get a list of most recently updated blogs .
*
* @ since MU
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
2010-11-18 14:12:48 -05:00
if ( ! empty ( $deprecated ) )
_deprecated_argument ( __FUNCTION__ , 'MU' ); // never used
2010-12-13 16:21:50 -05:00
2010-02-13 17:35:11 -05: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 " , $wpdb -> siteid , $start , $quantity ) , ARRAY_A );
}
2011-11-03 13:06:45 -04:00
/**
* Handler for updating the blog date when a post is published or an already published post is changed .
*
* @ 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
/**
* Handler for updating the blog date when a published post is deleted .
*
* @ 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
/**
* Handler for updating the blog posts count date when a post is deleted .
*
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 );
if ( ! $post || 'publish' !== $post -> post_status ) {
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 ();
}
/**
* Handler for updating the blog posts count date when a post status changes .
*
2014-07-28 20:59:16 -04:00
* @ since 4.0 . 0
2014-06-25 20:53:15 -04:00
*
* @ param string $new_status The status the post is changing to .
* @ param string $old_status The status the post is changing from .
*/
function _update_posts_count_on_transition_post_status ( $new_status , $old_status ) {
if ( $new_status === $old_status ) {
return ;
}
if ( 'publish' !== $new_status && 'publish' !== $old_status ) {
return ;
}
update_posts_count ();
}