Changeset 13148

Timestamp:

02/14/2010 10:39:46 AM (17 years ago)

Author:

nacin

Message:

Add hooks across options and transients APIs. Focuses on site transients/options functions. Attempts to standardize where possible. See #10788

File:

• trunk/wp-includes/functions.php (modified) (17 diffs)

trunk/wp-includes/functions.php

@@ -346 +346 @@
                                 $wpdb->suppress_errors( $suppress );
 
-                        if ( is_object( $row) ) { // Has to be get_row instead of get_var because of funkiness with 0, false, null values
+                        // Has to be get_row instead of get_var because of funkiness with 0, false, null values
+                        if ( is_object( $row ) ) {
                                 $value = $row->option_value;
                                 wp_cache_add( $option, $value, 'options' );
@@ -480 +481 @@
  * @uses apply_filters() Calls 'pre_update_option_$option' hook to allow overwriting the
  *      option value to be stored.
+ * @uses do_action() Calls 'update_option' hook before updating the option.
  * @uses do_action() Calls 'update_option_$option' and 'updated_option' hooks on success.
  *
@@ -512 +514 @@
         $newvalue = maybe_serialize( $newvalue );
 
-        do_action( 'update_option', $option, $oldvalue, $newvalue );
+        do_action( 'update_option', $option, $oldvalue, $newvalue ); // $newvalue may be serialized.
         if ( ! defined( 'WP_INSTALLING' ) ) {
                 $alloptions = wp_load_alloptions();
@@ -551 +553 @@
  * @link http://alex.vort-x.net/blog/ Thanks Alex Stapleton
  *
+ * @uses do_action() Calls 'add_option' hook before adding the option.
  * @uses do_action() Calls 'add_option_$option' and 'added_option' hooks on success.
  *
@@ -609 +612 @@
  *
  * @package WordPress
- * @subpackage Option
+ * @subpackage Option 
  * @since 1.2.0
  *
  * @uses do_action() Calls 'delete_option' hook before option is deleted.
- * @uses do_action() Calls 'deleted_option' hook on success.
+ * @uses do_action() Calls 'deleted_option' and 'delete_option_$option' hooks on success.
  *
  * @param string $option Name of option to remove.
- * @return bool True, if succeed. False, if failure.
+ * @return bool True, if option is successfully deleted. False on failure.
  */
 function delete_option( $option ) {
@@ -643 +646 @@
         }
         if ( $result ) {
+                do_action( "delete_option_$option", $option );
                 do_action( 'deleted_option', $option );
                 return true;
@@ -656 +660 @@
  * @subpackage Transient
  *
+ * @uses do_action() Calls 'delete_transient_$transient' hook before transient is deleted.
+ * @uses do_action() Calls 'deleted_transient' hook on success.
+ *
  * @param string $transient Transient name. Expected to not be SQL-escaped
  * @return bool true if successful, false otherwise
@@ -662 +669 @@
         global $_wp_using_ext_object_cache;
 
-    do_action( 'delete_transient_' . $transient );
+    do_action( 'delete_transient_' . $transient, $transient );
 
         if ( $_wp_using_ext_object_cache ) {
-                return wp_cache_delete( $transient, 'transient' );
+                $result = wp_cache_delete( $transient, 'transient' );
         } else {
-                $transient = '_transient_' . esc_sql( $transient );
-                return delete_option( $transient );
-        }
+                $option = '_transient_' . esc_sql( $transient );
+                $result = delete_option( $option );
+        }
+
+        if ( $result )
+                do_action( 'deleted_transient', $transient );
+        return $result;
 }
 
@@ -734 +745 @@
  * @uses apply_filters() Calls 'pre_set_transient_$transient' hook to allow overwriting the
  *      transient value to be stored.
+ * @uses do_action() Calls 'set_transient_$transient' and 'setted_transient' hooks on success.
  *
  * @param string $transient Transient name. Expected to not be SQL-escaped
@@ -746 +758 @@
 
         if ( $_wp_using_ext_object_cache ) {
-                return wp_cache_set( $transient, $value, 'transient', $expiration );
+                $result = wp_cache_set( $transient, $value, 'transient', $expiration );
         } else {
                 $transient_timeout = '_transient_timeout_' . $transient;
@@ -755 +767 @@
                         if ( $expiration ) {
                                 $autoload = 'no';
-                                add_option($transient_timeout, time() + $expiration, '', 'no');
+                                add_option( $transient_timeout, time() + $expiration, '', 'no' );
                         }
-                        return add_option($transient, $value, '', $autoload);
+                        $result = add_option( $transient, $value, '', $autoload );
                 } else {
                         if ( $expiration )
                                 update_option( $transient_timeout, time() + $expiration );
-                        return update_option($transient, $value);
+                        $result = update_option( $transient, $value );
                 }
         }
+        if ( $result ) {
+                do_action( 'set_transient_' . $transient );
+                do_action( 'setted_transient', $transient );
+        }
+        return $result;
 }
 
@@ -3467 +3484 @@
         }
 
-        do_action( "delete_site_option_{$option}", $option );
-        do_action( "delete_site_option", $option );
-        return $result;
+        if ( $result ) {
+                do_action( "delete_site_option_{$option}", $option );
+                do_action( "delete_site_option", $option );
+                return true;
+        }
+        return false;
 }
 
@@ -3526 +3546 @@
  * @subpackage Transient
  *
+ * @uses do_action() Calls 'delete_site_transient_$transient' hook before transient is deleted.
+ * @uses do_action() Calls 'deleted_site_transient' hook on success.
+ *
  * @param string $transient Transient name. Expected to not be SQL-escaped
  * @return bool True if successful, false otherwise
@@ -3532 +3555 @@
         global $_wp_using_ext_object_cache;
 
+        do_action( 'delete_site_transient_' . $transient, $transient );
         if ( $_wp_using_ext_object_cache ) {
                 $result = wp_cache_delete( $transient, 'site-transient' );
         } else {
-                $transient = '_site_transient_' . esc_sql( $transient );
-                $result = delete_site_option( $transient );
-        }
+                $option = '_site_transient_' . esc_sql( $transient );
+                $result = delete_site_option( $option );
+        }
+        if ( $result )
+                do_action( 'deleted_site_transient', $transient );
         return $result;
 }
@@ -3601 +3627 @@
  * @subpackage Transient
  *
+ * @uses apply_filters() Calls 'pre_set_site_transient_$transient' hook to allow overwriting the
+ *      transient value to be stored.
+ * @uses do_action() Calls 'set_site_transient_$transient' and 'setted_site_transient' hooks on success.
+ *
  * @param string $transient Transient name. Expected to not be SQL-escaped
  * @param mixed $value Transient value.
@@ -3608 +3638 @@
 function set_site_transient( $transient, $value, $expiration = 0 ) {
         global $_wp_using_ext_object_cache;
+
+    $value = apply_filters( 'pre_set_site_transient_' . $transient, $value );
 
         if ( $_wp_using_ext_object_cache ) {
@@ -3624 +3656 @@
                         $result = update_site_option( $transient, $value );
                 }
+        }
+        if ( $result ) {
+                do_action( 'set_site_transient_' . $transient );
+                do_action( 'setted_site_transient', $transient );
         }
         return $result;