Changeset 48121 for trunk/src/wp-admin/includes/plugin.php

Timestamp:

06/22/2020 05:24:34 PM (4 years ago)

Author:

desrosj

Message:

General: Remove “whitelist” and “blacklist” in favor of more clear and inclusive language.

“The WordPress open source community cares about diversity. We strive to maintain a welcoming environment where everyone can feel included.”

With this commit, all occurrences of “whitelist” and “blacklist” (with the single exception of the $new_whitelist_options global variable) are removed. A new ticket has been opened to explore renaming the $new_whitelist_options variable (#50434).

Changing to more specific names or rewording sentences containing these terms not only makes the code more inclusive, but also helps provide clarity. These terms are often ambiguous. What is being blocked or allowed is not always immediately clear. This can make it more difficult for non-native English speakers to read through the codebase.

Words matter. If one contributor feels more welcome because these terms are removed, this was worth the effort.

Props strangerstudios, jorbin, desrosj, joemcgill, timothyblynjacobs, ocean90, ayeshrajans, davidbaumwald, earnjam.
See #48900, #50434.
Fixes #50413.

File:

• trunk/src/wp-admin/includes/plugin.php (modified) (7 diffs)

trunk/src/wp-admin/includes/plugin.php

@@ -2137 +2137 @@
 }
 
-/* Whitelist functions */
-
-/**
- * Refreshes the value of the options whitelist available via the 'whitelist_options' hook.
- *
- * See the {@see 'whitelist_options'} filter.
+/* Allowed list functions */
+
+/**
+ * Refreshes the value of the allowed options list available via the 'allowed_options' hook.
+ *
+ * See the {@see 'allowed_options'} filter.
  *
  * @since 2.7.0
@@ -2155 +2155 @@
 
     if ( is_array( $new_whitelist_options ) ) {
-        $options = add_option_whitelist( $new_whitelist_options, $options );
+        $options = add_option_allowed_list( $new_whitelist_options, $options );
     }
 
@@ -2162 +2162 @@
 
 /**
- * Adds an array of options to the options whitelist.
+ * Adds an array of options to the list of allowed options.
  *
  * @since 2.7.0
  *
- * @global array $whitelist_options
+ * @global array $allowed_options
  *
  * @param array        $new_options
@@ -2172 +2172 @@
  * @return array
  */
-function add_option_whitelist( $new_options, $options = '' ) {
+function add_option_allowed_list( $new_options, $options = '' ) {
     if ( '' === $options ) {
-        global $whitelist_options;
+        global $allowed_options;
     } else {
-        $whitelist_options = $options;
+        $allowed_options = $options;
     }
 
     foreach ( $new_options as $page => $keys ) {
         foreach ( $keys as $key ) {
-            if ( ! isset( $whitelist_options[ $page ] ) || ! is_array( $whitelist_options[ $page ] ) ) {
-                $whitelist_options[ $page ]   = array();
-                $whitelist_options[ $page ][] = $key;
+            if ( ! isset( $allowed_options[ $page ] ) || ! is_array( $allowed_options[ $page ] ) ) {
+                $allowed_options[ $page ]   = array();
+                $allowed_options[ $page ][] = $key;
             } else {
-                $pos = array_search( $key, $whitelist_options[ $page ], true );
+                $pos = array_search( $key, $allowed_options[ $page ], true );
                 if ( false === $pos ) {
-                    $whitelist_options[ $page ][] = $key;
+                    $allowed_options[ $page ][] = $key;
                 }
             }
@@ -2193 +2193 @@
     }
 
-    return $whitelist_options;
-}
-
-/**
- * Removes a list of options from the options whitelist.
- *
- * @since 2.7.0
- *
- * @global array $whitelist_options
+    return $allowed_options;
+}
+
+/**
+ * Removes a list of options from the allowed options list.
+ *
+ * @since 5.5.0
+ *
+ * @global array $allowed_options
  *
  * @param array        $del_options
@@ -2207 +2207 @@
  * @return array
  */
-function remove_option_whitelist( $del_options, $options = '' ) {
+function remove_option_allowed_list( $del_options, $options = '' ) {
     if ( '' === $options ) {
-        global $whitelist_options;
+        global $allowed_options;
     } else {
-        $whitelist_options = $options;
+        $allowed_options = $options;
     }
 
     foreach ( $del_options as $page => $keys ) {
         foreach ( $keys as $key ) {
-            if ( isset( $whitelist_options[ $page ] ) && is_array( $whitelist_options[ $page ] ) ) {
-                $pos = array_search( $key, $whitelist_options[ $page ], true );
+            if ( isset( $allowed_options[ $page ] ) && is_array( $allowed_options[ $page ] ) ) {
+                $pos = array_search( $key, $allowed_options[ $page ], true );
                 if ( false !== $pos ) {
-                    unset( $whitelist_options[ $page ][ $pos ] );
+                    unset( $allowed_options[ $page ][ $pos ] );
                 }
             }
@@ -2225 +2225 @@
     }
 
-    return $whitelist_options;
+    return $allowed_options;
 }