Changeset 36017

Timestamp:

12/19/2015 04:46:43 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add missing DocBlocks for mb_substr() and _mb_substr().

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

Introduced in [17621].

See #32246.

File:

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

trunk/src/wp-includes/compat.php

@@ -43 +43 @@
 
 if ( ! function_exists( 'mb_substr' ) ) :
+    /**
+     * Compat function to mimic mb_substr().
+     *
+     * @ignore
+     * @since 3.2.0
+     *
+     * @param string      $str      The string to extract the substring from.
+     * @param int         $start    Position to being extraction from in `$str`.
+     * @param int|null    $length   Optional. Maximum number of characters to extract from `$str`.
+     *                              Default null.
+     * @param string|null $encoding Optional. Character encoding to use. Default null.
+     * @return string Extracted substring.
+     */
     function mb_substr( $str, $start, $length = null, $encoding = null ) {
         return _mb_substr( $str, $start, $length, $encoding );
@@ -48 +61 @@
 endif;
 
-/*
+/**
+ * Internal compat function to mimic mb_substr().
+ *
  * 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.
+ *
+ * @ignore
+ * @since 3.2.0
+ *
+ * @param string      $str      The string to extract the substring from.
+ * @param int         $start    Position to being extraction from in `$str`.
+ * @param int|null    $length   Optional. Maximum number of characters to extract from `$str`.
+ *                              Default null.
+ * @param string|null $encoding Optional. Character encoding to use. Default null.
+ * @return string Extracted substring.
  */
 function _mb_substr( $str, $start, $length = null, $encoding = null ) {