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

Timestamp:

07/23/2020 03:12:49 AM (5 years ago)

Author:

jorbin

Message:

General: Update code for readability and inclusion

There are two pieces in here:

1) The update to change blacklist to blocklist is moved to disallowed_list. "Block" has a meaning in our code, and there could be ambiguity between this code and code related to blocks.

2) This improves backwards compatibility for code that was accessing the now deprecated code.

Previously: [48477], [48405], [48400], [48121], [48122], [48124], [48142], [48566]

Props: desrosj, SergeyBiryukov, johnjamesjacoby
Fixes: #50413

File:

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

trunk/src/wp-includes/option.php

@@ -34 +34 @@
     if ( empty( $option ) ) {
         return false;
+    }
+
+    /*
+     * Until a proper _deprecated_option() function can be introduced,
+     * redirect requests to deprecated keys to the new, correct ones.
+     */
+    $deprecated_keys = array(
+        'blacklist_keys'    => 'disallowed_keys',
+        'comment_whitelist' => 'comment_previously_approved',
+    );
+
+    if ( ! wp_installing() && isset( $deprecated_keys[ $option ] ) ) {
+        _deprecated_argument(
+            __FUNCTION__,
+            '5.5.0',
+            sprintf(
+                /* translators: 1: Deprecated option key, 2: New option key. */
+                __( 'The "%1$s" option key has been renamed to "%2$s".' ),
+                $option,
+                $deprecated_keys[ $option ]
+            )
+        );
+        return get_option( $deprecated_keys[ $option ], $default );
     }
 
@@ -314 +337 @@
     }
 
+    /*
+     * Until a proper _deprecated_option() function can be introduced,
+     * redirect requests to deprecated keys to the new, correct ones.
+     */
+    $deprecated_keys = array(
+        'blacklist_keys'    => 'disallowed_keys',
+        'comment_whitelist' => 'comment_previously_approved',
+    );
+
+    if ( ! wp_installing() && isset( $deprecated_keys[ $option ] ) ) {
+        _deprecated_argument(
+            __FUNCTION__,
+            '5.5.0',
+            sprintf(
+                /* translators: 1: Deprecated option key, 2: New option key. */
+                __( 'The "%1$s" option key has been renamed to "%2$s".' ),
+                $option,
+                $deprecated_keys[ $option ]
+            )
+        );
+        return update_option( $deprecated_keys[ $option ], $value, $autoload );
+    }
+
     wp_protect_special_option( $option );
 
@@ -476 +522 @@
     if ( empty( $option ) ) {
         return false;
+    }
+
+    /*
+     * Until a proper _deprecated_option() function can be introduced,
+     * redirect requests to deprecated keys to the new, correct ones.
+     */
+    $deprecated_keys = array(
+        'blacklist_keys'    => 'disallowed_keys',
+        'comment_whitelist' => 'comment_previously_approved',
+    );
+
+    if ( ! wp_installing() && isset( $deprecated_keys[ $option ] ) ) {
+        _deprecated_argument(
+            __FUNCTION__,
+            '5.5.0',
+            sprintf(
+                /* translators: 1: Deprecated option key, 2: New option key. */
+                __( 'The "%1$s" option key has been renamed to "%2$s".' ),
+                $option,
+                $deprecated_keys[ $option ]
+            )
+        );
+        return add_option( $deprecated_keys[ $option ], $value, $deprecated, $autoload );
     }