Changeset 36019 for trunk/src/wp-includes/compat.php

Timestamp:

12/19/2015 04:55:50 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add missing DocBlocks for mb_strlen() and _mb_strlen().

Both will be ignored from parsing as and serve as compat functions for PHP's mb_strlen(), which is not enabled by default.

Introduced in [32114].

See #32246.

File:

• trunk/src/wp-includes/compat.php (modified) (3 diffs)

trunk/src/wp-includes/compat.php

@@ -48 +48 @@
      * @ignore
      * @since 3.2.0
+     *
+     * @see _mb_substr()
      *
      * @param string      $str      The string to extract the substring from.
@@ -131 +133 @@
 
 if ( ! function_exists( 'mb_strlen' ) ) :
+    /**
+     * Compat function to mimic mb_strlen().
+     *
+     * @ignore
+     * @since 4.2.0
+     *
+     * @see _mb_strlen()
+     *
+     * @param string      $str      The string to retrieve the character length from.
+     * @param string|null $encoding Optional. Character encoding to use. Default null.
+     * @return int String length of `$str`.
+     */
     function mb_strlen( $str, $encoding = null ) {
         return _mb_strlen( $str, $encoding );
@@ -136 +150 @@
 endif;
 
-/*
+/**
+ * Internal compat function to mimic mb_strlen().
+ *
  * Only understands UTF-8 and 8bit.  All other character sets will be treated as 8bit.
- * For $encoding === UTF-8, the $str input is expected to be a valid UTF-8 byte sequence.
- * The behavior of this function for invalid inputs is undefined.
+ * For $encoding === UTF-8, the `$str` input is expected to be a valid UTF-8 byte
+ * sequence. The behavior of this function for invalid inputs is undefined.
+ *
+ * @ignore
+ * @since 4.2.0
+ *
+ * @param string      $str      The string to retrieve the character length from.
+ * @param string|null $encoding Optional. Character encoding to use. Default null.
+ * @return int String length of `$str`.
  */
 function _mb_strlen( $str, $encoding = null ) {