Skip to content

Commit f9efe37

Browse files
committed
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. git-svn-id: https://develop.svn.wordpress.org/trunk@61004 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 399411b commit f9efe37

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/wp-includes/compat-utf8.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,10 @@
2828
* 1 === _wp_scan_utf8( $pineapple, $at, $invalid_length );
2929
* $at === 4; $invalid_length === 0;
3030
*
31-
* Note! This functions many arguments are passed without and “options”
32-
* array. This choice is based on the fact that this is a low-level function
33-
* and there’s no need to create an array of items on every invocation.
31+
* Note! While passing an options array here might be convenient from a calling-code standpoint,
32+
* this function is intended to serve as a very low-level foundation upon which to build
33+
* higher level functionality. For the sake of keeping costs explicit all arguments are
34+
* passed directly.
3435
*
3536
* @since 6.9.0
3637
* @access private

0 commit comments

Comments
 (0)