php8.5
Home/ Manual/ libxml / functions/ libxml_set_external_entity_loader

libxml_set_external_entity_loader

PHP function Edit on GitHub ✎

(PHP 5 >= 5.4.0, PHP 7, PHP 8)

Changes the default external entity loader

Description

libxml_set_external_entity_loader(callable|null $resolver_function): true

Changes the default external entity loader. This can be used to suppress the expansion of arbitrary external entities to avoid XXE attacks, even when LIBXML_NOENT has been set for the respective operation, and is usually preferable over calling libxml_disable_entity_loader().

Parameters

resolver_function

A callable with the following signature:

resolver(string|null $public_id, string $system_id, array $context): resource|string|null
public_id

The public ID.

system_id

The system ID.

context

An array with the four elements "directory", "intSubName", "extSubURI" and "extSubSystem".

This callable should return a Resource, a String from which a resource can be opened. If null is returned, the entity reference resolution will fail.

Return Values

Always

Changelog

VersionDescription
8.5.0The return type is true now; previously, it was bool.

Examples

libxml_set_external_entity_loader() example

php
<?php
$xml = <<<XML

<foo>bar</foo>
XML;

$dtd = <<<DTD
<!ELEMENT foo (#PCDATA)>
DTD;

libxml_set_external_entity_loader(
    function ($public, $system, $context) use($dtd) {
        var_dump($public);
        var_dump($system);
        var_dump($context);
        $f = fopen("php://temp", "r+");
        fwrite($f, $dtd);
        rewind($f);
        return $f;
    }
);

$dd = new DOMDocument;
$r  = $dd->loadXML($xml);

var_dump($dd->validate());
?>

The above example will output:

output
string(10) "-//FOO/BAR"
string(25) "http://example.com/foobar"
array(4) {
  ["directory"]=>
  NULL
  ["intSubName"]=>
  NULL
  ["extSubURI"]=>
  NULL
  ["extSubSystem"]=>
  NULL
}
bool(true)

See Also

Source: reference/libxml/functions/libxml-set-external-entity-loader.xml · from the official PHP manual (php/doc-en)