archived-doc-en/reference/libxml/functions/libxml-disable-entity-loader.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.libxml-disable-entity-loader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>libxml_disable_entity_loader</refname>
  <refpurpose>Disable the ability to load external entities</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
   &warn.deprecated.function-8-0-0;
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier role="attribute">#[\Deprecated]</modifier>
   <type>bool</type><methodname>libxml_disable_entity_loader</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>disable</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Disable/enable the ability to load external entities.
   Note that disabling the loading of external entities may cause general issues
   with loading XML documents.
  </para>
  <para>
   As of libxml 2.9.0 entity substitution
   is disabled by default, so there is no need to disable the loading of external
   entities,
   unless there is the need to resolve internal entity references with <constant>LIBXML_NOENT</constant>,
   <constant>LIBXML_DTDVALID</constant>, or <constant>LIBXML_DTDLOAD</constant>.
   Generally, it is preferable to use <function>libxml_set_external_entity_loader</function>
   to suppress loading of external entities.
   The <constant>LIBXML_NO_XXE</constant> constant can be used to prevent this as well (only available in Libxml &gt;= 2.13.0, as of PHP 8.4.0).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>disable</parameter></term>
     <listitem>
      <para>
       Disable (&true;) or enable (&false;) libxml extensions (such as
       <xref linkend="book.dom" />, <xref linkend="book.xmlwriter" />
       and <xref linkend="book.xmlreader" />) to load external entities.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the previous value.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       This function has been deprecated.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

<!--
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   When does this function issue E_* level errors, and/or throw exceptions.
  </para>
 </refsect1>
-->

<!--
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>libxml_disable_entity_loader</function> example</title>
    <para>
     Any text that describes the purpose of the example, or what
     goes on in the example should be here.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

/* ... */

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
...
]]>
    </screen>
   </example>
  </para>
 </refsect1>
-->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>libxml_use_internal_errors</function></member>
    <member><function>libxml_set_external_entity_loader</function></member>
    <member>The <constant>LIBXML_NOENT</constant> constant</member>
    <member>The <constant>LIBXML_DTDVALID</constant> constant</member>
    <member>The <constant>LIBXML_NO_XXE</constant> constant</member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->