Home/ Manual/ xml / functions/ xml_set_unparsed_entity_decl_handler

xml_set_unparsed_entity_decl_handler

PHP function Edit on GitHub ✎

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

Set up unparsed entity declaration handler

Description

xml_set_unparsed_entity_decl_handler(XMLParser $parser, callable|string|null $handler): true

Sets the unparsed entity declaration handler function for the XML parser parser.

The handler will be called if the XML parser encounters an external entity declaration with an NDATA declaration, like the following:

xml

<!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>}
        NDATA <parameter>notationName</parameter>

See section 4.2.2 of the XML 1.0 spec for the definition of notation declared external entities.

Parameters

handler

Description

The signature of the handler must be:

handler(XMLParser $parser, string $entity_name, string|false $base, string $system_id, string|false $public_id, string|false $notation_name): void

entity_name: The name of the entity that is about to be defined.
base: This is the base for resolving the system identifier (systemId) of the external entity.
system_id: System identifier for the external entity.
public_id: Public identifier for the external entity.
notation_name: Name of the notation of this entity (see xml_set_notation_decl_handler()).

Return Values

Always

Changelog

Version	Description

Source: reference/xml/functions/xml-set-unparsed-entity-decl-handler.xml · from the official PHP manual (php/doc-en)