readline_clear_history()

readline_clear_history() — Clears 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 clears the entire command line history.

Signature

readline_clear_history(): true

Parameters

This function takes no parameters.

Return value

Always returns true.

Example

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

Changelog

All PHP 8.5 built-in functions

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