readline

Reads a line

&reftitle.description; ``string``false```readline` ``string``null```prompt`&null;

Reads a single line from the user. You must add this line to the history yourself using `readline_add_history`.

&reftitle.parameters;

`prompt`

- You may specify a string with which to prompt the user.

&reftitle.returnvalues;

Returns a single string from the user. The line returned has the ending newline removed. If there is no more data to read, then &false; is returned.

&reftitle.examples;

### `readline` Example

    <?php
    //get 3 commands from user
    for ($i=0; $i < 3; $i++) {
            $line = readline("Command: ");
            readline_add_history($line);
    }

    //dump history
    print_r(readline_list_history());

    //dump variables
    print_r(readline_info());
    ?>