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

Timestamp:

05/06/2009 08:33:59 PM (16 years ago)

Author:

westi

Message:

Update phpDoc for update_option. See #8805 props rmccue.

File:

• trunk/wp-includes/functions.php (modified) (1 diff)

trunk/wp-includes/functions.php

@@ -472 +472 @@
  * to set whether an option autoloaded, then you need to use the add_option().
  *
- * When the option is updated, then the filter named
- * 'update_option_$option_name', with the $option_name as the $option_name
+ * Before the option is updated, then the filter named
+ * 'pre_update_option_$option_name', with the $option_name as the $option_name
  * parameter value, will be called. The hook should accept two parameters, the
- * first is the old parameter and the second is the new parameter.
+ * 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_name'
+ * will be called.  This action receives two parameters the first being the old
+ * value and the second the new value.
  *
  * @since 1.0.0