2019-03-12 09:27:46 +00:00
< ? php
/**
* Site / blog functions that work with the blogs table and related data .
*
* @ package WordPress
* @ subpackage Multisite
* @ since MU ( 3.0 . 0 )
*/
2019-04-16 19:56:22 +00:00
require_once ( ABSPATH . WPINC . '/ms-site.php' );
require_once ( ABSPATH . WPINC . '/ms-network.php' );
2019-03-12 09:27:46 +00:00
/**
* Update the last_updated field for the current site .
*
* @ since MU ( 3.0 . 0 )
*/
function wpmu_update_blogs_date () {
$site_id = get_current_blog_id ();
update_blog_details ( $site_id , array ( 'last_updated' => current_time ( 'mysql' , true ) ) );
/**
* Fires after the blog details are updated .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $blog_id Site ID .
*/
do_action ( 'wpmu_blog_updated' , $site_id );
}
/**
* Get a full blog URL , given a blog id .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $blog_id Blog ID
* @ return string Full URL of the blog if found . Empty string if not .
*/
function get_blogaddress_by_id ( $blog_id ) {
$bloginfo = get_site ( ( 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 );
}
/**
* Get a full blog URL , given a blog name .
*
* @ since MU ( 3.0 . 0 )
*
* @ param string $blogname The ( subdomain or directory ) name
* @ return string
*/
function get_blogaddress_by_name ( $blogname ) {
if ( is_subdomain_install () ) {
2019-04-16 19:56:22 +00:00
if ( 'main' === $blogname ) {
2019-03-12 09:27:46 +00:00
$blogname = 'www' ;
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
$url = rtrim ( network_home_url (), '/' );
2019-04-16 19:56:22 +00:00
if ( ! empty ( $blogname ) ) {
$url = preg_replace ( '|^([^\.]+://)|' , '${1}' . $blogname . '.' , $url );
}
2019-03-12 09:27:46 +00:00
} else {
$url = network_home_url ( $blogname );
}
return esc_url ( $url . '/' );
}
/**
* Retrieves a sites ID given its ( subdomain or directory ) slug .
*
* @ since MU ( 3.0 . 0 )
2019-04-16 19:56:22 +00:00
* @ since 4.7 . 0 Converted to use `get_sites()` .
2019-03-12 09:27:46 +00: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 .
*/
function get_id_from_blogname ( $slug ) {
$current_network = get_network ();
2019-04-16 19:56:22 +00:00
$slug = trim ( $slug , '/' );
2019-03-12 09:27:46 +00:00
if ( is_subdomain_install () ) {
$domain = $slug . '.' . preg_replace ( '|^www\.|' , '' , $current_network -> domain );
2019-04-16 19:56:22 +00:00
$path = $current_network -> path ;
2019-03-12 09:27:46 +00:00
} else {
$domain = $current_network -> domain ;
2019-04-16 19:56:22 +00:00
$path = $current_network -> path . $slug . '/' ;
2019-03-12 09:27:46 +00:00
}
2019-04-16 19:56:22 +00:00
$site_ids = get_sites (
array (
'number' => 1 ,
'fields' => 'ids' ,
'domain' => $domain ,
'path' => $path ,
)
);
2019-03-12 09:27:46 +00:00
if ( empty ( $site_ids ) ) {
return null ;
}
return array_shift ( $site_ids );
}
/**
* Retrieve the details for a blog from the blogs table and blog options .
*
* @ since MU ( 3.0 . 0 )
*
* @ global wpdb $wpdb WordPress database abstraction object .
*
* @ param int | string | array $fields Optional . A blog ID , a blog slug , or an array of fields to query against .
* If not specified the current blog ID is used .
* @ param bool $get_all Whether to retrieve all details or only the details in the blogs table .
* Default is true .
* @ return WP_Site | false Blog details on success . False on failure .
*/
function get_blog_details ( $fields = null , $get_all = true ) {
global $wpdb ;
2019-04-16 19:56:22 +00:00
if ( is_array ( $fields ) ) {
if ( isset ( $fields [ 'blog_id' ] ) ) {
2019-03-12 09:27:46 +00:00
$blog_id = $fields [ 'blog_id' ];
2019-04-16 19:56:22 +00:00
} elseif ( isset ( $fields [ 'domain' ] ) && isset ( $fields [ 'path' ] ) ) {
$key = md5 ( $fields [ 'domain' ] . $fields [ 'path' ] );
$blog = wp_cache_get ( $key , 'blog-lookup' );
if ( false !== $blog ) {
2019-03-12 09:27:46 +00:00
return $blog ;
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
if ( substr ( $fields [ 'domain' ], 0 , 4 ) == 'www.' ) {
$nowww = substr ( $fields [ 'domain' ], 4 );
2019-04-16 19:56:22 +00: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' ] ) );
2019-03-12 09:27:46 +00:00
} else {
$blog = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT * FROM $wpdb->blogs WHERE domain = %s AND path = %s " , $fields [ 'domain' ], $fields [ 'path' ] ) );
}
if ( $blog ) {
2019-04-16 19:56:22 +00:00
wp_cache_set ( $blog -> blog_id . 'short' , $blog , 'blog-details' );
2019-03-12 09:27:46 +00:00
$blog_id = $blog -> blog_id ;
} else {
return false ;
}
2019-04-16 19:56:22 +00:00
} elseif ( isset ( $fields [ 'domain' ] ) && is_subdomain_install () ) {
$key = md5 ( $fields [ 'domain' ] );
$blog = wp_cache_get ( $key , 'blog-lookup' );
if ( false !== $blog ) {
2019-03-12 09:27:46 +00:00
return $blog ;
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
if ( substr ( $fields [ 'domain' ], 0 , 4 ) == 'www.' ) {
$nowww = substr ( $fields [ 'domain' ], 4 );
2019-04-16 19:56:22 +00: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' ] ) );
2019-03-12 09:27:46 +00:00
} else {
$blog = $wpdb -> get_row ( $wpdb -> prepare ( " SELECT * FROM $wpdb->blogs WHERE domain = %s " , $fields [ 'domain' ] ) );
}
if ( $blog ) {
2019-04-16 19:56:22 +00:00
wp_cache_set ( $blog -> blog_id . 'short' , $blog , 'blog-details' );
2019-03-12 09:27:46 +00:00
$blog_id = $blog -> blog_id ;
} else {
return false ;
}
} else {
return false ;
}
} else {
2019-04-16 19:56:22 +00:00
if ( ! $fields ) {
2019-03-12 09:27:46 +00:00
$blog_id = get_current_blog_id ();
2019-04-16 19:56:22 +00:00
} elseif ( ! is_numeric ( $fields ) ) {
2019-03-12 09:27:46 +00:00
$blog_id = get_id_from_blogname ( $fields );
2019-04-16 19:56:22 +00:00
} else {
2019-03-12 09:27:46 +00:00
$blog_id = $fields ;
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
}
$blog_id = ( int ) $blog_id ;
2019-04-16 19:56:22 +00:00
$all = $get_all ? '' : 'short' ;
2019-03-12 09:27:46 +00:00
$details = wp_cache_get ( $blog_id . $all , 'blog-details' );
if ( $details ) {
if ( ! is_object ( $details ) ) {
2019-04-16 19:56:22 +00:00
if ( - 1 == $details ) {
2019-03-12 09:27:46 +00:00
return false ;
} else {
// Clear old pre-serialized objects. Cache clients do better with that.
wp_cache_delete ( $blog_id . $all , 'blog-details' );
2019-04-16 19:56:22 +00:00
unset ( $details );
2019-03-12 09:27:46 +00:00
}
} else {
return $details ;
}
}
// 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 ) ) {
2019-04-16 19:56:22 +00:00
if ( - 1 == $details ) {
2019-03-12 09:27:46 +00:00
return false ;
} else {
// Clear old pre-serialized objects. Cache clients do better with that.
wp_cache_delete ( $blog_id , 'blog-details' );
2019-04-16 19:56:22 +00:00
unset ( $details );
2019-03-12 09:27:46 +00:00
}
} else {
return $details ;
}
}
}
2019-04-16 19:56:22 +00:00
if ( empty ( $details ) ) {
2019-03-12 09:27:46 +00: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 ;
}
/**
* Clear the blog details cache .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $blog_id Optional . Blog ID . Defaults to current blog .
*/
function refresh_blog_details ( $blog_id = 0 ) {
$blog_id = ( int ) $blog_id ;
if ( ! $blog_id ) {
$blog_id = get_current_blog_id ();
}
clean_blog_cache ( $blog_id );
}
/**
* Update the details for a blog . Updates the blogs table for a given blog id .
*
* @ since MU ( 3.0 . 0 )
*
* @ global wpdb $wpdb WordPress database abstraction object .
*
* @ param int $blog_id Blog ID
* @ param array $details Array of details keyed by blogs table field names .
* @ return bool True if update succeeds , false otherwise .
*/
function update_blog_details ( $blog_id , $details = array () ) {
global $wpdb ;
2019-04-16 19:56:22 +00:00
if ( empty ( $details ) ) {
2019-03-12 09:27:46 +00:00
return false ;
}
2019-04-16 19:56:22 +00:00
if ( is_object ( $details ) ) {
$details = get_object_vars ( $details );
2019-03-12 09:27:46 +00:00
}
2019-04-16 19:56:22 +00:00
$site = wp_update_site ( $blog_id , $details );
2019-03-12 09:27:46 +00:00
2019-04-16 19:56:22 +00:00
if ( is_wp_error ( $site ) ) {
return false ;
2019-03-12 09:27:46 +00:00
}
return true ;
}
/**
* 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 .
*/
function clean_site_details_cache ( $site_id = 0 ) {
$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' );
}
/**
* 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 ( 3.0 . 0 )
*
* @ param int $id A blog ID . Can be null to refer to the current blog .
* @ param string $option Name of option to retrieve . Expected to not be SQL - escaped .
* @ param mixed $default Optional . Default value to return if the option does not exist .
* @ return mixed Value set for the option .
*/
function get_blog_option ( $id , $option , $default = false ) {
$id = ( int ) $id ;
2019-04-16 19:56:22 +00:00
if ( empty ( $id ) ) {
2019-03-12 09:27:46 +00:00
$id = get_current_blog_id ();
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
2019-04-16 19:56:22 +00:00
if ( get_current_blog_id () == $id ) {
2019-03-12 09:27:46 +00:00
return get_option ( $option , $default );
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
switch_to_blog ( $id );
$value = get_option ( $option , $default );
restore_current_blog ();
/**
* Filters a blog option value .
*
* The dynamic portion of the hook name , `$option` , refers to the blog option name .
*
* @ since 3.5 . 0
*
* @ param string $value The option value .
* @ param int $id Blog ID .
*/
return apply_filters ( " blog_option_ { $option } " , $value , $id );
}
/**
* 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 ( 3.0 . 0 )
*
* @ param int $id A blog ID . Can be null to refer to the current blog .
* @ param string $option Name of option to add . Expected to not be SQL - escaped .
* @ param mixed $value Optional . Option value , can be anything . Expected to not be SQL - escaped .
* @ return bool False if option was not added and true if option was added .
*/
function add_blog_option ( $id , $option , $value ) {
$id = ( int ) $id ;
2019-04-16 19:56:22 +00:00
if ( empty ( $id ) ) {
2019-03-12 09:27:46 +00:00
$id = get_current_blog_id ();
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
2019-04-16 19:56:22 +00:00
if ( get_current_blog_id () == $id ) {
2019-03-12 09:27:46 +00:00
return add_option ( $option , $value );
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00: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 .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $id A blog ID . Can be null to refer to the current blog .
* @ param string $option Name of option to remove . Expected to not be SQL - escaped .
* @ return bool True , if option is successfully deleted . False on failure .
*/
function delete_blog_option ( $id , $option ) {
$id = ( int ) $id ;
2019-04-16 19:56:22 +00:00
if ( empty ( $id ) ) {
2019-03-12 09:27:46 +00:00
$id = get_current_blog_id ();
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
2019-04-16 19:56:22 +00:00
if ( get_current_blog_id () == $id ) {
2019-03-12 09:27:46 +00:00
return delete_option ( $option );
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
switch_to_blog ( $id );
$return = delete_option ( $option );
restore_current_blog ();
return $return ;
}
/**
* Update an option for a particular blog .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $id The blog id .
* @ param string $option The option key .
* @ param mixed $value The option value .
* @ param mixed $deprecated Not used .
* @ return bool True on success , false on failure .
*/
function update_blog_option ( $id , $option , $value , $deprecated = null ) {
$id = ( int ) $id ;
2019-04-16 19:56:22 +00:00
if ( null !== $deprecated ) {
2019-03-12 09:27:46 +00:00
_deprecated_argument ( __FUNCTION__ , '3.1.0' );
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
2019-04-16 19:56:22 +00:00
if ( get_current_blog_id () == $id ) {
2019-03-12 09:27:46 +00:00
return update_option ( $option , $value );
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
switch_to_blog ( $id );
$return = update_option ( $option , $value );
restore_current_blog ();
return $return ;
}
/**
* 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 ()
* @ since MU ( 3.0 . 0 )
*
* @ global wpdb $wpdb
* @ global int $blog_id
* @ global array $_wp_switched_stack
* @ global bool $switched
* @ global string $table_prefix
* @ global WP_Object_Cache $wp_object_cache
*
* @ param int $new_blog The id of the blog you want to switch to . Default : current blog
* @ param bool $deprecated Deprecated argument
* @ return true Always returns True .
*/
function switch_to_blog ( $new_blog , $deprecated = null ) {
global $wpdb ;
$blog_id = get_current_blog_id ();
if ( empty ( $new_blog ) ) {
$new_blog = $blog_id ;
}
$GLOBALS [ '_wp_switched_stack' ][] = $blog_id ;
/*
* 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
*/
if ( $new_blog == $blog_id ) {
/**
* Fires when the blog is switched .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $new_blog New blog ID .
* @ param int $new_blog Blog ID .
*/
do_action ( 'switch_blog' , $new_blog , $new_blog );
$GLOBALS [ 'switched' ] = true ;
return true ;
}
$wpdb -> set_blog_id ( $new_blog );
$GLOBALS [ 'table_prefix' ] = $wpdb -> get_blog_prefix ();
2019-04-16 19:56:22 +00:00
$prev_blog_id = $blog_id ;
$GLOBALS [ 'blog_id' ] = $new_blog ;
2019-03-12 09:27:46 +00:00
if ( function_exists ( 'wp_cache_switch_to_blog' ) ) {
wp_cache_switch_to_blog ( $new_blog );
} else {
global $wp_object_cache ;
if ( is_object ( $wp_object_cache ) && isset ( $wp_object_cache -> global_groups ) ) {
$global_groups = $wp_object_cache -> global_groups ;
} else {
$global_groups = false ;
}
wp_cache_init ();
if ( function_exists ( 'wp_cache_add_global_groups' ) ) {
if ( is_array ( $global_groups ) ) {
wp_cache_add_global_groups ( $global_groups );
} else {
2019-04-16 19:56:22 +00: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' ) );
2019-03-12 09:27:46 +00:00
}
wp_cache_add_non_persistent_groups ( array ( 'counts' , 'plugins' ) );
}
}
/** This filter is documented in wp-includes/ms-blogs.php */
do_action ( 'switch_blog' , $new_blog , $prev_blog_id );
$GLOBALS [ 'switched' ] = true ;
return true ;
}
/**
* Restore the current blog , after calling switch_to_blog ()
*
* @ see switch_to_blog ()
* @ since MU ( 3.0 . 0 )
*
* @ global wpdb $wpdb
* @ global array $_wp_switched_stack
* @ global int $blog_id
* @ global bool $switched
* @ global string $table_prefix
* @ global WP_Object_Cache $wp_object_cache
*
* @ return bool True on success , false if we ' re already on the current blog
*/
function restore_current_blog () {
global $wpdb ;
if ( empty ( $GLOBALS [ '_wp_switched_stack' ] ) ) {
return false ;
}
2019-04-16 19:56:22 +00:00
$blog = array_pop ( $GLOBALS [ '_wp_switched_stack' ] );
2019-03-12 09:27:46 +00:00
$blog_id = get_current_blog_id ();
if ( $blog_id == $blog ) {
/** This filter is documented in wp-includes/ms-blogs.php */
do_action ( 'switch_blog' , $blog , $blog );
// If we still have items in the switched stack, consider ourselves still 'switched'
$GLOBALS [ 'switched' ] = ! empty ( $GLOBALS [ '_wp_switched_stack' ] );
return true ;
}
$wpdb -> set_blog_id ( $blog );
2019-04-16 19:56:22 +00:00
$prev_blog_id = $blog_id ;
$GLOBALS [ 'blog_id' ] = $blog ;
2019-03-12 09:27:46 +00:00
$GLOBALS [ 'table_prefix' ] = $wpdb -> get_blog_prefix ();
if ( function_exists ( 'wp_cache_switch_to_blog' ) ) {
wp_cache_switch_to_blog ( $blog );
} else {
global $wp_object_cache ;
if ( is_object ( $wp_object_cache ) && isset ( $wp_object_cache -> global_groups ) ) {
$global_groups = $wp_object_cache -> global_groups ;
} else {
$global_groups = false ;
}
wp_cache_init ();
if ( function_exists ( 'wp_cache_add_global_groups' ) ) {
if ( is_array ( $global_groups ) ) {
wp_cache_add_global_groups ( $global_groups );
} else {
2019-04-16 19:56:22 +00: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' ) );
2019-03-12 09:27:46 +00:00
}
wp_cache_add_non_persistent_groups ( array ( 'counts' , 'plugins' ) );
}
}
/** This filter is documented in wp-includes/ms-blogs.php */
do_action ( 'switch_blog' , $blog , $prev_blog_id );
// If we still have items in the switched stack, consider ourselves still 'switched'
$GLOBALS [ 'switched' ] = ! empty ( $GLOBALS [ '_wp_switched_stack' ] );
return true ;
}
/**
* 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 );
}
/**
* Determines if switch_to_blog () is in effect
*
* @ since 3.5 . 0
*
* @ global array $_wp_switched_stack
*
* @ return bool True if switched , false otherwise .
*/
function ms_is_switched () {
return ! empty ( $GLOBALS [ '_wp_switched_stack' ] );
}
/**
* Check if a particular blog is archived .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $id The blog id
* @ return string Whether the blog is archived or not
*/
function is_archived ( $id ) {
2019-04-16 19:56:22 +00:00
return get_blog_status ( $id , 'archived' );
2019-03-12 09:27:46 +00:00
}
/**
* Update the 'archived' status of a particular blog .
*
* @ since MU ( 3.0 . 0 )
*
* @ param int $id The blog id
* @ param string $archived The new status
* @ return string $archived
*/
function update_archived ( $id , $archived ) {
2019-04-16 19:56:22 +00:00
update_blog_status ( $id , 'archived' , $archived );
2019-03-12 09:27:46 +00:00
return $archived ;
}
/**
* Update a blog details field .
*
* @ since MU ( 3.0 . 0 )
2019-04-16 19:56:22 +00:00
* @ since 5.1 . 0 Use wp_update_site () internally .
2019-03-12 09:27:46 +00:00
*
* @ global wpdb $wpdb WordPress database abstraction object .
*
* @ param int $blog_id BLog ID
* @ param string $pref A field name
* @ param string $value Value for $pref
* @ param null $deprecated
* @ return string | false $value
*/
function update_blog_status ( $blog_id , $pref , $value , $deprecated = null ) {
global $wpdb ;
2019-04-16 19:56:22 +00:00
if ( null !== $deprecated ) {
2019-03-12 09:27:46 +00:00
_deprecated_argument ( __FUNCTION__ , '3.1.0' );
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
2019-04-16 19:56:22 +00:00
if ( ! in_array ( $pref , array ( 'site_id' , 'domain' , 'path' , 'registered' , 'last_updated' , 'public' , 'archived' , 'mature' , 'spam' , 'deleted' , 'lang_id' ) ) ) {
2019-03-12 09:27:46 +00:00
return $value ;
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
2019-04-16 19:56:22 +00:00
$result = wp_update_site (
$blog_id ,
array (
$pref => $value ,
)
);
2019-03-12 09:27:46 +00:00
2019-04-16 19:56:22 +00:00
if ( is_wp_error ( $result ) ) {
2019-03-12 09:27:46 +00:00
return false ;
}
return $value ;
}
/**
* Get a blog details field .
*
* @ since MU ( 3.0 . 0 )
*
* @ global wpdb $wpdb WordPress database abstraction object .
*
* @ param int $id The blog id
* @ param string $pref A field name
* @ return bool | string | null $value
*/
function get_blog_status ( $id , $pref ) {
global $wpdb ;
$details = get_site ( $id );
2019-04-16 19:56:22 +00:00
if ( $details ) {
2019-03-12 09:27:46 +00:00
return $details -> $pref ;
2019-04-16 19:56:22 +00:00
}
2019-03-12 09:27:46 +00:00
2019-04-16 19:56:22 +00:00
return $wpdb -> get_var ( $wpdb -> prepare ( " SELECT %s FROM { $wpdb -> blogs } WHERE blog_id = %d " , $pref , $id ) );
2019-03-12 09:27:46 +00:00
}
/**
* Get a list of most recently updated blogs .
*
* @ since MU ( 3.0 . 0 )
*
* @ global wpdb $wpdb WordPress database abstraction object .
*
* @ param mixed $deprecated Not used
* @ param int $start The offset
* @ param int $quantity The maximum number of blogs to retrieve . Default is 40.
* @ return array The list of blogs
*/
function get_last_updated ( $deprecated = '' , $start = 0 , $quantity = 40 ) {
global $wpdb ;
2019-04-16 19:56:22 +00:00
if ( ! empty ( $deprecated ) ) {
2019-03-12 09:27:46 +00:00
_deprecated_argument ( __FUNCTION__ , 'MU' ); // never used
}
2019-04-16 19:56:22 +00: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 );
2019-03-12 09:27:46 +00:00
}
/**
* Handler for updating the site ' s last updated 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
* @ param object $post Post object
*/
function _update_blog_date_on_post_publish ( $new_status , $old_status , $post ) {
$post_type_obj = get_post_type_object ( $post -> post_type );
if ( ! $post_type_obj || ! $post_type_obj -> public ) {
return ;
}
if ( 'publish' != $new_status && 'publish' != $old_status ) {
return ;
}
// Post was freshly published, published post was saved, or published post was unpublished.
wpmu_update_blogs_date ();
}
/**
* Handler for updating the current site ' s last updated 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 );
if ( ! $post_type_obj || ! $post_type_obj -> public ) {
return ;
}
if ( 'publish' != $post -> post_status ) {
return ;
}
wpmu_update_blogs_date ();
}
/**
* Handler for updating the current site ' s posts count when a post is deleted .
*
* @ since 4.0 . 0
*
* @ param int $post_id Post ID .
*/
function _update_posts_count_on_delete ( $post_id ) {
$post = get_post ( $post_id );
if ( ! $post || 'publish' !== $post -> post_status || 'post' !== $post -> post_type ) {
return ;
}
update_posts_count ();
}
/**
* Handler for updating the current site ' s posts count when a post status changes .
*
* @ since 4.0 . 0
* @ since 4.9 . 0 Added the `$post` parameter .
*
* @ 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
*/
function _update_posts_count_on_transition_post_status ( $new_status , $old_status , $post = null ) {
if ( $new_status === $old_status ) {
return ;
}
if ( 'post' !== get_post_type ( $post ) ) {
return ;
}
if ( 'publish' !== $new_status && 'publish' !== $old_status ) {
return ;
}
update_posts_count ();
}