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

Timestamp:

07/14/2020 12:31:22 PM (4 years ago)

Author:

desrosj

Message:

General: Rename the $new_whitelist_options global variable.

This change renames $new_whitelist_options to $new_allowed_options. This makes the variable’s purpose more clear, and promotes using more inclusive language.

For backwards compatibility, the new variable is passed by reference to the old one.

Follow up to [48121].

Props ayeshrajans, desrosj, jorbin, SergeyBiryukov.
See #50413.
Fixes #50434.

File:

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

trunk/src/wp-includes/option.php

@@ -2124 +2124 @@
  * @since 2.7.0
  * @since 4.7.0 `$args` can be passed to set flags on the setting, similar to `register_meta()`.
- *
- * @global array $new_whitelist_options
+ * @since 5.5.0 `$new_whitelist_options` was renamed to `$new_allowed_options`.
+ *              Please consider writing more inclusive code.
+ *
+ * @global array $new_allowed_options
  * @global array $wp_registered_settings
  *
@@ -2146 +2148 @@
  */
 function register_setting( $option_group, $option_name, $args = array() ) {
-    global $new_whitelist_options, $wp_registered_settings;
+    global $new_allowed_options, $wp_registered_settings;
+
+    /*
+     * In 5.5.0, the `$new_whitelist_options` global variable was renamed to `$new_allowed_options`.
+     * Please consider writing more inclusive code.
+     */
+    $GLOBALS['new_whitelist_options'] = &$new_allowed_options;
 
     $defaults = array(
@@ -2212 +2220 @@
     }
 
-    $new_whitelist_options[ $option_group ][] = $option_name;
+    $new_allowed_options[ $option_group ][] = $option_name;
 
     if ( ! empty( $args['sanitize_callback'] ) ) {
@@ -2240 +2248 @@
  * @since 2.7.0
  * @since 4.7.0 `$sanitize_callback` was deprecated. The callback from `register_setting()` is now used instead.
- *
- * @global array $new_whitelist_options
+ * @since 5.5.0 `$new_whitelist_options` was renamed to `$new_allowed_options`.
+ *              Please consider writing more inclusive code.
+ *
+ * @global array $new_allowed_options
  * @global array $wp_registered_settings
  *
@@ -2249 +2259 @@
  */
 function unregister_setting( $option_group, $option_name, $deprecated = '' ) {
-    global $new_whitelist_options, $wp_registered_settings;
+    global $new_allowed_options, $wp_registered_settings;
+
+    /*
+     * In 5.5.0, the `$new_whitelist_options` global variable was renamed to `$new_allowed_options`.
+     * Please consider writing more inclusive code.
+     */
+    $GLOBALS['new_whitelist_options'] = &$new_allowed_options;
 
     if ( 'misc' === $option_group ) {
@@ -2277 +2293 @@
     }
 
-    $pos = array_search( $option_name, (array) $new_whitelist_options[ $option_group ], true );
+    $pos = array_search( $option_name, (array) $new_allowed_options[ $option_group ], true );
 
     if ( false !== $pos ) {
-        unset( $new_whitelist_options[ $option_group ][ $pos ] );
+        unset( $new_allowed_options[ $option_group ][ $pos ] );
     }