enmi-conf.org: comparison wp/wp-includes/compat.php

equal deleted inserted replaced

-:7b1b88e27a20
+:48c4eec2b7e6
 * @access private
 */
 // If gettext isn't available.
 if ( ! function_exists( '_' ) ) {
-	function _( $string ) {
+	function _( $message ) {
-		return $string;
+		return $message;
 	}
 }
 /**
 * Returns whether PCRE/u (PCRE_UTF8 modifier) is available for use.
 	}
 	return $utf8_pcre;
 }
+/**
+* Indicates if a given slug for a character set represents the UTF-8 text encoding.
+*
+* A charset is considered to represent UTF-8 if it is a case-insensitive match
+* of "UTF-8" with or without the hyphen.
+*
+* Example:
+*
+*     true  === _is_utf8_charset( 'UTF-8' );
+*     true  === _is_utf8_charset( 'utf8' );
+*     false === _is_utf8_charset( 'latin1' );
+*     false === _is_utf8_charset( 'UTF 8' );
+*
+*     // Only strings match.
+*     false === _is_utf8_charset( [ 'charset' => 'utf-8' ] );
+*
+* `is_utf8_charset` should be used outside of this file.
+*
+* @ignore
+* @since 6.6.1
+*
+* @param string $charset_slug Slug representing a text character encoding, or "charset".
+*                             E.g. "UTF-8", "Windows-1252", "ISO-8859-1", "SJIS".
+*
+* @return bool Whether the slug represents the UTF-8 encoding.
+*/
+function _is_utf8_charset( $charset_slug ) {
+	if ( ! is_string( $charset_slug ) ) {
+		return false;
+	}
+	return (
+		0 === strcasecmp( 'UTF-8', $charset_slug ) ||
+		0 === strcasecmp( 'UTF8', $charset_slug )
+	);
+}
 if ( ! function_exists( 'mb_substr' ) ) :
 	/**
 	 * Compat function to mimic mb_substr().
 	 *
 	 * @ignore
 	 * @since 3.2.0
 	 *
 	 * @see _mb_substr()
 	 *
-	 * @param string      $str      The string to extract the substring from.
+	 * @param string      $string   The string to extract the substring from.
-	 * @param int         $start    Position to being extraction from in `$str`.
+	 * @param int         $start    Position to being extraction from in `$string`.
-	 * @param int|null    $length   Optional. Maximum number of characters to extract from `$str`.
+	 * @param int|null    $length   Optional. Maximum number of characters to extract from `$string`.
 	 *                              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 ) {
+	function mb_substr( $string, $start, $length = null, $encoding = null ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound
-		return _mb_substr( $str, $start, $length, $encoding );
+		return _mb_substr( $string, $start, $length, $encoding );
 	}
 endif;
 /**
 * Internal compat function to mimic mb_substr().
 *
-* Only understands UTF-8 and 8bit.  All other character sets will be treated as 8bit.
+* 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.
+* For `$encoding === UTF-8`, the `$str` input is expected to be a valid UTF-8 byte
-* The behavior of this function for invalid inputs is undefined.
+* 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.
 	/*
 	 * The solution below works only for UTF-8, so in case of a different
 	 * charset just use built-in substr().
 	 */
-	if ( ! in_array( $encoding, array( 'utf8', 'utf-8', 'UTF8', 'UTF-8' ), true ) ) {
+	if ( ! _is_utf8_charset( $encoding ) ) {
 		return is_null( $length ) ? substr( $str, $start ) : substr( $str, $start, $length );
 	}
 	if ( _wp_can_use_pcre_u() ) {
 		// Use the regex unicode support to separate the UTF-8 characters into an array.
 		| \xF4[\x80-\x8F][\x80-\xBF]{2}
 	)/x';
 	// Start with 1 element instead of 0 since the first thing we do is pop.
 	$chars = array( '' );
 	do {
 		// We had some string left over from the last round, but we counted it in that last round.
 		array_pop( $chars );
 		/*
 	 * @ignore
 	 * @since 4.2.0
 	 *
 	 * @see _mb_strlen()
 	 *
-	 * @param string      $str      The string to retrieve the character length from.
+	 * @param string      $string   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`.
+	 * @return int String length of `$string`.
 	 */
-	function mb_strlen( $str, $encoding = null ) {
+	function mb_strlen( $string, $encoding = null ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound
-		return _mb_strlen( $str, $encoding );
+		return _mb_strlen( $string, $encoding );
 	}
 endif;
 /**
 * Internal compat function to mimic mb_strlen().
 *
-* Only understands UTF-8 and 8bit.  All other character sets will be treated as 8bit.
+* 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
+* 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
 *
 	/*
 	 * The solution below works only for UTF-8, so in case of a different charset
 	 * just use built-in strlen().
 	 */
-	if ( ! in_array( $encoding, array( 'utf8', 'utf-8', 'UTF8', 'UTF-8' ), true ) ) {
+	if ( ! _is_utf8_charset( $encoding ) ) {
 		return strlen( $str );
 	}
 	if ( _wp_can_use_pcre_u() ) {
 		// Use the regex unicode support to separate the UTF-8 characters into an array.
 		| \xF4[\x80-\x8F][\x80-\xBF]{2}
 	)/x';
 	// Start at 1 instead of 0 since the first thing we do is decrement.
 	$count = 1;
 	do {
 		// We had some string left over from the last round, but we counted it in that last round.
-		$count--;
+		--$count;
 		/*
 		 * Split by UTF-8 character, limit to 1000 characters (last array element will contain
 		 * the rest of the string).
 		 */
 	 * @ignore
 	 * @since 3.2.0
 	 *
 	 * @see _hash_hmac()
 	 *
-	 * @param string $algo       Hash algorithm. Accepts 'md5' or 'sha1'.
+	 * @param string $algo   Hash algorithm. Accepts 'md5' or 'sha1'.
-	 * @param string $data       Data to be hashed.
+	 * @param string $data   Data to be hashed.
-	 * @param string $key        Secret key to use for generating the hash.
+	 * @param string $key    Secret key to use for generating the hash.
-	 * @param bool   $raw_output Optional. Whether to output raw binary data (true),
+	 * @param bool   $binary Optional. Whether to output raw binary data (true),
-	 *                           or lowercase hexits (false). Default false.
+	 *                       or lowercase hexits (false). Default false.
-	 * @return string|false The hash in output determined by `$raw_output`. False if `$algo`
+	 * @return string|false The hash in output determined by `$binary`.
-	 *                      is unknown or invalid.
+	 *                      False if `$algo` is unknown or invalid.
 	 */
-	function hash_hmac( $algo, $data, $key, $raw_output = false ) {
+	function hash_hmac( $algo, $data, $key, $binary = false ) {
-		return _hash_hmac( $algo, $data, $key, $raw_output );
+		return _hash_hmac( $algo, $data, $key, $binary );
 	}
 endif;
 /**
 * Internal compat function to mimic hash_hmac().
 *
 * @ignore
 * @since 3.2.0
 *
-* @param string $algo       Hash algorithm. Accepts 'md5' or 'sha1'.
+* @param string $algo   Hash algorithm. Accepts 'md5' or 'sha1'.
-* @param string $data       Data to be hashed.
+* @param string $data   Data to be hashed.
-* @param string $key        Secret key to use for generating the hash.
+* @param string $key    Secret key to use for generating the hash.
-* @param bool   $raw_output Optional. Whether to output raw binary data (true),
+* @param bool   $binary Optional. Whether to output raw binary data (true),
-*                           or lowercase hexits (false). Default false.
+*                       or lowercase hexits (false). Default false.
-* @return string|false The hash in output determined by `$raw_output`. False if `$algo`
+* @return string|false The hash in output determined by `$binary`.
-*                      is unknown or invalid.
+*                      False if `$algo` is unknown or invalid.
 */
-function _hash_hmac( $algo, $data, $key, $raw_output = false ) {
+function _hash_hmac( $algo, $data, $key, $binary = false ) {
 	$packs = array(
 		'md5'  => 'H32',
 		'sha1' => 'H40',
 	);
 	$ipad = ( substr( $key, 0, 64 ) ^ str_repeat( chr( 0x36 ), 64 ) );
 	$opad = ( substr( $key, 0, 64 ) ^ str_repeat( chr( 0x5C ), 64 ) );
 	$hmac = $algo( $opad . pack( $pack, $algo( $ipad . $data ) ) );
-	if ( $raw_output ) {
+	if ( $binary ) {
 		return pack( $pack, $hmac );
 	}
 	return $hmac;
 }
 if ( ! function_exists( 'hash_equals' ) ) :
 	/**
-	 * Timing attack safe string comparison
+	 * Timing attack safe string comparison.
 	 *
 	 * Compares two strings using the same time whether they're equal or not.
 	 *
 	 * Note: It can leak the length of a string when arguments of differing length are supplied.
 	 *
 	 * I.e. when PHP 7.4.0 becomes the minimum requirement, this polyfill
 	 * can be safely removed.
 	 *
 	 * @since 3.9.2
 	 *
-	 * @param string $a Expected string.
+	 * @param string $known_string Expected string.
-	 * @param string $b Actual, user supplied, string.
+	 * @param string $user_string  Actual, user supplied, string.
 	 * @return bool Whether strings are equal.
 	 */
-	function hash_equals( $a, $b ) {
+	function hash_equals( $known_string, $user_string ) {
-		$a_length = strlen( $a );
+		$known_string_length = strlen( $known_string );
-		if ( strlen( $b ) !== $a_length ) {
+		if ( strlen( $user_string ) !== $known_string_length ) {
 			return false;
 		}
 		$result = 0;
 		// Do not attempt to "optimize" this.
-		for ( $i = 0; $i < $a_length; $i++ ) {
+		for ( $i = 0; $i < $known_string_length; $i++ ) {
-			$result |= ord( $a[ $i ] ) ^ ord( $b[ $i ] );
+			$result |= ord( $known_string[ $i ] ) ^ ord( $user_string[ $i ] );
 		}
 		return 0 === $result;
 	}
 endif;
-// random_int() was introduced in PHP 7.0.
-if ( ! function_exists( 'random_int' ) ) {
-	require ABSPATH . WPINC . '/random_compat/random.php';
-}
 // sodium_crypto_box() was introduced in PHP 7.2.
 if ( ! function_exists( 'sodium_crypto_box' ) ) {
 	require ABSPATH . WPINC . '/sodium_compat/autoload.php';
 }
 	 * Verify that the content of a variable is an array or an object
 	 * implementing the Countable interface.
 	 *
 	 * @since 4.9.6
 	 *
-	 * @param mixed $var The value to check.
+	 * @param mixed $value The value to check.
-	 * @return bool True if `$var` is countable, false otherwise.
+	 * @return bool True if `$value` is countable, false otherwise.
 	 */
-	function is_countable( $var ) {
+	function is_countable( $value ) {
-		return ( is_array( $var )
+		return ( is_array( $value )
-			|| $var instanceof Countable
+			|| $value instanceof Countable
-			|| $var instanceof SimpleXMLElement
+			|| $value instanceof SimpleXMLElement
-			|| $var instanceof ResourceBundle
+			|| $value instanceof ResourceBundle
 		);
-	}
-}
-if ( ! function_exists( 'is_iterable' ) ) {
-	/**
-	 * Polyfill for is_iterable() function added in PHP 7.1.
-	 *
-	 * Verify that the content of a variable is an array or an object
-	 * implementing the Traversable interface.
-	 *
-	 * @since 4.9.6
-	 *
-	 * @param mixed $var The value to check.
-	 * @return bool True if `$var` is iterable, false otherwise.
-	 */
-	function is_iterable( $var ) {
-		return ( is_array( $var ) || $var instanceof Traversable );
 	}
 }
 if ( ! function_exists( 'array_key_first' ) ) {
 	/**
 	 * Get the first key of the given array without affecting
 	 * the internal array pointer.
 	 *
 	 * @since 5.9.0
 	 *
-	 * @param array $arr An array.
+	 * @param array $array An array.
 	 * @return string|int|null The first key of array if the array
 	 *                         is not empty; `null` otherwise.
 	 */
-	function array_key_first( array $arr ) {
+	function array_key_first( array $array ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound
-		foreach ( $arr as $key => $value ) {
+		foreach ( $array as $key => $value ) {
 			return $key;
 		}
 	}
 }
 	 * Get the last key of the given array without affecting the
 	 * internal array pointer.
 	 *
 	 * @since 5.9.0
 	 *
-	 * @param array $arr An array.
+	 * @param array $array An array.
 	 * @return string|int|null The last key of array if the array
 	 *.                        is not empty; `null` otherwise.
 	 */
-	function array_key_last( array $arr ) {
+	function array_key_last( array $array ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.arrayFound
-		if ( empty( $arr ) ) {
+		if ( empty( $array ) ) {
 			return null;
 		}
-		end( $arr );
-		return key( $arr );
+		end( $array );
+		return key( $array );
+	}
+}
+if ( ! function_exists( 'array_is_list' ) ) {
+	/**
+	 * Polyfill for `array_is_list()` function added in PHP 8.1.
+	 *
+	 * Determines if the given array is a list.
+	 *
+	 * An array is considered a list if its keys consist of consecutive numbers from 0 to count($array)-1.
+	 *
+	 * @see https://github.com/symfony/polyfill-php81/tree/main
+	 *
+	 * @since 6.5.0
+	 *
+	 * @param array<mixed> $arr The array being evaluated.
+	 * @return bool True if array is a list, false otherwise.
+	 */
+	function array_is_list( $arr ) {
+		if ( ( array() === $arr ) || ( array_values( $arr ) === $arr ) ) {
+			return true;
+		}
+		$next_key = -1;
+		foreach ( $arr as $k => $v ) {
+			if ( ++$next_key !== $k ) {
+				return false;
+			}
+		}
+		return true;
 	}
 }
 if ( ! function_exists( 'str_contains' ) ) {
 	/**
 	 * contained in haystack.
 	 *
 	 * @since 5.9.0
 	 *
 	 * @param string $haystack The string to search in.
-	 * @param string $needle   The substring to search for in the haystack.
+	 * @param string $needle   The substring to search for in the `$haystack`.
 	 * @return bool True if `$needle` is in `$haystack`, otherwise false.
 	 */
 	function str_contains( $haystack, $needle ) {
-		return ( '' === $needle || false !== strpos( $haystack, $needle ) );
+		if ( '' === $needle ) {
+			return true;
+		}
+		return false !== strpos( $haystack, $needle );
 	}
 }
 if ( ! function_exists( 'str_starts_with' ) ) {
 	/**
 	 */
 	function str_starts_with( $haystack, $needle ) {
 		if ( '' === $needle ) {
 			return true;
 		}
 		return 0 === strpos( $haystack, $needle );
 	}
 }
 if ( ! function_exists( 'str_ends_with' ) ) {
 	 * @param string $haystack The string to search in.
 	 * @param string $needle   The substring to search for in the `$haystack`.
 	 * @return bool True if `$haystack` ends with `$needle`, otherwise false.
 	 */
 	function str_ends_with( $haystack, $needle ) {
-		if ( '' === $haystack && '' !== $needle ) {
+		if ( '' === $haystack ) {
-			return false;
+			return '' === $needle;
 		}
 		$len = strlen( $needle );
-		return 0 === substr_compare( $haystack, $needle, -$len, $len );
-	}
+		return substr( $haystack, -$len, $len ) === $needle;
-}
+	}
+}
-// IMAGETYPE_WEBP constant is only defined in PHP 7.1 or later.
-if ( ! defined( 'IMAGETYPE_WEBP' ) ) {
+// IMAGETYPE_AVIF constant is only defined in PHP 8.x or later.
-	define( 'IMAGETYPE_WEBP', 18 );
+if ( ! defined( 'IMAGETYPE_AVIF' ) ) {
-}
+	define( 'IMAGETYPE_AVIF', 19 );
+}
-// IMG_WEBP constant is only defined in PHP 7.0.10 or later.
-if ( ! defined( 'IMG_WEBP' ) ) {
+// IMG_AVIF constant is only defined in PHP 8.x or later.
-	define( 'IMG_WEBP', IMAGETYPE_WEBP );
+if ( ! defined( 'IMG_AVIF' ) ) {
-}
+	define( 'IMG_AVIF', IMAGETYPE_AVIF );
+}

changeset 21	48c4eec2b7e6
parent 19	3d72ae0968f4
child 22	8c2e4d02f4ef