PHP sscanf() Function

The sscanf() function parses input from a string according to a specified format. The sscanf() function parses a string into variables based on the format string.

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

The function sscanf() is the input analog of printf(). sscanf() reads from the string str and interprets it according to the specified format, which is described in the documentation for sprintf().

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.

If only two parameters are passed to this function, the data will be returned as an array. Otherwise, if optional parameters are passed, the data parsed are stored in them. If there are more specifiers than variables to contain them, an error occurs. However, if there are less specifiers than variables, the extra variables contain NULL.

Related functions:

  • printf() - outputs a formatted string
  • sprintf() - writes a formatted string to a variable

Example -

If optional parameters are passed, the function will return the number of assigned values.

Example #2 sscanf() - using optional parameters

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.

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.