readline_read_history()
readline_read_history() — Reads 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 reads a command history from a file.
Signature
readline_read_history(?string $filename = null): bool
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $filename | ?string | Path to the filename containing the command history. |
Return value
Returns true on success or false on failure.
Example
The PHP manual ships no example for readline_read_history(); the signature and the parameter table above are the contract.
Changelog
| Version | Change |
|---|---|
| 8.0.0 | filename is nullable now. |
All PHP 8.5 built-in functions
Reference card built from the PHP manual page readline_read_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.