update_blog_status

Update a blog details field.

Description

(string|false) update_blog_status( (int) $blog_id, (string) $pref, (string) $value, (null) $deprecated = null ); 

Returns (string|false)

$value

Parameters (4)

0. $blog_id (int)
The blog id.
1. $pref (string)
A field name
2. $value (string)
Value for $pref
3. $deprecated — Optional. (null) => null
The deprecated.

Usage

  1. if ( !function_exists( 'update_blog_status' ) ) { 
  2.     require_once ABSPATH . WPINC . '/ms-blogs.php'; 
  3. } 
  4.   
  5. // The blog id. 
  6. $blog_id = -1; 
  7.   
  8. // A field name 
  9. $pref = ''; 
  10.   
  11. // Value for $pref 
  12. $value = ''; 
  13.   
  14. // The deprecated. 
  15. $deprecated = null; 
  16.   
  17. // NOTICE! Understand what this does before running. 
  18. $result = update_blog_status($blog_id, $pref, $value, $deprecated); 
  19.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/ms-blogs.php  
  1. function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) { 
  2.     global $wpdb; 
  3.  
  4.     if ( null !== $deprecated ) 
  5.         _deprecated_argument( __FUNCTION__, '3.1.0' ); 
  6.  
  7.     if ( ! in_array( $pref, array( 'site_id', 'domain', 'path', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id') ) ) 
  8.         return $value; 
  9.  
  10.     $result = $wpdb->update( $wpdb->blogs, array($pref => $value, 'last_updated' => current_time('mysql', true)), array('blog_id' => $blog_id) ); 
  11.  
  12.     if ( false === $result ) 
  13.         return false; 
  14.  
  15.     refresh_blog_details( $blog_id ); 
  16.  
  17.     if ( 'spam' == $pref ) { 
  18.         if ( $value == 1 ) { 
  19.             /** This filter is documented in wp-includes/ms-blogs.php */ 
  20.             do_action( 'make_spam_blog', $blog_id ); 
  21.         } else { 
  22.             /** This filter is documented in wp-includes/ms-blogs.php */ 
  23.             do_action( 'make_ham_blog', $blog_id ); 
  24.         } 
  25.     } elseif ( 'mature' == $pref ) { 
  26.         if ( $value == 1 ) { 
  27.             /** This filter is documented in wp-includes/ms-blogs.php */ 
  28.             do_action( 'mature_blog', $blog_id ); 
  29.         } else { 
  30.             /** This filter is documented in wp-includes/ms-blogs.php */ 
  31.             do_action( 'unmature_blog', $blog_id ); 
  32.         } 
  33.     } elseif ( 'archived' == $pref ) { 
  34.         if ( $value == 1 ) { 
  35.             /** This filter is documented in wp-includes/ms-blogs.php */ 
  36.             do_action( 'archive_blog', $blog_id ); 
  37.         } else { 
  38.             /** This filter is documented in wp-includes/ms-blogs.php */ 
  39.             do_action( 'unarchive_blog', $blog_id ); 
  40.         } 
  41.     } elseif ( 'deleted' == $pref ) { 
  42.         if ( $value == 1 ) { 
  43.             /** This filter is documented in wp-includes/ms-blogs.php */ 
  44.             do_action( 'make_delete_blog', $blog_id ); 
  45.         } else { 
  46.             /** This filter is documented in wp-includes/ms-blogs.php */ 
  48.         } 
  49.     } elseif ( 'public' == $pref ) { 
  50.         /** 
  51.          * Fires after the current blog's 'public' setting is updated. 
  52.          * 
  53.          * @since MU 
  54.          * 
  55.          * @param int    $blog_id Blog ID. 
  56.          * @param string $value   The value of blog status. 
  57.           */ 
  58.         do_action( 'update_blog_public', $blog_id, $value ); // Moved here from update_blog_public(). 
  59.     } 
  60.  
  61.     return $value; 
  62. }