HomeMenu
Jesus · Bible · HTML · CSS · JS · PHP · SVG · Applications

sscanf

Description

The sscanf of String for PHP parses input from a string according to a format.

Syntax

sscanf ( string $str , string $format [, mixed &$... ] ) : mixed

Parameters

str

The input string being parsed.

format

The interpreted format for str, which is described in the documentation for sprintf() with following differences:

Function is not locale-aware.

F, g, G and b are not supported.

D stands for decimal number.

i stands for integer with base detection.

n stands for number of characters processed so far.

s stops reading at any whitespace character.

...

Optionally pass in variables by reference that will contain the parsed values.

Return

If only two parameters were passed to this function, the values parsed will be returned as an array. Otherwise, if optional parameters are passed, the function will return the number of assigned values. The optional parameters must be passed by reference. If there are more substrings expected in the format than there are available within str, -1 will be returned.

Examples

1 · str format

<?

$str = "2001-01-01";
$format = "%d-%d-%d";

$return = sscanf($str, $format);

print_r($return);
Array
(
    [0] => 2001
    [1] => 1
    [2] => 1
)

2 · ...

<?

$str = "3491\nArnold Fruchtenbaum";
$format = "%d\n%s %s";

sscanf($str, $format, $id, $first, $last);

echo "<author id=\"$id\">
    <first>$first</first>
    <last>$last</last>
</author>";
<author id="3491">
    <first>Arnold</first>
    <last>Fruchtenbaum</last>
</author>