mb_substr( string $string, int $start, int|null $length = null, string|null $encoding = null ): string

Parameters

$stringstring

The string to extract the substring from.

$startint

Position to being extraction from in $string.

$lengthint|nulloptional

Maximum number of characters to extract from $string. Default null.Default: null

$encodingstring|nulloptional

Character encoding to use. Default null.Default: null

Return

string

Extracted substring.

Uses · 1

• _mb_substr()Internal compat function to mimic mb_substr().

Used by · 10

• PHPMailer::base64EncodeWrapMB()
• POMO_Reader::substr()
• ParagonIE_Sodium_Core_Util::substr()Safe substring
• Services_JSON::substr8()Returns part of a string, interpreting $start and $length as number of bytes.
• get_avatar_data()Retrieves default data about the avatar.
• get_sample_permalink_html()Returns the HTML of the sample permalink slug editor.
• validate_file()Validates a file name and path against an allowed set of rules.
• wp_html_excerpt()Safely extracts not more than the first $count characters from HTML string.
• wp_insert_user()Inserts a user into the database.
• wpdb::strip_invalid_text()Strips any invalid characters based on value/charset pairs.

Source

View on Trac ↗View on GitHub ↗

272	function mb_substr( $string, $start, $length = null, $encoding = null ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound273		return _mb_substr( $string, $start, $length, $encoding );274	}

History

Introduced in 3.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/compat.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.