readline_completion_function()
readline_completion_function() — Registers a completion function.
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 registers a completion function. This is the same kind of functionality you'd get if you hit your tab key while using Bash.
Signature
readline_completion_function(callable $callback): bool
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $callback | callable | You must supply the name of an existing function which accepts a partial command line and returns an array of possible matches. |
Return value
Returns true on success or false on failure.
Example
The PHP manual ships no example for readline_completion_function(); 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_completion_function() (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.