[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/ -> compat.php (summary)

WordPress implementation for PHP functions either missing from older PHP versions or not included by default.

File Size: 545 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 wp-includes/sodium_compat/autoload.php

Defines 18 functions

  _()
  _wp_can_use_pcre_u()
  _is_utf8_charset()
  mb_substr()
  _mb_substr()
  mb_strlen()
  _mb_strlen()
  is_countable()
  array_key_first()
  array_key_last()
  array_is_list()
  str_contains()
  str_starts_with()
  str_ends_with()
  array_find()
  array_find_key()
  array_any()
  array_all()

Functions
Functions that are not part of a class:

_( $message )   X-Ref
No description

_wp_can_use_pcre_u( $set = null )   X-Ref
Returns whether PCRE/u (PCRE_UTF8 modifier) is available for use.

param: bool $set - Used for testing only

_is_utf8_charset( $charset_slug )   X-Ref
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.

param: string $charset_slug Slug representing a text character encoding, or "charset".
return: bool Whether the slug represents the UTF-8 encoding.

mb_substr( $string, $start, $length = null, $encoding = null )   X-Ref
Compat function to mimic mb_substr().

param: string      $string   The string to extract the substring from.
param: int         $start    Position to being extraction from in `$string`.
param: int|null    $length   Optional. Maximum number of characters to extract from `$string`.
param: string|null $encoding Optional. Character encoding to use. Default null.
return: string Extracted substring.

_mb_substr( $str, $start, $length = null, $encoding = null )   X-Ref
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.

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`.
param: string|null $encoding Optional. Character encoding to use. Default null.
return: string Extracted substring.

mb_strlen( $string, $encoding = null )   X-Ref
Compat function to mimic mb_strlen().

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 `$string`.

_mb_strlen( $str, $encoding = null )   X-Ref
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.

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`.

is_countable( $value )   X-Ref
Polyfill for is_countable() function added in PHP 7.3.

Verify that the content of a variable is an array or an object
implementing the Countable interface.

param: mixed $value The value to check.
return: bool True if `$value` is countable, false otherwise.

array_key_first( array $array )   X-Ref
Polyfill for array_key_first() function added in PHP 7.3.

Get the first key of the given array without affecting
the internal array pointer.

param: array $array An array.
return: string|int|null The first key of array if the array

array_key_last( array $array )   X-Ref
Polyfill for `array_key_last()` function added in PHP 7.3.

Get the last key of the given array without affecting the
internal array pointer.

param: array $array An array.
return: string|int|null The last key of array if the array

array_is_list( $arr )   X-Ref
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.

param: array<mixed> $arr The array being evaluated.
return: bool True if array is a list, false otherwise.

str_contains( $haystack, $needle )   X-Ref
Polyfill for `str_contains()` function added in PHP 8.0.

Performs a case-sensitive check indicating if needle is
contained in haystack.

param: string $haystack The string to search in.
param: string $needle   The substring to search for in the `$haystack`.
return: bool True if `$needle` is in `$haystack`, otherwise false.

str_starts_with( $haystack, $needle )   X-Ref
Polyfill for `str_starts_with()` function added in PHP 8.0.

Performs a case-sensitive check indicating if
the haystack begins with needle.

param: string $haystack The string to search in.
param: string $needle   The substring to search for in the `$haystack`.
return: bool True if `$haystack` starts with `$needle`, otherwise false.

str_ends_with( $haystack, $needle )   X-Ref
Polyfill for `str_ends_with()` function added in PHP 8.0.

Performs a case-sensitive check indicating if
the haystack ends with needle.

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.

array_find( array $array, callable $callback )   X-Ref
Polyfill for `array_find()` function added in PHP 8.4.

Searches an array for the first element that passes a given callback.

param: array    $array    The array to search.
param: callable $callback The callback to run for each element.
return: mixed|null The first element in the array that passes the `$callback`, otherwise null.

array_find_key( array $array, callable $callback )   X-Ref
Polyfill for `array_find_key()` function added in PHP 8.4.

Searches an array for the first key that passes a given callback.

param: array    $array    The array to search.
param: callable $callback The callback to run for each element.
return: int|string|null The first key in the array that passes the `$callback`, otherwise null.

array_any( array $array, callable $callback )   X-Ref
Polyfill for `array_any()` function added in PHP 8.4.

Checks if any element of an array passes a given callback.

param: array    $array    The array to check.
param: callable $callback The callback to run for each element.
return: bool True if any element in the array passes the `$callback`, otherwise false.

array_all( array $array, callable $callback )   X-Ref
Polyfill for `array_all()` function added in PHP 8.4.

Checks if all elements of an array pass a given callback.

param: array    $array    The array to check.
param: callable $callback The callback to run for each element.
return: bool True if all elements in the array pass the `$callback`, otherwise false.



Generated : Sun Mar 9 08:20:01 2025 Cross-referenced by PHPXref