xml_parser_set_option

    (PHP 4, PHP 5, PHP 7, PHP 8)

    xml_parser_set_option — Set options in an XML parser

    Description

    xml_parser_set_option(XMLParser$parser, int$option, string|int|bool$value): bool

    Sets an option in an XML parser.

    Parameters

    parser

    A reference to the XML parser to set an option in.

    option

    Which option to set. See below.

    The following options are available:

    XML parser options
    Option constantData typeDescription
    XML_OPTION_CASE_FOLDINGbool Controls whether case-folding is enabled for this XML parser. Enabled by default.
    XML_OPTION_SKIP_TAGSTARTinteger Specify how many characters should be skipped in the beginning of a tag name.
    XML_OPTION_SKIP_WHITEbool Whether to skip values consisting of whitespace characters.
    XML_OPTION_TARGET_ENCODINGstring Sets which target encoding to use in this XML parser.By default, it is set to the same as the source encoding used by xml_parser_create(). Supported target encodings are ISO-8859-1, US-ASCII and UTF-8.
    value

    The option's new value.

    Return Values

    Returns true on success or false on failure.

    Errors/Exceptions

    Throws a ValueError when an invalid value is passed to option.

    Prior to PHP 8.0.0, the function returned false when passing an invalid value to option generated a E_WARNING as well as making the function return false.

    Changelog

    VersionDescription
    8.3.0 The value parameter now also accepts booleans. The options XML_OPTION_CASE_FOLDING and XML_OPTION_SKIP_WHITE are now boolean options.
    8.0.0parser expects an XMLParser instance now; previously, a valid xmlresource was expected.
    8.0.0 A ValueError is now thrown if option is invalid.
    To Top