Changeset 54672

Timestamp:

10/24/2022 02:47:10 PM (4 years ago)

Author:

SergeyBiryukov

Message:

KSES: Display a notice if any of the required globals are not set.

When using the CUSTOM_TAGS constant, these global variables should be set to arrays:

• $allowedposttags
• $allowedtags
• $allowedentitynames
• $allowedxmlentitynames

This commit aims to improve developer experience by displaying a more helpful message to explain a PHP fatal error further in the code if any of these globals are either not set or not an array.

Note Using CUSTOM_TAGS is not recommended and should be considered deprecated. The wp_kses_allowed_html filter is more powerful and supplies context.

Follow-up to [832], [834], [2896], [13358], [21796], [28845], [43016], [48072].

Props doctorlai, pento, KnowingArt_com, bosconiandynamics, TJNowell, ironprogrammer, audrasjb, mukesh27, SergeyBiryukov.
Fixes #47357.

File:

• trunk/src/wp-includes/kses.php (modified) (2 diffs)

trunk/src/wp-includes/kses.php

@@ -36 +36 @@
  * Using `CUSTOM_TAGS` is not recommended and should be considered deprecated. The
  * {@see 'wp_kses_allowed_html'} filter is more powerful and supplies context.
+ *
+ * When using this constant, make sure to set all of these globals to arrays:
+ *
+ *  - `$allowedposttags`
+ *  - `$allowedtags`
+ *  - `$allowedentitynames`
+ *  - `$allowedxmlentitynames`
  *
  * @see wp_kses_allowed_html()
@@ -686 +693 @@
         $allowedposttags = array_map( '_wp_add_global_attributes', $allowedposttags );
 } else {
+        $required_kses_globals = array(
+                'allowedposttags',
+                'allowedtags',
+                'allowedentitynames',
+                'allowedxmlentitynames',
+        );
+        $missing_kses_globals  = array();
+
+        foreach ( $required_kses_globals as $global_name ) {
+                if ( ! isset( $GLOBALS[ $global_name ] ) || ! is_array( $GLOBALS[ $global_name ] ) ) {
+                        $missing_kses_globals[] = '<code>$' . $global_name . '</code>';
+                }
+        }
+
+        if ( $missing_kses_globals ) {
+                _doing_it_wrong(
+                        'wp_kses_allowed_html',
+                        sprintf(
+                                /* translators: 1: CUSTOM_TAGS, 2: Global variable names. */
+                                __( 'When using the %1$s constant, make sure to set these globals to an array: %2$s.' ),
+                                '<code>CUSTOM_TAGS</code>',
+                                implode( ', ', $missing_kses_globals )
+                        ),
+                        '6.2.0'
+                );
+        }
+
         $allowedtags     = wp_kses_array_lc( $allowedtags );
         $allowedposttags = wp_kses_array_lc( $allowedposttags );