WordPress.org

Make WordPress Core

Ticket #28290: 28290.diff

File 28290.diff, 18.7 KB (added by jeremyfelt, 4 years ago)
  • src/wp-includes/option.php

     
    972972}
    973973
    974974/**
    975  * Retrieve site option value based on name of option.
     975 * Retrieve a network option value based on name of option.
    976976 *
    977977 * @since 2.8.0
     978 * @since 4.4.0 Modified into wrapper for get_network_option()
     979 *
     980 * @see get_network_option()
     981 *
     982 * @param string $option     Name of option to retrieve. Expected to not be SQL-escaped.
     983 * @param mixed  $default    Optional value to return if option doesn't exist. Default false.
     984 * @param bool   $deprecated Whether to use cache. Multisite only. Always set to true.
     985 * @return mixed Value set for the option.
     986 */
     987function get_site_option( $option, $default = false, $deprecated = true ) {
     988        return get_network_option( $option, $default );
     989}
     990
     991/**
     992 * Add a new network option.
     993 *
     994 * Existing options will not be updated. Note that prior to 3.3 this wasn't the case.
     995 *
     996 * @since 2.8.0
     997 * @since 4.4.0 Modified into wrapper for add_network_option()
     998 *
     999 * @see add_network_option()
     1000 *
     1001 * @param string $option Name of option to add. Expected to not be SQL-escaped.
     1002 * @param mixed  $value  Option value, can be anything. Expected to not be SQL-escaped.
     1003 * @return bool False if the option was not added. True if the option was added.
     1004 */
     1005function add_site_option( $option, $value ) {
     1006        return add_network_option( $option, $value );
     1007}
     1008
     1009/**
     1010 * Removes a network option by name.
     1011 *
     1012 * @since 2.8.0
     1013 * @since 4.4.0 Modified into wrapper for delete_network_option()
     1014 *
     1015 * @see delete_network_option()
     1016 *
     1017 * @param string $option Name of option to remove. Expected to not be SQL-escaped.
     1018 * @return bool True, if succeed. False, if failure.
     1019 */
     1020function delete_site_option( $option ) {
     1021        return delete_network_option( $option );
     1022}
     1023
     1024/**
     1025 * Update the value of a network option that was already added.
     1026 *
     1027 * @since 2.8.0
     1028 * @since 4.4.0 Modified into wrapper for update_network_option()
     1029 *
     1030 * @see update_network_option()
     1031 *
     1032 * @param string $option Name of option. Expected to not be SQL-escaped.
     1033 * @param mixed  $value  Option value. Expected to not be SQL-escaped.
     1034 * @return bool False if value was not updated. True if value was updated.
     1035 */
     1036function update_site_option( $option, $value ) {
     1037        return update_network_option( $option, $value );
     1038}
     1039
     1040/**
     1041 * Retrieve a network's option value based on name of option.
     1042 *
     1043 * @since 4.4.0
    9781044 *
    9791045 * @see get_option()
    9801046 *
    9811047 * @global wpdb $wpdb
    9821048 *
    983  * @param string $option    Name of option to retrieve. Expected to not be SQL-escaped.
    984  * @param mixed  $default   Optional value to return if option doesn't exist. Default false.
    985  * @param bool   $use_cache Whether to use cache. Multisite only. Default true.
     1049 * @param string   $option     Name of option to retrieve. Expected to not be SQL-escaped.
     1050 * @param mixed    $default    Optional. Value to return if the option doesn't exist. Default false.
     1051 * @param int|bool $network_id Optional. ID of the network. Defaults to current network ID.
    9861052 * @return mixed Value set for the option.
    9871053 */
    988 function get_site_option( $option, $default = false, $use_cache = true ) {
     1054function get_network_option( $option, $default = false, $network_id = false ) {
    9891055        global $wpdb;
    9901056
     1057        $network_id = (int) $network_id;
     1058
     1059        // Fallback to the current network if a network ID is not specified.
     1060        if ( ! $network_id && is_multisite() ) {
     1061                $network_id = get_current_site()->id;
     1062        }
     1063
    9911064        /**
    992          * Filter an existing site option before it is retrieved.
     1065         * Filter an existing network option before it is retrieved.
    9931066         *
    9941067         * The dynamic portion of the hook name, `$option`, refers to the option name.
    9951068         *
     
    10051078         */
    10061079        $pre = apply_filters( 'pre_site_option_' . $option, false, $option );
    10071080
    1008         if ( false !== $pre )
    1009                 return $pre;
     1081        if ( false !== $pre ) {
     1082                return $pre;
     1083        }
    10101084
    10111085        // prevent non-existent options from triggering multiple queries
    1012         $notoptions_key = "{$wpdb->siteid}:notoptions";
     1086        $notoptions_key = "$network_id:notoptions";
    10131087        $notoptions = wp_cache_get( $notoptions_key, 'site-options' );
    10141088
    1015         if ( isset( $notoptions[$option] ) ) {
     1089        if ( isset( $notoptions[ $option ] ) ) {
    10161090
    10171091                /**
    1018                  * Filter a specific default site option.
     1092                 * Filter a specific default network option.
    10191093                 *
    10201094                 * The dynamic portion of the hook name, `$option`, refers to the option name.
    10211095                 *
     
    10301104        }
    10311105
    10321106        if ( ! is_multisite() ) {
    1033 
    10341107                /** This filter is documented in wp-includes/option.php */
    10351108                $default = apply_filters( 'default_site_option_' . $option, $default, $option );
    1036                 $value = get_option($option, $default);
     1109                $value = get_option( $option, $default );
    10371110        } else {
    1038                 $cache_key = "{$wpdb->siteid}:$option";
    1039                 if ( $use_cache )
    1040                         $value = wp_cache_get($cache_key, 'site-options');
     1111                $cache_key = "$network_id:$option";
     1112                $value = wp_cache_get( $cache_key, 'site-options' );
    10411113
    1042                 if ( !isset($value) || (false === $value) ) {
    1043                         $row = $wpdb->get_row( $wpdb->prepare("SELECT meta_value FROM $wpdb->sitemeta WHERE meta_key = %s AND site_id = %d", $option, $wpdb->siteid ) );
     1114                if ( ! isset( $value ) || false === $value ) {
     1115                        $row = $wpdb->get_row( $wpdb->prepare( "SELECT meta_value FROM $wpdb->sitemeta WHERE meta_key = %s AND site_id = %d", $option, $network_id ) );
    10441116
    10451117                        // Has to be get_row instead of get_var because of funkiness with 0, false, null values
    10461118                        if ( is_object( $row ) ) {
     
    10491121                                wp_cache_set( $cache_key, $value, 'site-options' );
    10501122                        } else {
    10511123                                if ( ! is_array( $notoptions ) ) {
    1052                                          $notoptions = array();
     1124                                        $notoptions = array();
    10531125                                }
    1054                                 $notoptions[$option] = true;
     1126                                $notoptions[ $option ] = true;
    10551127                                wp_cache_set( $notoptions_key, $notoptions, 'site-options' );
    10561128
    10571129                                /** This filter is documented in wp-includes/option.php */
     
    10611133        }
    10621134
    10631135        /**
    1064          * Filter the value of an existing site option.
     1136         * Filter the value of an existing network option.
    10651137         *
    10661138         * The dynamic portion of the hook name, `$option`, refers to the option name.
    10671139         *
     
    10691141         * @since 3.0.0
    10701142         * @since 4.4.0 The `$option` parameter was added
    10711143         *
    1072          * @param mixed  $value  Value of site option.
     1144         * @param mixed  $value  Value of network option.
    10731145         * @param string $option Option name.
    10741146         */
    10751147        return apply_filters( 'site_option_' . $option, $value, $option );
    10761148}
    10771149
    10781150/**
    1079  * Add a new site option.
     1151 * Add a new network option.
    10801152 *
    1081  * Existing options will not be updated. Note that prior to 3.3 this wasn't the case.
     1153 * Existing options will not be updated.
    10821154 *
    1083  * @since 2.8.0
     1155 * @since 4.4.0
    10841156 *
    10851157 * @see add_option()
    10861158 *
    10871159 * @global wpdb $wpdb
    10881160 *
    1089  * @param string $option Name of option to add. Expected to not be SQL-escaped.
    1090  * @param mixed  $value  Optional. Option value, can be anything. Expected to not be SQL-escaped.
     1161 * @param  string   $option     Name of option to add. Expected to not be SQL-escaped.
     1162 * @param  mixed    $value      Option value, can be anything. Expected to not be SQL-escaped.
     1163 * @param  int|bool $network_id Optional. ID of the network. Defaults to current network ID.
    10911164 * @return bool False if option was not added and true if option was added.
    10921165 */
    1093 function add_site_option( $option, $value ) {
     1166function add_network_option( $option, $value, $network_id = false ) {
    10941167        global $wpdb;
    10951168
     1169        $network_id = (int) $network_id;
     1170
     1171        // Fallback to the current network if a network ID is not specified.
     1172        if ( ! $network_id && is_multisite() ) {
     1173                $network_id = get_current_site()->id;
     1174        }
     1175
    10961176        wp_protect_special_option( $option );
    10971177
    10981178        /**
    1099          * Filter the value of a specific site option before it is added.
     1179         * Filter the value of a specific network option before it is added.
    11001180         *
    11011181         * The dynamic portion of the hook name, `$option`, refers to the option name.
    11021182         *
     
    11041184         * @since 3.0.0
    11051185         * @since 4.4.0 The `$option` parameter was added
    11061186         *
    1107          * @param mixed  $value  Value of site option.
     1187         * @param mixed  $value  Value of network option.
    11081188         * @param string $option Option name.
    11091189         */
    11101190        $value = apply_filters( 'pre_add_site_option_' . $option, $value, $option );
    11111191
    1112         $notoptions_key = "{$wpdb->siteid}:notoptions";
     1192        $notoptions_key = "$network_id:notoptions";
    11131193
    1114         if ( !is_multisite() ) {
     1194        if ( ! is_multisite() ) {
    11151195                $result = add_option( $option, $value );
    11161196        } else {
    1117                 $cache_key = "{$wpdb->siteid}:$option";
     1197                $cache_key = "$network_id:$option";
    11181198
    11191199                // Make sure the option doesn't already exist. We can check the 'notoptions' cache before we ask for a db query
    11201200                $notoptions = wp_cache_get( $notoptions_key, 'site-options' );
    1121                 if ( ! is_array( $notoptions ) || ! isset( $notoptions[$option] ) )
    1122                         if ( false !== get_site_option( $option ) )
     1201                if ( ! is_array( $notoptions ) || ! isset( $notoptions[ $option ] ) ) {
     1202                        if ( false !== get_network_option( $option, false, $network_id ) ) {
    11231203                                return false;
     1204                        }
     1205                }
    11241206
    11251207                $value = sanitize_option( $option, $value );
    11261208
    11271209                $serialized_value = maybe_serialize( $value );
    1128                 $result = $wpdb->insert( $wpdb->sitemeta, array('site_id' => $wpdb->siteid, 'meta_key' => $option, 'meta_value' => $serialized_value ) );
     1210                $result = $wpdb->insert( $wpdb->sitemeta, array( 'site_id'    => $network_id, 'meta_key'  => $option, 'meta_value' => $serialized_value ) );
    11291211
    1130                 if ( ! $result )
     1212                if ( ! $result ) {
    11311213                        return false;
     1214                }
    11321215
    11331216                wp_cache_set( $cache_key, $value, 'site-options' );
    11341217
    11351218                // This option exists now
    11361219                $notoptions = wp_cache_get( $notoptions_key, 'site-options' ); // yes, again... we need it to be fresh
    1137                 if ( is_array( $notoptions ) && isset( $notoptions[$option] ) ) {
    1138                         unset( $notoptions[$option] );
     1220                if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) {
     1221                        unset( $notoptions[ $option ] );
    11391222                        wp_cache_set( $notoptions_key, $notoptions, 'site-options' );
    11401223                }
    11411224        }
     
    11431226        if ( $result ) {
    11441227
    11451228                /**
    1146                  * Fires after a specific site option has been successfully added.
     1229                 * Fires after a specific network option has been successfully added.
    11471230                 *
    11481231                 * The dynamic portion of the hook name, `$option`, refers to the option name.
    11491232                 *
    11501233                 * @since 2.9.0 As "add_site_option_{$key}"
    11511234                 * @since 3.0.0
    11521235                 *
    1153                  * @param string $option Name of site option.
    1154                  * @param mixed  $value  Value of site option.
     1236                 * @param string $option Name of the network option.
     1237                 * @param mixed  $value  Value of the network option.
    11551238                 */
    1156                 do_action( "add_site_option_{$option}", $option, $value );
     1239                do_action( 'add_site_option_' . $option, $option, $value );
    11571240
    11581241                /**
    1159                  * Fires after a site option has been successfully added.
     1242                 * Fires after a network option has been successfully added.
    11601243                 *
    11611244                 * @since 3.0.0
    11621245                 *
    1163                  * @param string $option Name of site option.
    1164                  * @param mixed  $value  Value of site option.
     1246                 * @param string $option Name of the network option.
     1247                 * @param mixed  $value  Value of the network option.
    11651248                 */
    1166                 do_action( "add_site_option", $option, $value );
     1249                do_action( 'add_site_option', $option, $value );
    11671250
    11681251                return true;
    11691252        }
     1253
    11701254        return false;
    11711255}
    11721256
    11731257/**
    1174  * Removes site option by name.
     1258 * Removes network option by name.
    11751259 *
    1176  * @since 2.8.0
     1260 * @since 4.4.0
    11771261 *
    11781262 * @see delete_option()
    11791263 *
    11801264 * @global wpdb $wpdb
    11811265 *
    1182  * @param string $option Name of option to remove. Expected to not be SQL-escaped.
     1266 * @param  string   $option     Name of option to remove. Expected to not be SQL-escaped.
     1267 * @param  int|bool $network_id Optional. ID of the network. Defaults to current network ID.
    11831268 * @return bool True, if succeed. False, if failure.
    11841269 */
    1185 function delete_site_option( $option ) {
     1270function delete_network_option( $option, $network_id = false ) {
    11861271        global $wpdb;
    11871272
     1273        $network_id = (int) $network_id;
     1274
     1275        // Fallback to the current network if a network ID is not specified.
     1276        if ( ! $network_id && is_multisite() ) {
     1277                $network_id = get_current_site()->id;
     1278        }
     1279
    11881280        /**
    1189          * Fires immediately before a specific site option is deleted.
     1281         * Fires immediately before a specific network option is deleted.
    11901282         *
    11911283         * The dynamic portion of the hook name, `$option`, refers to the option name.
    11921284         *
     
    11971289         */
    11981290        do_action( 'pre_delete_site_option_' . $option, $option );
    11991291
    1200         if ( !is_multisite() ) {
     1292        if ( ! is_multisite() ) {
    12011293                $result = delete_option( $option );
    12021294        } else {
    1203                 $row = $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM {$wpdb->sitemeta} WHERE meta_key = %s AND site_id = %d", $option, $wpdb->siteid ) );
    1204                 if ( is_null( $row ) || !$row->meta_id )
     1295                $row = $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM {$wpdb->sitemeta} WHERE meta_key = %s AND site_id = %d", $option, $network_id ) );
     1296                if ( is_null( $row ) || ! $row->meta_id ) {
    12051297                        return false;
    1206                 $cache_key = "{$wpdb->siteid}:$option";
     1298                }
     1299                $cache_key = "$network_id:$option";
    12071300                wp_cache_delete( $cache_key, 'site-options' );
    12081301
    1209                 $result = $wpdb->delete( $wpdb->sitemeta, array( 'meta_key' => $option, 'site_id' => $wpdb->siteid ) );
     1302                $result = $wpdb->delete( $wpdb->sitemeta, array( 'meta_key' => $option, 'site_id' => $network_id ) );
    12101303        }
    12111304
    12121305        if ( $result ) {
    12131306
    12141307                /**
    1215                  * Fires after a specific site option has been deleted.
     1308                 * Fires after a specific network option has been deleted.
    12161309                 *
    12171310                 * The dynamic portion of the hook name, `$option`, refers to the option name.
    12181311                 *
    12191312                 * @since 2.9.0 As "delete_site_option_{$key}"
    12201313                 * @since 3.0.0
    12211314                 *
    1222                  * @param string $option Name of the site option.
     1315                 * @param string $option Name of the network option.
    12231316                 */
    1224                 do_action( "delete_site_option_{$option}", $option );
     1317                do_action( 'delete_site_option_' . $option, $option );
    12251318
    12261319                /**
    1227                  * Fires after a site option has been deleted.
     1320                 * Fires after a network option has been deleted.
    12281321                 *
    12291322                 * @since 3.0.0
    12301323                 *
    1231                  * @param string $option Name of the site option.
     1324                 * @param string $option Name of the network option.
    12321325                 */
    1233                 do_action( "delete_site_option", $option );
     1326                do_action( 'delete_site_option', $option );
    12341327
    12351328                return true;
    12361329        }
     1330
    12371331        return false;
    12381332}
    12391333
    12401334/**
    1241  * Update the value of a site option that was already added.
     1335 * Update the value of a network option that was already added.
    12421336 *
    1243  * @since 2.8.0
     1337 * @since 4.4.0
    12441338 *
    12451339 * @see update_option()
    12461340 *
    12471341 * @global wpdb $wpdb
    12481342 *
    1249  * @param string $option Name of option. Expected to not be SQL-escaped.
    1250  * @param mixed  $value  Option value. Expected to not be SQL-escaped.
     1343 * @param string   $option     Name of option. Expected to not be SQL-escaped.
     1344 * @param mixed    $value      Option value. Expected to not be SQL-escaped.
     1345 * @param int|bool $network_id Optional. ID of the network. Defaults to current network ID.
    12511346 * @return bool False if value was not updated and true if value was updated.
    12521347 */
    1253 function update_site_option( $option, $value ) {
     1348function update_network_option( $option, $value, $network_id = false ) {
    12541349        global $wpdb;
    12551350
     1351        $network_id = (int) $network_id;
     1352
     1353        // Fallback to the current network if a network ID is not specified.
     1354        if ( ! $network_id && is_multisite() ) {
     1355                $network_id = get_current_site()->id;
     1356        }
     1357
    12561358        wp_protect_special_option( $option );
    12571359
    1258         $old_value = get_site_option( $option );
     1360        $old_value = get_network_option( $option, false, $network_id );
    12591361
    12601362        /**
    1261          * Filter a specific site option before its value is updated.
     1363         * Filter a specific network option before its value is updated.
    12621364         *
    12631365         * The dynamic portion of the hook name, `$option`, refers to the option name.
    12641366         *
     
    12661368         * @since 3.0.0
    12671369         * @since 4.4.0 The `$option` parameter was added
    12681370         *
    1269          * @param mixed  $value     New value of site option.
    1270          * @param mixed  $old_value Old value of site option.
     1371         * @param mixed  $value     New value of the network option.
     1372         * @param mixed  $old_value Old value of the network option.
    12711373         * @param string $option    Option name.
    12721374         */
    12731375        $value = apply_filters( 'pre_update_site_option_' . $option, $value, $old_value, $option );
    12741376
    1275         if ( $value === $old_value )
     1377        if ( $value === $old_value ) {
    12761378                return false;
     1379        }
    12771380
    1278         if ( false === $old_value )
    1279                 return add_site_option( $option, $value );
     1381        if ( false === $old_value ) {
     1382                return add_network_option( $option, $value, $network_id );
     1383        }
    12801384
    1281         $notoptions_key = "{$wpdb->siteid}:notoptions";
     1385        $notoptions_key = "$network_id:notoptions";
    12821386        $notoptions = wp_cache_get( $notoptions_key, 'site-options' );
    1283         if ( is_array( $notoptions ) && isset( $notoptions[$option] ) ) {
    1284                 unset( $notoptions[$option] );
     1387        if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) {
     1388                unset( $notoptions[ $option ] );
    12851389                wp_cache_set( $notoptions_key, $notoptions, 'site-options' );
    12861390        }
    12871391
    1288         if ( !is_multisite() ) {
     1392        if ( ! is_multisite() ) {
    12891393                $result = update_option( $option, $value );
    12901394        } else {
    12911395                $value = sanitize_option( $option, $value );
    12921396
    12931397                $serialized_value = maybe_serialize( $value );
    1294                 $result = $wpdb->update( $wpdb->sitemeta, array( 'meta_value' => $serialized_value ), array( 'site_id' => $wpdb->siteid, 'meta_key' => $option ) );
     1398                $result = $wpdb->update( $wpdb->sitemeta, array( 'meta_value' => $serialized_value ), array( 'site_id' => $network_id, 'meta_key' => $option ) );
    12951399
    12961400                if ( $result ) {
    1297                         $cache_key = "{$wpdb->siteid}:$option";
     1401                        $cache_key = "$network_id:$option";
    12981402                        wp_cache_set( $cache_key, $value, 'site-options' );
    12991403                }
    13001404        }
     
    13021406        if ( $result ) {
    13031407
    13041408                /**
    1305                  * Fires after the value of a specific site option has been successfully updated.
     1409                 * Fires after the value of a specific network option has been successfully updated.
    13061410                 *
    13071411                 * The dynamic portion of the hook name, `$option`, refers to the option name.
    13081412                 *
    13091413                 * @since 2.9.0 As "update_site_option_{$key}"
    13101414                 * @since 3.0.0
    13111415                 *
    1312                  * @param string $option    Name of site option.
    1313                  * @param mixed  $value     Current value of site option.
    1314                  * @param mixed  $old_value Old value of site option.
     1416                 * @param string $option    Name of the network option.
     1417                 * @param mixed  $value     Current value of the network option.
     1418                 * @param mixed  $old_value Old value of the network option.
    13151419                 */
    1316                 do_action( "update_site_option_{$option}", $option, $value, $old_value );
     1420                do_action( 'update_site_option_' . $option, $option, $value, $old_value );
    13171421
    13181422                /**
    1319                  * Fires after the value of a site option has been successfully updated.
     1423                 * Fires after the value of a network option has been successfully updated.
    13201424                 *
    13211425                 * @since 3.0.0
    13221426                 *
    1323                  * @param string $option    Name of site option.
    1324                  * @param mixed  $value     Current value of site option.
    1325                  * @param mixed  $old_value Old value of site option.
     1427                 * @param string $option    Name of the network option.
     1428                 * @param mixed  $value     Current value of the network option.
     1429                 * @param mixed  $old_value Old value of the network option.
    13261430                 */
    1327                 do_action( "update_site_option", $option, $value, $old_value );
     1431                do_action( 'update_site_option', $option, $value, $old_value );
    13281432
    13291433                return true;
    13301434        }
     1435
    13311436        return false;
    13321437}
    13331438