Changeset 13142 for trunk/wp-includes/functions.php

Timestamp:

02/14/2010 07:21:15 AM (15 years ago)

Author:

nacin

Message:

More cleanups of the options/transients APIs. More inline documentation, better return values (always true on success, false on failure). Only call actions that are after wpdb delete/update operations if the operation was successful. See #10788

File:

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

trunk/wp-includes/functions.php

@@ -290 +290 @@
 
 /**
- * Retrieve option value based on setting name.
+ * Retrieve option value based on name of option.
  *
  * If the option does not exist or does not have a value, then the return value
@@ -297 +297 @@
  * whether upgrading is required.
  *
- * You can "short-circuit" the retrieval of the option from the database for
- * your plugin or core options that aren't protected. You can do so by hooking
- * into the 'pre_option_$option' with the $option being replaced by the option
- * name. You should not try to override special options, but you will not be
- * prevented from doing so.
- *
- * There is a second filter called 'option_$option' with the $option being
- * replaced with the option name. This gives the value as the only parameter.
- *
- * If the option was serialized, when the option was added and, or updated, then
- * it will be unserialized, when it is returned.
+ * If the option was serialized then it will be unserialized when it is returned.
  *
  * @since 1.5.0
  * @package WordPress
  * @subpackage Option
- * @uses apply_filters() Calls 'pre_option_$option' false to allow
- *      overwriting the option value in a plugin.
- * @uses apply_filters() Calls 'option_$option' with the option value.
+ * @uses apply_filters() Calls 'pre_option_$option' before checking the option.
+ *  Any value other than false will "short-circuit" the retrieval of the option
+ *  and return the returned value. You should not try to override special options,
+ *  but you will not be prevented from doing so.
+ * @uses apply_filters() Calls 'option_$option', after checking the option, with
+ *  the option value.
  *
  * @param string $option Name of option to retrieve. Should already be SQL-escaped
@@ -389 +382 @@
     $protected = array( 'alloptions', 'notoptions' );
     if ( in_array( $option, $protected ) )
-        die( sprintf( __( '%s is a protected WP option and may not be modified' ), esc_html( $option ) ) );
+        wp_die( sprintf( __( '%s is a protected WP option and may not be modified' ), esc_html( $option ) ) );
 }
 
@@ -403 +396 @@
  */
 function form_option( $option ) {
-    echo esc_attr(get_option( $option ) );
+    echo esc_attr( get_option( $option ) );
 }
 
@@ -473 +466 @@
  * Update the value of an option that was already added.
  *
- * You do not need to serialize values, if the value needs to be serialize, then
+ * 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.
@@ -479 +472 @@
  * If the option does not exist, then the option will be added with the option
  * value, but you will not be able to set whether it is autoloaded. If you want
- * to set whether an option autoloaded, then you need to use the add_option().
- *
- * Before the option is updated, then the filter named
- * 'pre_update_option_$option', with the $option as the $option
- * parameter value, will be called. The hook should accept two parameters, the
- * first is the new value and the second is the old value.  Whatever is
- * returned will be used as the new value.
- *
- * After the value has been updated the action named 'update_option_$option'
- * will be called.  This action receives two parameters the first being the old
- * value and the second the new value.
+ * to set whether an option is autoloaded, then you need to use the add_option().
  *
  * @since 1.0.0
  * @package WordPress
  * @subpackage Option
+ *
+ * @uses apply_filters() Calls 'pre_update_option_$option' hook to allow overwriting the
+ *  option value to be stored.
+ * @uses do_action() Calls 'update_option_$option' and 'updated_option' hooks on success.
  *
  * @param string $option Option name. Expected to not be SQL-escaped
@@ -504 +491 @@
     wp_protect_special_option( $option );
 
-    $safe_option_name = esc_sql( $option );
+    $safe_option = esc_sql( $option );
     $newvalue = sanitize_option( $option, $newvalue );
-
-    $oldvalue = get_option( $safe_option_name );
-
+    $oldvalue = get_option( $safe_option );
     $newvalue = apply_filters( 'pre_update_option_' . $option, $newvalue, $oldvalue );
 
@@ -551 +536 @@
  * Add a new option.
  *
- * You do not need to serialize values, if the value needs to be serialize, then
+ * 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.
@@ -558 +543 @@
  * check whether the option has already been added, but does check 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 and to not add options
+ * options the same as the ones which are protected and to not add options
  * that were already added.
- *
- * The filter named 'add_option_$option', with the $optionname being
- * replaced with the option's name, will be called. The hook should accept two
- * parameters, the first is the option name, and the second is the value.
  *
  * @package WordPress
@@ -569 +550 @@
  * @since 1.0.0
  * @link http://alex.vort-x.net/blog/ Thanks Alex Stapleton
+ *
+ * @uses do_action() Calls 'add_option_$option' and 'added_option' hooks on success.
  *
  * @param string $option Name of option to add. Expects to NOT be SQL escaped.
@@ -583 +566 @@
 
     wp_protect_special_option( $option );
-    $safe_name = esc_sql( $option );
+    $safe_option = esc_sql( $option );
     $value = sanitize_option( $option, $value );
 
@@ -589 +572 @@
     $notoptions = wp_cache_get( 'notoptions', 'options' );
     if ( !is_array( $notoptions ) || !isset( $notoptions[$option] ) )
-        if ( false !== get_option( $safe_name ) )
+        if ( false !== get_option( $safe_option ) )
             return;
 
@@ -614 +597 @@
     $result = $wpdb->query( $wpdb->prepare( "INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s) ON DUPLICATE KEY UPDATE `option_name` = VALUES(`option_name`), `option_value` = VALUES(`option_value`), `autoload` = VALUES(`autoload`)", $option, $value, $autoload ) );
 
-    do_action( "add_option_{$option}", $option, $value );
-    do_action( 'added_option', $option, $value );
-
-    return $result;
+    if ( $result ) {
+        do_action( "add_option_{$option}", $option, $value );
+        do_action( 'added_option', $option, $value );
+        return true;
+    }
+    return false;
 }
 
@@ -626 +611 @@
  * @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.
  *
  * @param string $option Name of option to remove.
@@ -654 +642 @@
         }
     }
-    do_action( 'deleted_option', $option );
-    return true;
+    if ( $result ) {
+        do_action( 'deleted_option', $option );
+        return true;
+    }
+    return false;
 }
 
@@ -686 +677 @@
  * If the transient does not exist or does not have a value, then the return value
  * will be false.
+ *
+ * @uses apply_filters() Calls 'pre_transient_$transient' hook before checking the transient.
+ *  Any value other than false will "short-circuit" the retrieval of the transient
+ *  and return the returned value.
+ * @uses apply_filters() Calls 'transient_$option' hook, after checking the transient, with
+ *  the transient value.
  *
  * @since 2.8.0
@@ -734 +731 @@
  * @package WordPress
  * @subpackage Transient
+ *
+ * @uses apply_filters() Calls 'pre_set_transient_$transient' hook to allow overwriting the
+ *  transient value to be stored.
  *
  * @param string $transient Transient name. Expected to not be SQL-escaped
@@ -3349 +3349 @@
  * @since 2.8.0
  *
+ * @uses apply_filters() Calls 'pre_site_option_$option' before checking the option.
+ *  Any value other than false will "short-circuit" the retrieval of the option
+ *  and return the returned value.
+ * @uses apply_filters() Calls 'site_option_$option', after checking the  option, with
+ *  the option value.
+ *
  * @param string $option Name of option to retrieve. Should already be SQL-escaped
  * @param mixed $default Optional value to return if option doesn't exist. Default false.
@@ -3392 +3398 @@
  * @since 2.8.0
  *
+ * @uses apply_filters() Calls 'pre_add_site_option_$option' hook to allow overwriting the
+ *  option value to be stored.
+ * @uses do_action() Calls 'add_site_option_$option' and 'add_site_option' hooks on success.
+ *
  * @param string $option Name of option to add. Expects to not be SQL escaped.
  * @param mixed $value Optional. Option value, can be anything.
@@ -3430 +3440 @@
  * @subpackage Option
  * @since 2.8.0
+ *
+ * @uses do_action() Calls 'pre_delete_site_option_$option' hook before option is deleted.
+ * @uses do_action() Calls 'delete_site_option' and 'delete_site_option_$option'
+ *  hooks on success.
  *
  * @param string $option Name of option to remove. Expected to be SQL-escaped.
@@ -3466 +3480 @@
  * @subpackage Option
  *
+ * @uses apply_filters() Calls 'pre_update_site_option_$option' hook to allow overwriting the
+ *  option value to be stored.
+ * @uses do_action() Calls 'update_site_option_$option' and 'update_site_option' hooks on success.
+ *
  * @param string $option Name of option. Expected to not be SQL-escaped
  * @param mixed $value Option value.
@@ -3493 +3511 @@
     }
 
-    do_action( "update_site_option_{$option}", $option, $value );
-    do_action( "update_site_option", $option, $value );
-    return $result;
+    if ( $result ) {
+        do_action( "update_site_option_{$option}", $option, $value );
+        do_action( "update_site_option", $option, $value );
+        return true;
+    }
+    return false;
 }
 
@@ -3530 +3551 @@
  * @package WordPress
  * @subpackage Transient
+ *
+ * @uses apply_filters() Calls 'pre_site_transient_$transient' hook before checking the transient.
+ *  Any value other than false will "short-circuit" the retrieval of the transient
+ *  and return the returned value.
+ * @uses apply_filters() Calls 'site_transient_$option' hook, after checking the transient, with
+ *  the transient value.
  *
  * @param string $transient Transient name. Expected to not be SQL-escaped