readline_list_history()

readline_list_history() — Lists 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 is only available if the readline library PHP was built against provides history listing. This is always the case with GNU Readline and on Windows.

Signature

readline_list_history(): array

Parameters

This function takes no parameters.

Return value

Returns an array of the entire command line history. The elements are indexed by integers starting at zero.

Example

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

All PHP 8.5 built-in functions

Reference card built from the PHP manual page readline_list_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.