Home > PHP > Function > Readline > readline_completion_function()

readline_completion_function()

readline_completion_function - Registers a completion function

Syntax

bool readline_completion_function (callback $function)

Arguments

  • function - You must supply the name of an existing function which accepts a partial command line and returns an array of possible matches.

Description

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.

Version

PHP 4, 5

Return value

Returns TRUE on success or FALSE on failure.