Changeset 7334

Timestamp:

07/02/2025 02:47:24 PM (10 months ago)

Author:

johnjamesjacoby

Message:

Tools - Warnings/Notices: begin phasing out of utf8_encode() for PHP 8.2 and higher.

This change moves the existing utf8_encode() usages into a new common formatting function: bbp_format_user_display_name(), and uses this new function to abstract & encapsulate checking that mbstring equivalents are loaded & supported.

Props philipjohn.

In branches/2.6, for 2.6.14.

Fixes #3585.

Location:

branches/2.6/src/includes

Files:

• common/formatting.php (modified) (1 diff)
• core/filters.php (modified) (1 diff)
• replies/template.php (modified) (1 diff)
• topics/template.php (modified) (1 diff)

branches/2.6/src/includes/common/formatting.php

@@ -783 +783 @@
     return $reason;
 }
+
+/** Users *********************************************************************/
+
+/**
+ * Format the display name of a user.
+ *
+ * Abstracts mbstring library check and fallback to utf8_encode().
+ *
+ * @link https://bbpress.trac.wordpress.org/ticket/2141
+ *
+ * @since 2.6.14
+ *
+ * @param string $display_name The author display
+ * @return string
+ */
+function bbp_format_user_display_name( $display_name = '' ) {
+
+    // Default return value
+    $retval = $display_name;
+
+    // Use the mbstring library if possible
+    if ( function_exists( 'mb_check_encoding' ) && ! mb_check_encoding( $display_name, 'UTF-8' ) ) {
+        $retval = mb_convert_encoding( $display_name, 'UTF-8', 'ISO-8859-1' );
+
+    // Fallback to function that (deprecated in PHP8.2)
+    } elseif ( seems_utf8( $display_name ) === false ) {
+        $retval = utf8_encode( $display_name );
+    }
+
+    // Return
+    return $retval;
+}

branches/2.6/src/includes/core/filters.php

@@ -306 +306 @@
 
 // Topic and reply author display names
-add_filter( 'bbp_get_topic_author_display_name', 'wptexturize'   );
-add_filter( 'bbp_get_topic_author_display_name', 'convert_chars' );
-add_filter( 'bbp_get_topic_author_display_name', 'esc_html'      );
-add_filter( 'bbp_get_reply_author_display_name', 'wptexturize'   );
-add_filter( 'bbp_get_reply_author_display_name', 'convert_chars' );
-add_filter( 'bbp_get_reply_author_display_name', 'esc_html'      );
+add_filter( 'bbp_get_topic_author_display_name', 'bbp_format_user_display_name' );
+add_filter( 'bbp_get_topic_author_display_name', 'wptexturize'                  );
+add_filter( 'bbp_get_topic_author_display_name', 'convert_chars'                );
+add_filter( 'bbp_get_topic_author_display_name', 'esc_html'                     );
+add_filter( 'bbp_get_reply_author_display_name', 'bbp_format_user_display_name' );
+add_filter( 'bbp_get_reply_author_display_name', 'wptexturize'                  );
+add_filter( 'bbp_get_reply_author_display_name', 'convert_chars'                );
+add_filter( 'bbp_get_reply_author_display_name', 'esc_html'                     );
 
 /**

branches/2.6/src/includes/replies/template.php

@@ -1099 +1099 @@
         }
 
-        // Encode possible UTF8 display names
-        if ( seems_utf8( $author_name ) === false ) {
-            $author_name = utf8_encode( $author_name );
-        }
-
         // Filter & return
         return apply_filters( 'bbp_get_reply_author_display_name', $author_name, $reply_id );

branches/2.6/src/includes/topics/template.php

@@ -1332 +1332 @@
         }
 
-        // Encode possible UTF8 display names
-        if ( seems_utf8( $author_name ) === false ) {
-            $author_name = utf8_encode( $author_name );
-        }
-
         // Filter & return
         return apply_filters( 'bbp_get_topic_author_display_name', $author_name, $topic_id );