readline_write_history()

readline_write_history() — Writes the history.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

This function writes the command history to a file.

Signature

readline_write_history(?string $filename = null): bool

Parameters

ParameterTypeWhat it takes
$filename?stringPath to the saved file.

Return value

Returns true on success or false on failure.

Example

The PHP manual ships no example for readline_write_history(); the signature and the parameter table above are the contract.

Changelog

VersionChange
8.0.0filename is nullable now.

All PHP 8.5 built-in functions

Reference card built from the PHP manual page readline_write_history() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.