Changeset 12806

Timestamp:

01/22/2010 11:35:59 PM (15 years ago)

Author:

ryan

Message:

Introduce update_blog_details(). Add some phpdoc. Fix some warnings. see #11644

Location:

trunk

Files:

• wp-admin/ms-edit.php (modified) (3 diffs)
• wp-includes/ms-functions.php (modified) (10 diffs)

trunk/wp-admin/ms-edit.php

@@ -184 +184 @@
 
         // themes
-        if ( is_array( $_POST[ 'theme' ] ) )
+        if ( isset($_POST[ 'theme' ]) && is_array( $_POST[ 'theme' ] ) )
             $_POST[ 'option' ][ 'allowedthemes' ] = $_POST[ 'theme' ];
         else
@@ -216 +216 @@
         // update blogs table
         $blog_data = stripslashes_deep($_POST[ 'blog' ]);
-        $result = $wpdb->update( $wpdb->blogs, $blog_data, array('blog_id' => $id) );
-
-        update_blog_status( $id, 'spam', $_POST[ 'blog' ][ 'spam' ] );
-        update_option( 'blog_public', $_POST[ 'blog' ][ 'public' ] );
+        update_blog_details($id, $blog_data);
 
         // get blog prefix
@@ -238 +235 @@
 
         // remove user
-        if ( is_array( $_POST[ 'blogusers' ] ) ) {
+        if ( isset($_POST[ 'blogusers' ]) && is_array( $_POST[ 'blogusers' ] ) ) {
             reset( $_POST[ 'blogusers' ] );
             foreach ( (array) $_POST[ 'blogusers' ] as $key => $val )

trunk/wp-includes/ms-functions.php

@@ -18 +18 @@
 }
 
+// @todo use update_blog_details
 function wpmu_update_blogs_date() {
     global $wpdb;
@@ -93 +94 @@
 }
 
+// @todo Use get_user_by() and deprecate.
 function get_user_details( $username ) {
     global $wpdb;
@@ -123 +125 @@
 }
 
-function get_blog_details( $id, $getall = true ) {
-    global $wpdb;
-
-    if ( !is_numeric( $id ) )
-        $id = get_id_from_blogname( $id );
-
-    $id = (int) $id;
-
-    $all = $getall == true ? '' : 'short';
-    $details = wp_cache_get( $id . $all, 'blog-details' );
+/**
+ * Retrieve the details for a blog from the blogs table and blog options.
+ *
+ * @since 3.0
+ * @param int $blog_id Blog ID
+ * @param bool $get_all Whether to retrieve all details or only the details in the blogs table. Default is true.
+ * @return object Blog details.
+ */
+function get_blog_details( $blog_id, $get_all = true ) {
+    global $wpdb;
+
+    if ( !is_numeric( $blog_id ) )
+        $blog_id = get_id_from_blogname( $blog_id );
+
+    $blog_id = (int) $blog_id;
+
+    $all = $get_all == true ? '' : 'short';
+    $details = wp_cache_get( $blog_id . $all, 'blog-details' );
 
     if ( $details ) {
@@ -138 +148 @@
             return false;
         elseif ( !is_object($details) ) // Clear old pre-serialized objects. Cache clients do better with that.
-            wp_cache_delete( $id . $all, 'blog-details' );
+            wp_cache_delete( $blog_id . $all, 'blog-details' );
         else
             return $details;
     }
 
-    $details = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->blogs WHERE blog_id = %d /* get_blog_details */", $id) );
+    $details = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->blogs WHERE blog_id = %d /* get_blog_details */", $blog_id) );
     if ( !$details ) {
-        wp_cache_set( $id . $all, -1, 'blog-details' );
+        wp_cache_set( $blog_id . $all, -1, 'blog-details' );
         return false;
     }
 
-    if ( !$getall ) {
-        wp_cache_set( $id . $all, $details, 'blog-details' );
+    if ( !$get_all ) {
+        wp_cache_set( $blog_id . $all, $details, 'blog-details' );
         return $details;
     }
 
     $wpdb->suppress_errors();
-    switch_to_blog( $id );
+    switch_to_blog( $blog_id );
     $details->blogname      = get_option( 'blogname' );
     $details->siteurl       = get_option( 'siteurl' );
@@ -164 +174 @@
     $details = apply_filters('blog_details', $details);
 
-    wp_cache_set( $id . $all, $details, 'blog-details' );
+    wp_cache_set( $blog_id . $all, $details, 'blog-details' );
 
     $key = md5( $details->domain . $details->path );
@@ -172 +182 @@
 }
 
-function refresh_blog_details( $id ) {
-    $id = (int) $id;
-    $details = get_blog_details( $id, false );
-
-    wp_cache_delete( $id , 'blog-details' );
-    wp_cache_delete( $id . 'short' , 'blog-details' );
+/**
+ * Clear the blog details cache.
+ *
+ * @since 3.0
+ *
+ * @param int $blog_id Blog ID
+ */
+function refresh_blog_details( $blog_id ) {
+    $blog_id = (int) $blog_id;
+    $details = get_blog_details( $blog_id, false );
+
+    wp_cache_delete( $blog_id , 'blog-details' );
+    wp_cache_delete( $blog_id . 'short' , 'blog-details' );
     wp_cache_delete( md5( $details->domain . $details->path )  , 'blog-lookup' );
     wp_cache_delete( 'current_blog_' . $details->domain, 'site-options' );
@@ -183 +200 @@
 }
 
+/**
+ * Update the details for a blog. Updates the blogs table for a given blog id.
+ *
+ * @since 3.0
+ *
+ * @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;
+
+    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');
+    foreach ( array_intersect( array_keys( $details ), $fields ) as $field )
+        $update_details[$field] = $details[$field];
+
+    $result = $wpdb->update( $wpdb->blogs, $update_details, array('blog_id' => $blog_id) );
+
+    // If spam status changed, issue actions.
+    if ( $details[ 'spam' ] != $current_details[ 'spam' ] ) {
+        if ( $details[ 'spam' ] == 1 )
+            do_action( "make_spam_blog", $blog_id );
+        else
+            do_action( "make_ham_blog", $blog_id );
+    }
+
+    if ( isset($details[ 'public' ]) )
+        update_blog_option( $blog_id, 'blog_public', $details[ 'public' ], false );
+
+    refresh_blog_details($blog_id);
+
+    return true;
+}
+
+// @todo move to user.php
 function get_current_user_id() {
     global $current_user;
@@ -508 +576 @@
 }
 
-function update_blog_status( $id, $pref, $value, $refresh = 1 ) {
+/**
+ * Update a blog details field.
+ *
+ * @since 3.0
+ *
+ * @param int $blog_id BLog ID
+ * @param string $pref A field name
+ * @param string $value Value for $pref
+ * @param bool $refresh Whether to refresh the blog details cache. Default is true.
+ */
+function update_blog_status( $blog_id, $pref, $value, $refresh = true ) {
     global $wpdb;
 
@@ -514 +592 @@
         return $value;
 
-    $wpdb->update( $wpdb->blogs, array($pref => $value, 'last_updated' => current_time('mysql', true)), array('blog_id' => $id) );
-    if ( $refresh == 1 )
+    $wpdb->update( $wpdb->blogs, array($pref => $value, 'last_updated' => current_time('mysql', true)), array('blog_id' => $blog_id) );
+
+    if ( $refresh )
         refresh_blog_details($id);
 
@@ -535 +614 @@
         return $details->$pref;
 
-    return $wpdb->get_var( $wpdb->prepare("SELECT $pref FROM {$wpdb->blogs} WHERE blog_id = %d", $id) );
+    return $wpdb->get_var( $wpdb->prepare("SELECT %s FROM {$wpdb->blogs} WHERE blog_id = %d", $pref, $id) );
 }