W3cubDocs

/WordPress

mbstring_binary_safe_encoding( bool $reset = false )

Set the mbstring internal encoding to a binary safe encoding when func_overload is enabled.

Description

When mbstring.func_overload is in use for multi-byte encodings, the results from strlen() and similar functions respect the utf8 characters, causing binary data to return incorrect lengths.

This function overrides the mbstring encoding to a binary-safe encoding, and resets it to the users expected encoding afterwards through the reset_mbstring_encoding function.

It is safe to recursively call this function, however each mbstring_binary_safe_encoding() call must be followed up with an equal number of reset_mbstring_encoding() calls.

See also

Parameters

$reset

(bool) (Optional) Whether to reset the encoding back to a previously-set encoding.

Default value: false

Source

File: wp-includes/functions.php 

function mbstring_binary_safe_encoding( $reset = false ) {
	static $encodings  = array();
	static $overloaded = null;

	if ( is_null( $overloaded ) ) {
		$overloaded = function_exists( 'mb_internal_encoding' ) && ( ini_get( 'mbstring.func_overload' ) & 2 ); // phpcs:ignore PHPCompatibility.IniDirectives.RemovedIniDirectives.mbstring_func_overloadDeprecated
	}

	if ( false === $overloaded ) {
		return;
	}

	if ( ! $reset ) {
		$encoding = mb_internal_encoding();
		array_push( $encodings, $encoding );
		mb_internal_encoding( 'ISO-8859-1' );
	}

	if ( $reset && $encodings ) {
		$encoding = array_pop( $encodings );
		mb_internal_encoding( $encoding );
	}
}

Used By

Used By Description
wp-admin/includes/file.php: verify_file_signature()

Verifies the contents of a file against its ED25519 signature.
wp-includes/wp-db.php: wpdb::strip_invalid_text()

Strips any invalid characters based on value/charset pairs.
wp-admin/includes/class-wp-filesystem-ftpext.php: WP_Filesystem_FTPext::put_contents()

Writes a string to a file.
wp-admin/includes/class-wp-filesystem-direct.php: WP_Filesystem_Direct::put_contents()

Writes a string to a file.
wp-admin/includes/image.php: wp_read_image_metadata()

Get extended image metadata, exif or iptc as available.
wp-admin/includes/class-wp-filesystem-ftpsockets.php: WP_Filesystem_ftpsockets::dirlist()

Gets details for files in a directory or a specific file.
wp-admin/includes/class-wp-filesystem-ftpsockets.php: WP_Filesystem_ftpsockets::get_contents()

Reads entire file into a string.
wp-admin/includes/class-wp-filesystem-ftpsockets.php: WP_Filesystem_ftpsockets::put_contents()

Writes a string to a file.
wp-admin/includes/file.php: _unzip_file_pclzip()

Attempts to unzip an archive using the PclZip library.
wp-includes/formatting.php: seems_utf8()

Checks to see if a string is utf8 encoded.
wp-includes/formatting.php: utf8_uri_encode()

Encode the Unicode values to be used in the URI.
wp-includes/class-http.php: WP_Http::request()

Send an HTTP request to a URI.
wp-includes/functions.php: reset_mbstring_encoding()

Reset the mbstring internal encoding to a users previously set encoding.

Changelog

Version Description
3.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/mbstring_binary_safe_encoding