readline_add_history()
readline_add_history() — Adds a line to 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 adds a line to the command line history.
Signature
readline_add_history(string $prompt): true
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $prompt | string | The line to be added in the history. |
Return value
Always returns true.
Example
The PHP manual ships no example for readline_add_history(); the signature and the parameter table above are the contract.
Changelog
| Version | Change |
|---|---|
| 8.5.0 | The return type is true now; previously, it was bool. |
All PHP 8.5 built-in functions
Reference card built from the PHP manual page readline_add_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.