Context Navigation

← Previous Change
Next Change →

functions.php

Timestamp:

05/14/2024 06:03:43 PM (2 years ago)

Author:

dmsnell

Message:

Normalize UTF-8 charset slug detection.

There are several exist places in Core that attempt to detect if a blog charset
is UTF-8. Each place attempts to perform the same check, except the logic is
spread throughout and there's no single method provided to make this
determination in a consistent way. The _canonical_charset() method exists,
but is marked private for use.

In this patch the new unicode module provides is_utf8_charset() as a method
taking an optional charset slug and indicating if it represents UTF-8,
examining all of the allowable variants of that slug. Associated code is
updated to use this new function, including _canonical_charset(). If no slug
is provided, it will look up the current get_option( 'blog_charset' ).

Finally, the test functions governing _canonical_charset() have been
rewritten as a single test with a data provider instead of as separate test
functions.

Developed in https://github.com/WordPress/wordpress-develop/pull/6535
Discussed in https://core.trac.wordpress.org/ticket/61182

Fixes #61182.
Props dmsnell, jonsurrell.

File:

: 1 edited

trunk/src/wp-includes/functions.php (modified) (1 diff)

Legend:

: Unmodified
: Added
: Removed

trunk/src/wp-includes/functions.php

-              r58130
+              r58147
  * @see https://core.trac.wordpress.org/ticket/23688
+ *
  * @param string $charset A charset name.
+ * @param string $charset A charset name, e.g. "UTF-8", "Windows-1252", "SJIS".
  * @return string The canonical form of the charset.
  */
 function _canonical_charset( $charset ) {
+        if ( 'utf-8' === strtolower( $charset ) || 'utf8' === strtolower( $charset ) ) {
+        if ( is_utf8_charset( $charset ) ) {
                 return 'UTF-8';
+        }
+        if ( 'iso-8859-1' === strtolower( $charset ) || 'iso8859-1' === strtolower( $charset ) ) {
+        /*
+         * Normalize the ISO-8859-1 family of languages.
+         *
+         * This is not required for htmlspecialchars(), as it properly recognizes all of
+         * the input character sets that here are transformed into "ISO-8859-1".
+         *
+         * @todo Should this entire check be removed since it's not required for the stated purpose?
+         * @todo Should WordPress transform other potential charset equivalents, such as "latin1"?
+         */
+        if (
+                ( 0 === strcasecmp( 'iso-8859-1', $charset ) ) ||
+                ( 0 === strcasecmp( 'iso8859-1', $charset ) )
+        ) {
                 return 'ISO-8859-1';
+        }

Note: See TracChangeset for help on using the changeset viewer.

Make WordPress Core

Context Navigation

Changeset 58147 for trunk/src/wp-includes/functions.php

Legend:

trunk/src/wp-includes/functions.php

Download in other formats: