<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Registers a completion function</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.readline-clear-history.html">readline_clear_history</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.readline-info.html">readline_info</a></div>
<div class="up"><a href="ref.readline.html">Readline Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.readline-completion-function" class="refentry">
<div class="refnamediv">
<h1 class="refname">readline_completion_function</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">readline_completion_function</span> — <span class="dc-title">Registers a completion function</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.readline-completion-function-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>readline_completion_function</strong></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$function</code></span>
)</div>
<p class="para rdfs-comment">
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.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.readline-completion-function-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">function</code></em></span>
<dd>
<p class="para">
You must supply the name of an existing function which accepts a
partial command line and returns an array of possible matches.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.readline-completion-function-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.readline-clear-history.html">readline_clear_history</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.readline-info.html">readline_info</a></div>
<div class="up"><a href="ref.readline.html">Readline Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
