php-doc-en/reference/dom/domdocument/loadhtml.xml
Adam Harvey c538876b79 Update the version the options parameter was added to DOMDocument::loadHTML*().
Fixes doc bug #65436 (Changelog for loadHTML and loadHTMLFile DOMDocument
functions wrong).


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331129 c90b9560-bf6c-de11-be94-00142212c4b1
2013-08-15 01:44:16 +00:00

141 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domdocument.loadhtml" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMDocument::loadHTML</refname>
<refpurpose>
Load HTML from a string
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>DOMDocument::loadHTML</methodname>
<methodparam><type>string</type><parameter>source</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
The function parses the HTML contained in the string <parameter>source</parameter>.
Unlike loading XML, HTML does not have to be well-formed to load. This
function may also be called statically to load and create a
<classname>DOMDocument</classname> object. The static invocation may be
used when no <classname>DOMDocument</classname> properties need to be
set prior to loading.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
The HTML string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Since PHP 5.4.0 and Libxml 2.6.0, you may also use the
<parameter>options</parameter> parameter to specify <link
linkend="libxml.constants">additional Libxml parameters</link>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; If called statically, returns a
<classname>DOMDocument</classname>&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
If an empty string is passed as the <parameter>source</parameter>,
a warning will be generated. This warning is not generated by libxml
and cannot be handled using libxml's error handling functions.
</para>
&dom.allowstatic;
&dom.malformederror;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Creating a Document</title>
<programlisting role="php">
<![CDATA[
<?php
$doc = new DOMDocument();
$doc->loadHTML("<html><body>Test<br></body></html>");
echo $doc->saveHTML();
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.4.0</entry>
<entry>
Added <parameter>options</parameter> parameter.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DOMDocument::loadHTMLFile</methodname></member>
<member><methodname>DOMDocument::saveHTML</methodname></member>
<member><methodname>DOMDocument::saveHTMLFile</methodname></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
-->