Changeset 35024 for trunk/src/wp-includes/option.php

Timestamp:

10/11/2015 10:43:59 PM (10 years ago)

Author:

jeremyfelt

Message:

MS: Adjust _network_option() parameter order, $network_id is first.

This better aligns with expectations and matches the structure used by _blog_option(). The _site_option() functions remain as an appropriate method for working with the current network.

See #28290.

File:

• trunk/src/wp-includes/option.php (modified) (11 diffs)

trunk/src/wp-includes/option.php

@@ -1000 +1000 @@
  */
 function get_site_option( $option, $default = false, $deprecated = true ) {
-    return get_network_option( $option, $default );
+    return get_network_option( null, $option, $default );
 }
 
@@ -1018 +1018 @@
  */
 function add_site_option( $option, $value ) {
-    return add_network_option( $option, $value );
+    return add_network_option( null, $option, $value );
 }
 
@@ -1033 +1033 @@
  */
 function delete_site_option( $option ) {
-    return delete_network_option( $option );
+    return delete_network_option( null, $option );
 }
 
@@ -1049 +1049 @@
  */
 function update_site_option( $option, $value ) {
-    return update_network_option( $option, $value );
+    return update_network_option( null, $option, $value );
 }
 
@@ -1062 +1062 @@
  * @global object $current_site
  *
+ * @param int      $network_id ID of the network. Can be null to default to the current network ID.
  * @param string   $option     Name of option to retrieve. Expected to not be SQL-escaped.
  * @param mixed    $default    Optional. Value to return if the option doesn't exist. Default false.
- * @param int|bool $network_id Optional. ID of the network. Defaults to current network ID.
  * @return mixed Value set for the option.
  */
-function get_network_option( $option, $default = false, $network_id = false ) {
+function get_network_option( $network_id, $option, $default = false ) {
     global $wpdb, $current_site;
 
@@ -1175 +1175 @@
  * @global object $current_site
  *
- * @param  string   $option     Name of option to add. Expected to not be SQL-escaped.
- * @param  mixed    $value      Option value, can be anything. Expected to not be SQL-escaped.
- * @param  int|bool $network_id Optional. ID of the network. Defaults to current network ID.
+ * @param int    $network_id ID of the network. Can be null to default to the current network ID.
+ * @param string $option     Name of option to add. Expected to not be SQL-escaped.
+ * @param mixed  $value      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_network_option( $option, $value, $network_id = false ) {
+function add_network_option( $network_id, $option, $value ) {
     global $wpdb, $current_site;
 
@@ -1216 +1216 @@
         $notoptions = wp_cache_get( $notoptions_key, 'site-options' );
         if ( ! is_array( $notoptions ) || ! isset( $notoptions[ $option ] ) ) {
-            if ( false !== get_network_option( $option, false, $network_id ) ) {
+            if ( false !== get_network_option( $network_id, $option, false ) ) {
                 return false;
             }
@@ -1281 +1281 @@
  * @global object $current_site
  *
- * @param  string   $option     Name of option to remove. Expected to not be SQL-escaped.
- * @param  int|bool $network_id Optional. ID of the network. Defaults to current network ID.
+ * @param int    $network_id ID of the network. Can be null to default to the current network ID.
+ * @param string $option     Name of option to remove. Expected to not be SQL-escaped.
  * @return bool True, if succeed. False, if failure.
  */
-function delete_network_option( $option, $network_id = false ) {
+function delete_network_option( $network_id, $option ) {
     global $wpdb, $current_site;
 
@@ -1359 +1359 @@
  * @global object $current_site
  *
+ * @param int      $network_id ID of the network. Can be null to default to the current network ID.
  * @param string   $option     Name of option. Expected to not be SQL-escaped.
  * @param mixed    $value      Option value. Expected to not be SQL-escaped.
- * @param int|bool $network_id Optional. ID of the network. Defaults to current network ID.
  * @return bool False if value was not updated and true if value was updated.
  */
-function update_network_option( $option, $value, $network_id = false ) {
+function update_network_option( $network_id, $option, $value ) {
     global $wpdb, $current_site;
 
@@ -1376 +1376 @@
     wp_protect_special_option( $option );
 
-    $old_value = get_network_option( $option, false, $network_id );
+    $old_value = get_network_option( $network_id, $option, false );
 
     /**
@@ -1398 +1398 @@
 
     if ( false === $old_value ) {
-        return add_network_option( $option, $value, $network_id );
+        return add_network_option( $network_id, $option, $value );
     }