Changeset 13667 for trunk/wp-includes/user.php

Timestamp:

03/11/2010 06:28:31 PM (15 years ago)

Author:

nacin

Message:

Add delete_user_option(). fixes #12573, props TobiasBg.

File:

• trunk/wp-includes/user.php (modified) (2 diffs)

trunk/wp-includes/user.php

@@ -269 +269 @@
  * @param string $option_name User option name.
  * @param mixed $newvalue User option value.
- * @param bool $global Optional. Whether option name is blog specific.
+ * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific).
  * @return unknown
  */
@@ -278 +278 @@
         $option_name = $wpdb->prefix . $option_name;
     return update_user_meta( $user_id, $option_name, $newvalue );
+}
+
+/**
+ * Delete user option with global blog capability.
+ *
+ * User options are just like user metadata except that they have support for
+ * global blog options. If the 'global' parameter is false, which it is by default
+ * it will prepend the WordPress table prefix to the option name.
+ *
+ * @since 3.0.0
+ * @uses $wpdb WordPress database object for queries
+ *
+ * @param int $user_id User ID
+ * @param string $option_name User option name.
+ * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific).
+ * @return unknown
+ */
+function delete_user_option( $user_id, $option_name, $global = false ) {
+    global $wpdb;
+
+    if ( !$global )
+        $option_name = $wpdb->prefix . $option_name;
+    return delete_user_meta( $user_id, $option_name );
 }