PHP 4, PHP 5, PHP 7, PHP 8
xml_set_character_data_handler - Set up character data handler

xml_set_character_data_handler( XMLParser$parser, callable$handler ): bool

Sets the character data handler function for the XML parser parser.



A reference to the XML parser to set up character data handler function.


handler is a string containing the name of a function that must exist when xml_parse is called for parser.

The function named by handler must accept two parameters:

handler( XMLParser$parser, string$data ):

The first parameter, parser, is a reference to the XML parser calling the handler.


The second parameter, data, contains the character data as a string.

Character data handler is called for every piece of a text in the XML document. It can be called multiple times inside each fragment (e.g. for non-ASCII strings).

If a handler function is set to an empty string, or false, the handler in question is disabled.


Instead of a function name, an array containing an object reference and a method name can also be supplied.

Return Values

Returns true on success or false on failure.


Version Description
8.0.0 parser expects an XMLParser instance now; previously, a resource was expected.