PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8
sscanf - Parses input from a string according to a format

sscanf( string$string, string$format, ... mixedvars ): array|int|null

The function sscanf is the input analog of printf. sscanf reads from the string string and interprets it according to the specified format.

Any whitespace in the format string matches any whitespace in the input string. This means that even a tab (\t) in the format string can match a single space character in the input string.



The input string being parsed.


The interpreted format for string, 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. * instead of argnum$ suppresses the assignment of this conversion specification.


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

Return Values

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 string, null will be returned.

Related Functions

Example of sscanf

Show all examples for sscanf

PHP Version:

Function sscanf:

Strings Functions

Most used PHP functions