Changeset 61004

Timestamp:

10/21/2025 04:17:38 AM (4 months ago)

Author:

dmsnell

Message:

Charset: Update docblock comment in _wp_scan_utf8().

Rewording of comment to better clarify the purpose of the arguments as written.

Discussed in https://core.trac.wordpress.org/ticket/63863

Follow-up to [60768].

See #63863.

File:

• trunk/src/wp-includes/compat-utf8.php (modified) (1 diff)

trunk/src/wp-includes/compat-utf8.php

@@ -29 +29 @@
  *     $at === 4; $invalid_length === 0;
  *
- * Note! This functions many arguments are passed without and “options”
- * array. This choice is based on the fact that this is a low-level function
- * and there’s no need to create an array of items on every invocation.
+ * Note! While passing an options array here might be convenient from a calling-code standpoint,
+ *       this function is intended to serve as a very low-level foundation upon which to build
+ *       higher level functionality. For the sake of keeping costs explicit all arguments are
+ *       passed directly.
  *
  * @since 6.9.0