xml_get_current_byte_index()
xml_get_current_byte_index() — Get current byte index for an XML parser.
Built-in function of PHP 8.5. The manual lists it as available in PHP 4, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.
Signature
xml_get_current_byte_index(XMLParser $parser): int
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $parser | XMLParser | A reference to the XML parser to get byte index from. |
Return value
Returns which byte index the parser is currently at in its data buffer (starting at 0).
Example
The PHP manual ships no example for xml_get_current_byte_index(); the signature and the parameter table above are the contract.
Changelog
| Version | Change |
|---|---|
| 8.0.0 | parser expects an XMLParser instance now; previously, a valid xml resource was expected. |
See also
xml_get_current_column_number(), xml_get_current_line_number()
All PHP 8.5 built-in functions
Reference card built from the PHP manual page xml_get_current_byte_index() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.