PHP xml_parser_get_option() Function

In the tutorial, we will discuss how we can use the xml_parser_get_option() function in PHP to get various options from a PHP XML Parser.

PHP xml_parser_get_option() Function

In PHP, an XML parser refers to a tool that allows us to read, manipulate, and extract information from XML files using PHP code. An XML parser takes an XML document as input, then reads and interprets the document's structure and content, and allows us to extract the information as needed.

PHP offers several built-in XML parsers, such as SimpleXML and DOMDocument, enabling us to easily manipulate XML data in a PHP app. These parsers provide a simple and easy-to-use API to work with XML data in PHP, and they handle most of the low-level details of parsing and processing XML documents.

PHP xml_parser_get_option() Function

The following depicts the syntax for the xml_parser_get_option() function.

xml_parser_get_option(XMLParser $parser, int $option): string|int

The function accepts two main parameters:

  1. parser - this refers to a reference to the XML parser from which to get the target option.
  2. option - specifies the option to fetch. Popular options include:
Option Description
XML_OPTION_CASE_FOLDING Set whether to use case-folding for element and attribute names
XML_OPTION_SKIP_TAGSTART Set how many bytes to skip at the start of each element
XML_OPTION_SKIP_WHITE Set whether to skip white space at the start of each element
XML_OPTION_TARGET_ENCODING Set the output encoding for the parser
XML_OPTION_USE_INTERNAL_ERRORS Set whether to use internal XML parser errors or not

The function will return false if the parser does not have the defined parser option.


The following example demonstrates how to use the xml_parser_get_option() function to gather options from a PHP XML parser.

// Initialize the XML parser
$parser = xml_parser_create();

// Set some options
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, false);
xml_parser_set_option($parser, XML_OPTION_SKIP_TAGSTART, 10);
xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, true);
xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
xml_parser_set_option($parser, XML_OPTION_USE_INTERNAL_ERRORS, true);

// Fetch the current option values
$case_folding = xml_get_parser_option($parser, XML_OPTION_CASE_FOLDING);
$skip_tagstart = xml_get_parser_option($parser, XML_OPTION_SKIP_TAGSTART);
$skip_white = xml_get_parser_option($parser, XML_OPTION_SKIP_WHITE);
$target_encoding = xml_get_parser_option($parser, XML_OPTION_TARGET_ENCODING);
$use_internal_errors = xml_get_parser_option($parser, XML_OPTION_USE_INTERNAL_ERRORS);

// Display the option values
echo "XML_OPTION_CASE_FOLDING: " . ($case_folding ? "true" : "false") . "\n";
echo "XML_OPTION_SKIP_TAGSTART: " . $skip_tagstart . "\n";
echo "XML_OPTION_SKIP_WHITE: " . ($skip_white ? "true" : "false") . "\n";
echo "XML_OPTION_TARGET_ENCODING: " . $target_encoding . "\n";
echo "XML_OPTION_USE_INTERNAL_ERRORS: " . ($use_internal_errors ? "true" : "false") . "\n";

// Clean up

The example above creates an XML parser, sets some options using xml_parser_set_option(), fetches the current values of the options using xml_get_parser_option(), and then displays the option values using echo.

Finally, it frees the parser using xml_parser_free().

NOTE: You may need to enable the XML Parser extension on your environment before using this function.


In this post, you learned how you can use the xml_parser_get_option() function to gather information about various XML Parser options.

We hope you enjoyed this post. Check out our other PHP tutorials in the sections below.

Table of Contents
Great! Next, complete checkout for full access to GeekBits.
Welcome back! You've successfully signed in.
You've successfully subscribed to GeekBits.
Success! Your account is fully activated, you now have access to all content.
Success! Your billing info has been updated.
Your billing was not updated.