Changeset 21414 for trunk/wp-includes/ms-deprecated.php

Timestamp:

08/03/2012 05:51:42 PM (12 years ago)

Author:

ryan

Message:

Deprecate get_blog_option(), add_blog_option(), update_blog_option(), and delete_blog_option().

Use the regular option functions wrapped in switch_to_blog() and restore_current_blog() instead.

Group multiple operations within a single switch where possible.

fixes #21432

File:

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

trunk/wp-includes/ms-deprecated.php

@@ -271 +271 @@
     return $url;
 }
+
+/**
+ * Retrieve option value for a given blog id based on name of option.
+ *
+ * If the option does not exist or does not have a value, then the return value
+ * will be false. This is useful to check whether you need to install an option
+ * and is commonly used during installation of plugin options and to test
+ * whether upgrading is required.
+ *
+ * If the option was serialized then it will be unserialized when it is returned.
+ *
+ * @since MU
+ * @deprecated 3.5.0
+ *
+ * @param int $id A blog ID. Can be null to refer to the current blog.
+ * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
+ * @param mixed $default Optional. Default value to return if the option does not exist.
+ * @return mixed Value set for the option.
+ */
+function get_blog_option( $id, $option, $default = false ) {
+    _deprecated_function( __FUNCTION__, '3.5' );
+
+    $id = (int) $id;
+
+    if ( empty( $id ) )
+        $id = get_current_blog_id();
+
+    if ( get_current_blog_id() == $id )
+        return get_option( $option, $default );
+
+    switch_to_blog( $id );
+    $option = get_option( $option, $default );
+    restore_current_blog();
+
+    return $option;
+}
+
+/**
+ * Add a new option for a given blog id.
+ *
+ * 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.
+ *
+ * You can create options without values and then update the values later.
+ * Existing options will not be updated and checks are performed to ensure 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.
+ *
+ * @since MU
+ * @deprecated 3.5.0
+ *
+ * @param int $id A blog ID. Can be null to refer to the current blog.
+ * @param string $option Name of option to add. Expected to not be SQL-escaped.
+ * @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped.
+ * @return bool False if option was not added and true if option was added.
+ */
+function add_blog_option( $id, $option, $value ) {
+    _deprecated_function( __FUNCTION__, '3.5' );
+
+    $id = (int) $id;
+
+    if ( empty( $id ) )
+        $id = get_current_blog_id();
+
+    if ( get_current_blog_id() == $id )
+        return add_option( $option, $value );
+
+    switch_to_blog( $id );
+    $return = add_option( $option, $value );
+    restore_current_blog();
+
+    return $return;
+}
+
+/**
+ * Removes option by name for a given blog id. Prevents removal of protected WordPress options.
+ *
+ * @since MU
+ * @deprecated 3.5.0
+ *
+ * @param int $id A blog ID. Can be null to refer to the current blog.
+ * @param string $option Name of option to remove. Expected to not be SQL-escaped.
+ * @return bool True, if option is successfully deleted. False on failure.
+ */
+function delete_blog_option( $id, $option ) {
+    _deprecated_function( __FUNCTION__, '3.5' );
+
+    $id = (int) $id;
+
+    if ( empty( $id ) )
+        $id = get_current_blog_id();
+
+    if ( get_current_blog_id() == $id )
+        return delete_option( $option );
+
+    switch_to_blog( $id );
+    $return = delete_option( $option );
+    restore_current_blog();
+
+    return $return;
+}
+
+/**
+ * Update an option for a particular blog.
+ *
+ * @since MU
+ * @deprecated 3.5.0
+ *
+ * @param int $id The blog id
+ * @param string $option The option key
+ * @param mixed $value The option value
+ * @return bool True on success, false on failrue.
+ */
+function update_blog_option( $id, $option, $value, $deprecated = null ) {
+    _deprecated_function( __FUNCTION__, '3.5' );
+
+    $id = (int) $id;
+
+    if ( null !== $deprecated  )
+        _deprecated_argument( __FUNCTION__, '3.1' );
+
+    if ( get_current_blog_id() == $id )
+        return update_option( $option, $value );
+
+    switch_to_blog( $id );
+    $return = update_option( $option, $value );
+    restore_current_blog();
+
+    refresh_blog_details( $id );
+
+    return $return;
+}