PHP 8.4 UPGRADE NOTES

1. Backward Incompatible Changes

2. New Features

3. Changes in SAPI modules

4. Deprecated Functionality

5. Changed Functions

6. New Functions

7. New Classes and Interfaces

8. Removed Extensions and SAPIs

9. Other Changes to Extensions

10. New Global Constants

11. Changes to INI File Handling

12. Windows Support

13. Other Changes

14. Performance Improvements

========================================

1. Backward Incompatible Changes

========================================

- Core:

. The type of PHP_DEBUG and PHP_ZTS constants changed to bool.

. The name of uploaded files and files created by the tempnam() function are

now 13 bytes longer. Total length is platform-dependent.

. Encountering recursion during comparison now results in a Error exception,

rather than a fatal error.

. Indirect modification of readonly properties within __clone() is no longer

allowed, e.g. $ref = &$this->readonly. This was already forbidden for

readonly initialization, and was an oversight in the "readonly

reinitialization during cloning" implementation.

. The exit (and die) language constructs now behave more like a function.

They can be passed like callables, are affected by the strict_types

declare statement, and now perform the usual type coercions instead of

casting any non-integer value to a string.

As such, passing invalid types to exit/die may now result in a TypeError

being thrown.

RFC: https://wiki.php.net/rfc/exit-as-function

. The E_STRICT constant was deprecated and its corresponding error level was

removed.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#remove_e_strict_error_level_and_deprecate_e_strict_constant

- Extension Class constants are now typed:

. Date

. Intl

. PDO

. Reflection

. SPL

. Sqlite

. XMLReader

- Resource to Object conversions:

Return value checks using is_resource() should be replaced with checks

for `false`, unless specified otherwise.

. DBA:

. dba_open() and dba_popen() will now return Dba\Connection

. ODBC:

. odbc_connect() and odbc_pconnect() will now return Odbc\Connection

. odbc_prepare(), odbc_exec(), and various other functions will now return

Odbc\Result

. SOAP:

. SoapClient::$httpurl is now a Soap\Url object rather than a resource.

Checks using is_resource() (i.e. is_resource($client->httpurl)) should be

replaced with checks for null (i.e. $client->httpurl !== null).

. SoapClient::$sdl is now a Soap\Sdl object rather than a resource.

Checks using is_resource() (i.e. is_resource($client->sdl)) should be

replaced with checks for null (i.e. $client->sdl !== null).

- New warnings and exceptions:

. Curl:

. curl_multi_select throws a ValueError if the timeout argument if it's negative

or greater than PHP_INT_MAX.

. GD:

. imagejpeg/imagewebp/imagepng/imageavif throws an exception if an invalid

quality parameter value is passed. In addition, imageavif will throw an exception

if an invalid speed parameter value is passed.

. imagescale throws an exception if the width/height argument underflows/overflows or

if the mode argument is invalid.

imagefilter with IMG_FILTER_SCATTER throws an exception if the sub/plus arguments

underflows/overflows.

. Gettext:

. bind_textdomain_codeset, textdomain and d(*)gettext functions now throw an exception

if the domain argument is empty.

. Intl:

. resourcebundle_get(), ResourceBundle::get(), and accessing offsets on a

ResourceBundle object now throw:

- TypeError for invalid offset types

- ValueError for an empty string

- ValueError if the integer index does not fit in a signed 32 bit integer

. IntlDateFormatter::__construct() throws a ValueError if the locale is invalid.

. NumberFormatter::__construct() throws a ValueError if the locale is invalid.

. MBString:

. mb_encode_numericentity() and mb_decode_numericentity() now check that

the $map is only composed of integers, if not a ValueError is thrown.

. mb_http_input() now always throws a ValueError if the $type is invalid.

. mb_http_output() now checks that the $encoding parameter does not

contain any null bytes. If it does, a ValueError is now thrown.

. ODBC:

. odbc_fetch_row() now emits a warning when a value less than or equal to 0 is

passed for parameter $row.

. PCNTL:

. The functions pcntl_sigprocmask(), pcntl_sigwaitinfo() and

pcntl_sigtimedwait() now throw:

- A ValueError if the $signals array is empty (except for

pcntl_sigprocmask() if the $mode is SIG_SETMASK).

- A TypeError if a value of the $signals array is not an integer

- A ValueError if a value of the $signals array is not a valid signal number

. The function pcntl_sigprocmask() now throw:

- A ValueError if $mode is not one of SIG_BLOCK, SIG_UNBLOCK, or SIG_SETMASK

. The function pcntl_sigtimedwait() now throw:

- A ValueError if $seconds is less than 0

- A ValueError if $nanoseconds is less than 0 or greater than 1e9

- A ValueError if both $seconds and $nanoseconds are 0

. SimpleXML:

. Calling simplexml_import_dom() with a non-XML object now throws a

TypeError instead of a ValueError.

. Standard:

. round() now validates the value of the $mode parameter and throws a

ValueError for invalid modes. Previously invalid modes would have been

interpreted as PHP_ROUND_HALF_UP.

. The str_getcsv() function now throws ValueErrors when the $separator and

$enclosure arguments are not one byte long, or if the $escape is not one

byte long or the empty string. This aligns the behaviour to be identical

to that of fputcsv() and fgetcsv().

. php_uname() now throws ValueErrors if the $move parameter is invalid.

. The "allowed_classes" option for unserialize() now throws TypeErrors and

ValueErrors if it is not an array of class names.

. XMLReader:

. Passing an invalid character encoding to XMLReader::open() or

XMLReader::XML() now throws a ValueError.

. Passing a string containing null bytes previously emitted a

warning and now throws a ValueError as well.

. XMLWriter:

. Passing a string containing null bytes previously emitted a

warning and now throws a ValueError as well.

. XSL:

. XSLTProcessor::setParameter() will now throw a ValueError when its

arguments contain null bytes. This never actually worked correctly in

the first place, which is why it throws an exception nowadays.

. Calling XSLTProcessor::importStyleSheet() with a non-XML object now

throws a TypeError instead of a ValueError.

. Failure to call a PHP function callback during evaluation now throws

instead of emitting a warning.

RFC: https://wiki.php.net/rfc/improve_callbacks_dom_and_xsl

- DOM:

. Some DOM methods previously returned false or a PHP_ERR DOMException if a new

node could not be allocated. They consistently throw an INVALID_STATE_ERR

DOMException now. This situation is extremely unlikely though and probably

will not affect you. As a result DOMImplementation::createDocument() now has

a tentative return type of DOMDocument instead of DOMDocument|false.

. Previously, DOMXPath objects could be cloned, but resulted in an unusable

object. This is no longer possible, and cloning a DOMXPath object now throws

an error.

. Removed DOMImplementation::getFeature().

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#remove_domimplementationgetfeature_feature_version

- GMP:

. The GMP class is now final and cannot be extended anymore.

RFC: https://wiki.php.net/rfc/gmp-final

- MBString:

. On invalid strings (those with encoding errors), mb_substr() now interprets

character indices in the same manner as most other mbstring functions. This

means that character indices returned by mb_strpos() can be passed to mb_substr().

. For SJIS-Mac (MacJapanese) strings, character indices passed to mb_substr() now

refer to the indices of the Unicode codepoints which are produced when the string

is converted to Unicode. This is significant because around 40 SJIS-Mac characters

convert to a sequence of multiple Unicode codepoints.

- Mysqli:

. The unused and undocumented constant MYSQLI_SET_CHARSET_DIR

has been removed.

. The MYSQLI_STMT_ATTR_PREFETCH_ROWS constant has been removed.

The feature is unavailable with mysqlnd.

. The MYSQLI_CURSOR_TYPE_FOR_UPDATE and MYSQLI_CURSOR_TYPE_SCROLLABLE

constants have been removed. This functionality was never implemented,

neither with mysqlnd nor with libmysql.

. The unused MYSQLI_TYPE_INTERVAL constant, which is currently a stub

and an alias for MYSQLI_TYPE_ENUM, has been removed. There are no

plans to add such data type to MySQL yet, so it's unclear what its value

would finally be.

- MySQLnd:

. The error code reported for MySQL server wait timeouts has been changed from 2006

to 4031 for MySQL server versions 8.0.24 and above.

- Opcache:

. The JIT config defaults changed from opcache.jit=tracing and

opcache.jit_buffer_size=0 to opcache.jit=disable and

opcache.jit_buffer_size=64M, respectively. This does not affect the default

behavior, the JIT is still disabled by default. However, it is now disabled

through the opcache.jit setting, rather than opcache.jit_buffer_size. This

may affect users who previously enabled JIT through opcache.jit_buffer_size

exclusively, without also specifying a JIT mode using opcache.jit. To enable

JIT, set the opcache.jit config value accordingly.

. The maximum value of the opcache.interned_strings_buffer setting on 64bit

architectures is now 32767 (it was previously 4095).

. If JIT is enabled, PHP will now exit with a fatal error on startup in case

of JIT startup initialization issues.

- PCNTL:

. The functions pcntl_sigprocmask(), pcntl_sigwaitinfo() and

pcntl_sigtimedwait() now always return false on failure.

In some case previously it could return the value -1.

- PCRE:

. The bundled pcre2lib has been updated to version 10.44.

As a consequence, this means {,3} is now recognized as a quantifier instead

of as text. Furthermore, the meaning of some character classes in UCP mode

has changed. Consult https://github.com/PCRE2Project/pcre2/blob/master/NEWS

for a full changelog.

- PDO_DBLIB:

. setAttribute, DBLIB_ATTR_STRINGIFY_UNIQUEIDENTIFIER and DBLIB_ATTR_DATETIME_CONVERT

have been changed to set value as a bool.

- PDO_FIREBIRD:

. Since some Firebird C++ APIs are used now, this extension requires a C++

compiler to be built. This also implies that the extension has to be built

against fbclient 3.0 or higher.

. getAttribute, ATTR_AUTOCOMMIT has been changed to get the value as a bool.

- PDO_MYSQL:

. getAttribute, ATTR_AUTOCOMMIT, ATTR_EMULATE_PREPARES, MYSQL_ATTR_DIRECT_QUERY have

been changed to get values as bool.

- PDO_PGSQL:

. The DSN's credentials, when set, are given priority over their PDO

constructor counterparts, being closer to the documentation states.

- SimpleXML:

. Get methods called, or casting to a string on a SimpleXMLElement will no

longer implicitly reset the iterator data, unless explicitly rewound.

For example, casting an element to a string within a foreach loop would

cause an infinite loop because it destroyed the current iterator data.

This is no longer the case as a consequence of the bugfixes for GH-12192,

GH-12208, #55098.

- SOAP:

. SoapClient::$typemap is now an array rather than a resource.

Checks using is_resource() (i.e. is_resource($client->typemap)) should be

replaced with checks for null (i.e. $client->typemap !== null).

. The SOAP extension gained an optional dependency on the session extension.

If you build PHP without the session extension and with --enable-rtld-now,

you will experience errors on startup if you also use the SOAP extension.

To solve this, either don't use rtld-now or load the session extension.

- Standard:

. strcspn() with empty $characters now returns the length of the string instead

of incorrectly stopping at the first NUL character. See GH-12592.

. http_build_query() now correctly handles backed enums.

. stream_bucket_make_writeable() and stream_bucket_new() will now return a

StreamBucket instance instead of an instance of stdClass.

RFC: https://wiki.php.net/rfc/dedicated_stream_bucket

- Tidy:

. Failures in the constructor now throw exceptions rather than emitting

warnings and having a broken object.

- XML:

. The xml_set_*_handler() functions now declare and check for an effective

signature of callable|string|null for the $handler parameters.

Moreover, values of type string that correspond to method names,

of object set with xml_set_object() are now checked to see if the method

exists on the class of the previously passed object.

This means that xml_set_object() must now always be called prior to setting

method names as callables.

Passing an empty string to disable the handler is still allowed,

but deprecated.

========================================

2. New Features

========================================

- Core:

. Added request_parse_body() function that allows parsing RFC1867 (multipart)

requests in non-POST HTTP requests.

RFC: https://wiki.php.net/rfc/rfc1867-non-post

. Getting the debug info for WeakReference will now also output the object

it references, or null if the reference is no longer valid.

. The output of Closure::__debugInfo() now includes the name, file, and line

of the Closure.

. new expressions with constructor arguments are now dereferencable, meaning

they allow chaining method calls, property accesses, etc. without enclosing

the expression in parentheses.

RFC: https://wiki.php.net/rfc/new_without_parentheses

. Added the #[\Deprecated] attribute.

RFC: https://wiki.php.net/rfc/deprecated_attribute

. Implemented property hooks.

RFC: https://wiki.php.net/rfc/property-hooks

. Exiting a namespace now clears seen symbols. This allows using a symbol in a

namespace block, even if a previous namespace block declared a symbol with

the same name.

See Zend/tests/use_function/ns_end_resets_seen_symbols_1.phpt.

. Implemented asymmetric property visibility.

RFC: https://wiki.php.net/rfc/asymmetric-visibility-v2

. Implemented lazy objects.

RFC: https://wiki.php.net/rfc/lazy-objects

- Curl:

. curl_version() returns an additional feature_list value, which is an

associative array of all known Curl features, and whether they are

supported (true) or not (false).

. Added CURL_HTTP_VERSION_3 and CURL_HTTP_VERSION_3ONLY constants (available

since libcurl 7.66 and 7.88) as available options for CURLOPT_HTTP_VERSION.

. Added CURLOPT_PREREQFUNCTION as a Curl option that accepts a callback to

be called after the connection is made, but before the request is sent.

The callback must return either CURL_PREREQFUNC_OK or CURL_PREREQFUNC_ABORT

to allow or abort the request.

. Added CURLOPT_SERVER_RESPONSE_TIMEOUT, which was formerly known as

CURLOPT_FTP_RESPONSE_TIMEOUT. Both constants hold the same value.

. Added CURLOPT_DEBUGFUNCTION support. This Curl option accepts a callable

that gets called during the request lifetime with the CurlHandle object,

an integer containing the debug message type, and a string containing the

debug message. The debug message type is one of CURLINFO_TEXT, CURLINFO_HEADER_IN,

CURLINFO_HEADER_OUT, CURLINFO_DATA_IN, CURLINFO_DATA_OUT, CURLINFO_SSL_DATA_OUT,

CURLINFO_SSL_DATA_IN constants. Once this option is set, CURLINFO_HEADER_OUT

must not be set because it uses the same libcurl functionality.

. curl_getinfo() function now returns "posttransfer_time_us", containing the

number of microseconds from the start until the last byte is sent. When a

redirect is followed, the time from each request is added together. This

value can also be retrieved by passing CURLINFO_POSTTRANSFER_TIME_T to the

curl_getinfo() $option parameter. This requires libcurl 8.10.0 or later.

- DOM:

. Added DOMNode::compareDocumentPosition()

. Added constant DOMNode::DOCUMENT_POSITION_DISCONNECTED.

. Added constant DOMNode::DOCUMENT_POSITION_PRECEDING.

. Added constant DOMNode::DOCUMENT_POSITION_FOLLOWING.

. Added constant DOMNode::DOCUMENT_POSITION_CONTAINS.

. Added constant DOMNode::DOCUMENT_POSITION_CONTAINED_BY.

. Added constant DOMNode::DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC.

. It is now possible to pass any callable to registerPhpFunctions().

RFC: https://wiki.php.net/rfc/improve_callbacks_dom_and_xsl

- FPM:

. Flushing headers without a body will now succeed. See GH-12785.

. Status page has a new field to display a memory peak.

- Intl:

. NumberFormatter::ROUND_HALFODD added to complement existing

NumberFormatter::ROUND_HALFEVEN functionality.

- OpenSSL:

. Added support for Curve25519 + Curve448 based keys. Specifically x25519,

ed25519, x448 and ed448 fields are supported in openssl_pkey_new and

openssl_pkey_get_details as well as openssl_sign and openssl_verify were

extended to support those keys.

. Implement PASSWORD_ARGON2 password hashing.

Requires OpenSSL 3.2 and NTS build.

- PCRE:

. The bundled pcre2lib has been updated to version 10.44.

As a consequence, LoongArch JIT support has been added, spaces

are now allowed between braces in Perl-compatible items, and

variable-length lookbehind assertions are now supported.

. With pcre2lib version 10.44, the maximum length of named capture groups

has changed from 32 to 128.

. Added support for the "r" (PCRE2_EXTRA_CASELESS_RESTRICT) modifier, as well

as the (?r) mode modifier. When enabled along with the case-insensitive

modifier ("i"), the expression locks out mixing of ASCII and non-ASCII

characters.

- PDO:

. Added support for driver-specific subclasses.

RFC: https://wiki.php.net/rfc/pdo_driver_specific_subclasses

This RFC adds subclasses for PDO in order to better support

database-specific functionalities. The new classes are

instantiatable either via calling the PDO::connect() method

or by invoking their constructor directly.

. Added support for driver specific SQL parsers. The default parser supports:

- single and double quoted literals, with doubling as escaping mechanism.

- two-dashes and non-nested C-style comments.

RFC: https://wiki.php.net/rfc/pdo_driver_specific_parsers

- PDO_MYSQL:

. Added custom parser supporting:

- single and double-quoted literals, with doubling and backslash as escaping

mechanism

- backtick literal identifiers and with doubling as escaping mechanism

- two dashes followed by at least 1 whitespace, non-nested C-style comments,

and hash-comments

RFC: https://wiki.php.net/rfc/pdo_driver_specific_parsers

- PDO_PGSQL:

. Added custom parser supporting:

- single and double quoted literals, with doubling as escaping mechanism

- C-style "escape" string literals (E'string')

- dollar-quoted string literals

- two-dashes and C-style comments (non-nested)

- support for "??" as escape sequence for the "?" operator

RFC: https://wiki.php.net/rfc/pdo_driver_specific_parsers

- PDO_SQLITE:

. Added custom parser supporting:

- single, double quoted, and backtick literals, with doubling as escaping mechanism

- square brackets quoting for identifiers

- two-dashes and C-style comments (non-nested)

RFC: https://wiki.php.net/rfc/pdo_driver_specific_parsers

- Phar:

. Added support for the unix timestamp extension for zip archives.

- Readfile:

. Added ability to change .php_history path through PHP_HISTFILE env variable.

- Reflection:

. ReflectionAttribute now contains a $name property to improve the debugging

experience.

. ReflectionClassConstant::__toString() and ReflectionProperty::__toString()

now returns the attached doc comments.

. Multiple methods and constants related to lazy objects were introduced:

- ReflectionClass::newLazyGhost()

- ReflectionClass::newLazyProxy()

- ReflectionClass::resetAsLazyGhost()

- ReflectionClass::resetAsLazyProxy()

- ReflectionClass::isUninitializedLazyObject()

- ReflectionClass::initializeLazyObject()

- ReflectionClass::markLazyObjectAsInitialized()

- ReflectionClass::getLazyInitializer()

- ReflectionProperty::skipLazyInitialization()

- ReflectionProperty::setRawValueWithoutLazyInitialization()

- ReflectionClass::SKIP_INITIALIZATION_ON_SERIALIZE

- ReflectionClass::SKIP_DESTRUCTOR

RFC: https://wiki.php.net/rfc/lazy-objects

- SOAP:

. Added support for clark notation for namespaces in class map.

It is now possible to specify entries in a class map with clark notation

to resolve a type with a specific namespace to a specific class.

For example: '{http://example.com}foo' => 'FooClass'.

. Instances of DateTimeInterface that are passed to xsd:datetime or similar

elements are now serialized as such instead of being serialized as an

empty string.

. Session persistence now works with a shared session module.

- Standard:

. Added a new RoundingMode enum with clearer naming and improved discoverability

compared to the PHP_ROUND_* constants.

RFC: https://wiki.php.net/rfc/correctly_name_the_rounding_mode_and_make_it_an_enum

- XSL:

. It is now possible to use parameters that contain both single and double

quotes.

. It is now possible to pass any callable to registerPhpFunctions().

RFC: https://wiki.php.net/rfc/improve_callbacks_dom_and_xsl

. Added XSLTProcessor::$maxTemplateDepth and XSLTProcessor::$maxTemplateVars

to control the recursion depth of XSL template evaluation.

- Zip:

. Added ZipArchive::ER_TRUNCATED_ZIP added in libzip 1.11

========================================

3. Changes in SAPI modules

========================================

- apache2handler

. Support for EOL Apache 2.0 and 2.2 has been removed. Minimum required Apache

version is now 2.4.

- CLI:

. The builtin server looks for an index file recursively by traversing parent

directories in case the specified file cannot be located. This process was

previously skipped if the path looked like it was referring to a file, i.e.

if the last path component contained a period. In that case, a 404 error was

returned. The behavior has been changed to look for an index file in all

cases.

- FPM:

. /dev/poll events.mechanism setting for Solaris/Illumos had been retired.

========================================

4. Deprecated Functionality

========================================

- Core:

. Implicitly nullable parameter types are now deprecated.

RFC: https://wiki.php.net/rfc/deprecate-implicitly-nullable-types

. Passing E_USER_ERROR to trigger_error() is now deprecated.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_passing_e_user_error_to_trigger_error

. Using "_" as a class name is now deprecated.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_using_a_single_underscore_as_a_class_name

. Raising zero to the power of negative number is deprecated.

RFC: https://wiki.php.net/rfc/raising_zero_to_power_of_negative_number

. The E_STRICT constant was deprecated and its corresponding error level was

removed.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#remove_e_strict_error_level_and_deprecate_e_strict_constant

- Curl:

. The CURLOPT_BINARYTRANSFER constant is deprecated.

- Date:

. Calling DatePeriod::__construct(string $isostr, int $options = 0) is

deprecated. Use DatePeriod::createFromISO8601String() instead.

. Constants SUNFUNCS_RET_TIMESTAMP, SUNFUNCS_RET_STRING, and

SUNFUNCS_RET_DOUBLE are now deprecated, following the deprecation of

the associated date_sunset() and date_sunrise() functions in PHP 8.1.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#constants_sunfuncs_ret_string_sunfuncs_ret_double_sunfuncs_ret_timestamp

- DBA:

. Passing null or false to dba_key_split() is deprecated.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_passing_null_and_false_to_dba_key_split

- DOM:

. Deprecated DOM_PHP_ERR constant.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_dom_php_err_constant

. DOMDocument::$actualEncoding, DOMDocument::config, DOMEntity::$actualEncoding,

DOMEntity::$encoding, DOMEntity::$version have been deprecated.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#formally_deprecate_soft-deprecated_domdocument_and_domentity_properties

- Hash:

. Deprecated passing incorrect data types for options to ext/hash functions.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_passing_incorrect_data_types_for_options_to_exthash_functions

- Intl:

. Calling intlcal_set() as well as calling IntlCalendar::set() with

more than 2 arguments is deprecated. Use either IntlCalendar::setDate()

or IntlCalendar::setDateTime() instead.

. Calling intlgregcal_create_instance() as well as calling

IntlGregorianCalendar::__construct() with more than 2 arguments is

deprecated. Use either IntlGregorianCalendar::createFromDate() or

IntlGregorianCalendar::createFromDateTime() instead.

- LDAP:

. Calling ldap_connect() with more than 2 arguments is deprecated. Use

ldap_connect_wallet() instead.

. Calling ldap_exop() with more than 4 arguments is deprecated. Use

ldap_exop_sync() instead.

- Mysqli:

. The mysqli_ping() function and mysqli::ping() method are now deprecated,

as the reconnect feature was removed in PHP 8.2.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#mysqli_ping_and_mysqliping

. The mysqli_kill() function and mysqli::kill() method are now deprecated.

If this functionality is needed a SQL "KILL" command can be used instead.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_mysqli_kill

. The mysqli_refresh() function and mysqli::refresh() method are now deprecated.

If this functionality is needed a SQL "FLUSH" command can be used instead.

All MYSQLI_REFRESH_* constants have been deprecated as well.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_mysqli_refresh

. Passing explicitly the $mode parameter to mysqli_store_result() has been

deprecated. As the MYSQLI_STORE_RESULT_COPY_DATA constant was only used in

conjunction with this function it has also been deprecated.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_the_second_parameter_to_mysqli_store_result

- PDO_PGSQL:

. Using escaped question marks (??) inside dollar-quoted strings is deprecated.

Since PDO_PGSQL has its own SQL parser with dollar-quoted strings support, it

is no longer necessary to escape question marks inside them.

- PgSQL:

. Calling pg_fetch_result() with 2 arguments is deprecated. Use the

3-parameter signature with a null $row parameter instead.

. Calling pg_field_prtlen() with 2 arguments is deprecated. Use the

3-parameter signature with a null $row parameter instead.

. Calling pg_field_is_null() with 2 arguments is deprecated. Use the

3-parameter signature with a null $row parameter instead.

- Random:

. lcg_value() is deprecated, as the function is broken in multiple ways.

Use \Random\Randomizer::getFloat() instead.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_lcg_value

- Reflection:

. Calling ReflectionMethod::__construct() with 1 argument is deprecated.

Use ReflectionMethod::createFromMethodName() instead.

- Session:

. Calling session_set_save_handler() with more than 2 arguments is

deprecated. Use the 2-parameter signature instead.

. Changing the INI settings session.sid_length and session.sid_bits_per_character

is deprecated. Update the session storage backend to accept 32 character

hexadecimal session IDs and stop changing these two INI settings.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#sessionsid_length_and_sessionsid_bits_per_character

. Changing the INI settings session.use_only_cookies, session.use_trans_sid,

session.trans_sid_tags, session.trans_sid_hosts, and session.referer_check

is deprecated. The SID constant is also deprecated.

RFC: https://wiki.php.net/rfc/deprecate-get-post-sessions

- SOAP:

. Passing an int to SoapServer::addFunction() is now deprecated.

If all PHP functions need to be provided flatten the array returned by

get_defined_functions().

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_soap_functions_all_constant_and_passing_it_to_soapserveraddfunction

. The SOAP_FUNCTIONS_ALL constant is now deprecated.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_soap_functions_all_constant_and_passing_it_to_soapserveraddfunction

- SPL:

. The SplFixedArray::__wakeup() method has been deprecated as it implements

__serialize() and __unserialize() which need to be overwritten instead.

. Using the default value for $escape parameter of:

- SplFileObject::setCsvControl()

- SplFileObject::fputcsv()

- SplFileObject::fgetcsv()

is now deprecated. It must be passed explicitly either positionally or via named arguments.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_proprietary_csv_escaping_mechanism

- Standard:

. Calling stream_context_set_option() with 2 arguments is deprecated.

Use stream_context_set_options() instead.

. Unserializing strings using the uppercase 'S' tag is deprecated.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#unserialize_s_s_tag

. Using the default value for $escape parameter of:

- fputcsv()

- fgetcsv()

- str_getcsv()

is now deprecated. It must be passed explicitly either positionally or via named arguments.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#deprecate_proprietary_csv_escaping_mechanism

- XML:

. The xml_set_object() function has been deprecated.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#xml_set_object_and_xml_set_handler_with_string_method_names

. Passing non-callable strings to the xml_set_*_handler() functions is now

deprecated.

RFC: https://wiki.php.net/rfc/deprecations_php_8_4#xml_set_object_and_xml_set_handler_with_string_method_names

========================================

5. Changed Functions

========================================

- Core:

. trigger_error() and user_error() now have a return type of true instead of

bool.

- DOM:

. DOMDocument::registerNodeClass() now has a tentative return type of true.

Previously, the return type was bool but only true could be returned in practice.

- Hash:

. Changed the return type of hash_update() to true. It was already the case that only

true could be returned, but the stub was not updated yet.

- Intl:

. NumberFormatter::ROUND_TOWARD_ZERO and NumberFormatter::ROUND_AWAY_FROM_ZERO

have been added as aliases for NumberFormatter::ROUND_DOWN and

NumberFormatter::ROUND_UP to be consistent with the new PHP_ROUND_* modes.

RFC: https://wiki.php.net/rfc/new_rounding_modes_to_round_function

. ResourceBundle::get() now has a tentative return type of:

ResourceBundle|array|string|int|null

. The idn_to_ascii() and idn_to_utf8() now always throw ValueErrors if the

$domain name is empty or too long, and if $variant is not

INTL_IDNA_VARIANT_UTS46.

- LibXML:

. libxml_set_streams_context() now immediately throws a TypeError when a

non-stream-context resource is passed to the function, instead of throwing

later when the stream context is used.

- MBString:

. The behavior of mb_strcut is more consistent now on invalid UTF-8 and UTF-16

strings. (For valid UTF-8 and UTF-16 strings, there is no change.)

- ODBC:

. Parameter $row of odbc_fetch_object(), odbc_fetch_array(), and

odbc_fetch_into() now has a default value of null, consistent with

odbc_fetch_row(). Previously, the default values were -1, -1, and 0,

respectively.

- OpenSSL:

. The extra_attributes parameter in openssl_csr_new sets CSR attributes

instead of subject DN which was incorrectly done previously.

. The dn parameter in openssl_csr_new allows setting array of values for

a single entry.

. New serial_hex parameter added to openssl_csr_sign to allow setting serial

number in the hexadecimal format.

. Parsing ASN.1 UTCTime by openssl_x509_parse fails if seconds are omitted

for OpenSSL version below 3.2 (-1 is returned for such fields). The

OpenSSL version 3.3+ does not load such certificates already.

- Output:

. Output handler status flags passed to the flags parameter of ob_start

are now cleared.

- PDO:

. getAttribute, enabled to get the value of ATTR_STRINGIFY_FETCHES.

- PDO_FIREBIRD:

. getAttribute, enabled to get values of FB_ATTR_DATE_FORMAT, FB_ATTR_TIME_FORMAT,

FB_ATTR_TIMESTAMP_FORMAT.

. Added new attributes to specify transaction isolation level and access mode.

Along with these, five constants (Pdo\Firebird::TRANSACTION_ISOLATION_LEVEL,

Pdo\Firebird::READ_COMMITTED, Pdo\Firebird::REPEATABLE_READ,

Pdo\Firebird::SERIALIZABLE, Pdo\Firebird::WRITABLE_TRANSACTION) have been added.

. When using persistent connections, there is now a liveness check in the

constructor.

. The content that is built changes depending on the value of FB_API_VER in

ibase.h, so added static method Pdo\Firebird::getApiVersion() to obtain that

value. This value can also be referenced from phpinfo.

. Five new data types are now available: INT128, DEC16, DEC34, TIMESTAMP_TZ, TIME_TZ.

These are available starting with Firebird 4.0.

- PDO_MYSQL:

. getAttribute, enabled to get the value of ATTR_FETCH_TABLE_NAMES.

- PDO_PGSQL:

. getAttribute() can now retrieve the memory usage of query results.

PDO::PGSQL_ATTR_RESULT_MEMORY_SIZE was added for this feature.

. If the column is of FLOAT4OID/FLOAT8OID type, query returns it as a

float instead of a string.

- PGSQL:

. pg_select, the conditions arguments accepts an empty array and is optional.

- Phar:

. Phar::setAlias() and Phar::setDefaultStub() methods now have a tentative

return type of true instead of bool.

- POSIX:

. posix_isatty now sets the error number when the file descriptor/stream argument

is invalid.

- Reflection:

. ReflectionGenerator::getFunction() may now be called after the generator

finished executing.

- Sockets:

. Parameter $backlog of socket_create_listen() now has a default value of SOMAXCONN.

Previously, it was 128.

- SPL:

. SplPriorityQueue::insert() and SplPriorityQueue::recoverFromCorruption()

now has a tentative return type of true

. SplHeap::insert() and SplHeap::recoverFromCorruption()

now has a tentative return type of true instead of bool

- Standard:

. The internal implementation for rounding to integers has been rewritten

to be easier to verify for correctness and to be easier to maintain.

Some rounding bugs have been fixed as a result of the rewrite. For

example previously rounding 0.49999999999999994 to the nearest integer

would have resulted in 1.0 instead of the correct result 0.0. Additional

inputs might also be affected and result in different outputs compared to

earlier PHP versions.

. The $mode parameter of the round() function has been widened to RoundingMode|int,

accepting instances of a new RoundingMode enum.

RFC: https://wiki.php.net/rfc/correctly_name_the_rounding_mode_and_make_it_an_enum

. Four new modes have been added to the round() function: RoundingMode::PositiveInfinity,

RoundingMode::NegativeInfinity, RoundingMode::TowardsZero, RoundingMode::AwayFromZero.

RFC: https://wiki.php.net/rfc/new_rounding_modes_to_round_function

. Fixed a bug caused by "pre-rounding" of the round() function. Previously, using

"pre-rounding" to treat a value like 0.285 (actually 0.28499999999999998) as a

decimal number and round it to 0.29. However, "pre-rounding" incorrectly rounds

certain numbers, so this fix removes "pre-rounding" and changes the way numbers

are compared, so that the values are correctly rounded as decimal numbers.

. The maximum precision that can be handled by round() has been extended by one

digit. For example, `round(4503599627370495.5)` returned in `4503599627370495.5`,

but now returns `4503599627370496`.

. The default value of the 'cost' option for PASSWORD_BCRYPT for password_hash()

has been increased from '10' to '12'.

RFC: https://wiki.php.net/rfc/bcrypt_cost_2023

. debug_zval_dump() now indicates whether an array is packed.

. long2ip() now returns string instead of string|false.

. output_add_rewrite_var() now uses url_rewriter.hosts instead of

session.trans_sid_hosts for selecting hosts that will be rewritten.

. highlight_string() now has a return type of string|true instead of string|bool.

. print_r() now has a return type of string|true instead of string|bool.

========================================

6. New Functions

========================================

- Core:

. request_parse_body()

- BCMath:

. Added bcfloor(), bcceil(), bcround().

RFC: https://wiki.php.net/rfc/adding_bcround_bcfloor_bcceil_to_bcmath

. Added bcdivmod().

RFC: https://wiki.php.net/rfc/add_bcdivmod_to_bcmath

- Date:

. Added static methods

DateTime[Immutable]::createFromTimestamp(int|float $timestamp): static.

. Added method DateTime[Immutable]::getMicrosecond(): int.

. Added method

DateTime[Immutable]::setMicrosecond(int $microsecond): static.

- DOM:

. Added DOMNode::compareDocumentPosition().

. Added DOMXPath::registerPhpFunctionNS().

RFC: https://wiki.php.net/rfc/improve_callbacks_dom_and_xsl

. Added DOMXPath::quote() to quote a string for use in an XPath expression.

Example usage: "//span[contains(text()," . $xpath->quote($string) . ")]"

- Hash:

. Added HashContext::__debugInfo().

- Intl:

. Added IntlTimeZone::getIanaID()/intltz_get_iana_id() to

the IANA identifier from a given timezone.

. Added grapheme_str_split which allow to support emoji and Variation

Selectors.

RFC: https://wiki.php.net/rfc/grapheme_str_split

. Added IntlDateFormatter::parseToCalendar which behaves like

IntlDateFormatter::parse except the time zone is updated.

. Added SpoofChecker::setAllowedChars to limit the range of unicode

chars.

- MBString:

. Added mb_trim, mb_ltrim and mb_rtrim functions.

RFC: https://wiki.php.net/rfc/mb_trim

Note: this was amended by GH-13820 to fix GH-13815.

. Added mb_ucfirst and mb_lcfirst functions.

RFC: https://wiki.php.net/rfc/mb_ucfirst

- OPCache:

. Added opcache_jit_blacklist function. It allows skipping the tracing JIT

execution of select functions.

- PCNTL:

. Added pcntl_setns allowing a process to be reassociated with a namespace in order

to share resources with other processes within this context.

. Added pcntl_getcpuaffinity to get the cpu(s) bound to a process and

pcntl_setcpuaffinity to bind 1 or more cpus to a process.

. Added pcntl_getcpu to get the cpu id from where the current process runs.

. Added pcntl_getqos_class to get the QoS level (aka performance and related

energy consumption) of the current process and pcntl_setqos_class to set it.

. Added pcntl_waitid to obtain status information pertaining to termination, stop,

and/or continue events in one of the caller's child processes.

- PDO_PGSQL:

. Added Pdo\Pgsql::setNoticeCallback() to allow a callback to be triggered on

every notice sent (e.g. RAISE NOTICE).

- PGSQL:

. Added pg_change_password to alter a given user's password. It handles

transparently the password encryption from the database settings.

. Added pg_put_copy_data to send COPY commands and pg_put_copy_end to send

end-of-data to the server.

. Added pg_socket_poll to check if there is any read and/or write events

with an optional timeout.

. Added pg_jit to get informations on the server JIT support.

. Added pg_set_chunked_rows_size to allow to fetch results in chunk of

max N rows.

. Added pg_result_memory_size to get the visibility the memory used by a query result.

- Reflection:

. Multiple methods related to lazy objects were introduced:

- ReflectionClass::newLazyGhost()

- ReflectionClass::newLazyProxy()

- ReflectionClass::resetAsLazyGhost()

- ReflectionClass::resetAsLazyProxy()

- ReflectionClass::isUninitializedLazyObject()

- ReflectionClass::initializeLazyObject()

- ReflectionClass::markLazyObjectAsInitialized()

- ReflectionClass::getLazyInitializer()

- ReflectionProperty::skipLazyInitialization()

- ReflectionProperty::setRawValueWithoutLazyInitialization()

RFC: https://wiki.php.net/rfc/lazy-objects

. ReflectionClassConstant::isDeprecated() was introduced.

. ReflectionGenerator::isClosed() was introduced.

. ReflectionProperty::isDynamic() was introduced.

- Sodium:

. Added the sodium_crypto_aead_aegis128l_*() and sodium_crypto_aead_aegis256l_*()

functions to support the AEGIS family of authenticated encryption algorithms,

that was introduced in libsodium 1.0.19.

. sodium_crypto_aead_aes256gcm_*() functions are now enabled on aarch64 CPUs

with the ARM cryptographic extensions.

- SPL:

. Added seek() method to SplObjectStorage, now it implements

SeekableIterator.

- SOAP:

. Added SoapServer::__getLastResponse(). This only tracks the last response

if the trace option is set to true in the SoapServer constructor's $options

argument.

- Standard:

. Added the http_get_last_response_headers() and

http_clear_last_response_headers() that allows retrieving the same content

as the magic $http_response_header variable.

RFC: https://wiki.php.net/rfc/http-last-response-headers

. Added function fpow() following rules of IEEE 754.

RFC: https://wiki.php.net/rfc/raising_zero_to_power_of_negative_number

. Added functions array_find(), array_find_key(), array_all(), and

array_any().

RFC: https://wiki.php.net/rfc/array_find

- Tidy:

. Added tidyNode::getNextSibling() and tidyNode::getPreviousSibling().

- XMLReader:

. Added XMLReader::fromStream(), XMLReader::fromUri(), XMLReader::fromString().

RFC: https://wiki.php.net/rfc/xmlreader_writer_streams

- XMLWriter:

. Added XMLWriter::toStream(), XMLWriter::toUri(), XMLWriter::toMemory().

RFC: https://wiki.php.net/rfc/xmlreader_writer_streams

- XSL:

. Added XSLTProcessor::registerPhpFunctionNS().

RFC: https://wiki.php.net/rfc/improve_callbacks_dom_and_xsl

========================================

7. New Classes and Interfaces

========================================

- BCMath:

. Added BcMath\Number class. It is an immutable object, has methods that are

equivalent to existing BCMath calculation functions, and can also be calculated

using operators.

The existing BCMath function returned a string for each calculation, but this

class returns an object.

RFC: https://wiki.php.net/rfc/support_object_type_in_bcmath,

https://wiki.php.net/rfc/fix_up_bcmath_number_class

- Core:

. RequestParseBodyException.

RFC: https://wiki.php.net/rfc/rfc1867-non-post

. #[\Deprecated] attribute.

RFC: https://wiki.php.net/rfc/deprecated_attribute

- DBA:

. Dba\Connection opaque object replacing DBA resources

- DOM:

. Implemented DOM HTML5 parsing and serialization.

RFC: https://wiki.php.net/rfc/domdocument_html5_parser.

This RFC adds the new Dom namespace along with new classes and

constant aliases.

There are two new classes to handle HTML and XML documents:

Dom\HTMLDocument and Dom\XMLDocument.

These classes provide a cleaner API to handle HTML and XML documents.

Furthermore, the Dom\HTMLDocument class implements spec-compliant HTML5

parsing and serialization.

. Implemented opt-in ext/dom spec compliance RFC.

This adds new classes in the DOM namespace that correspond to modern

equivalents to the old DOM classes in the global namespaces.

The new classes follow the DOM living spec.

RFC: https://wiki.php.net/rfc/opt_in_dom_spec_compliance

. Implemented "New ext-dom features in PHP 8.4" RFC.

RFC: https://wiki.php.net/rfc/dom_additions_84

- ODBC:

. Odbc\Connection

. Odbc\Result

- PDO_DBLIB:

. Pdo\DbLib.

- PDO_FIREBIRD:

. Pdo\Firebird.

- PDO_MYSQL:

. Pdo\Mysql.

- PDO_ODBC:

. Pdo\Odbc.

- PDO_PGSQL:

. Pdo\Pgsql.

- PDO_SQLITE:

. Pdo\Sqlite.

- Reflection:

. ReflectionConstant

- SOAP:

. Soap\Url

. Soap\Sdl

- Standard:

. StreamBucket

========================================

8. Removed Extensions and SAPIs

========================================

- IMAP:

. The IMAP extension has been unbundled and moved to PECL.

RFC: https://wiki.php.net/rfc/unbundle_imap_pspell_oci8

- OCI8:

. The OCI8 extension has been unbundled and moved to PECL.

RFC: https://wiki.php.net/rfc/unbundle_imap_pspell_oci8

- PDO_OCI:

. The PDO_OCI extension has been unbundled and moved to PECL.

RFC: https://wiki.php.net/rfc/unbundle_imap_pspell_oci8

- PSpell:

. The pspell extension has been unbundled and moved to PECL.

RFC: https://wiki.php.net/rfc/unbundle_imap_pspell_oci8

========================================

9. Other Changes to Extensions

========================================

- Curl:

. The Curl extension now requires at least libcurl 7.61.0.

. The CURLOPT_DNS_USE_GLOBAL_CACHE Curl option no longer has any

effect, and is silently ignored. This underlying feature was

deprecated in libcurl 7.11.1 and removed in 7.62.0.

- GMP:

. Casting a GMP object to bool is now possible instead of emitting a