The DOMXPath class

(PHP 5, PHP 7, PHP 8)

Introduction

Supports XPath 1.0

Class synopsis

class DOMXPath {

/* Properties */

public readonly DOMDocument $document;

public bool $registerNodeNamespaces;

/* Methods */

public __construct(DOMDocument $document, bool $registerNodeNS = true)

public evaluate(string $expression, ?DOMNode $contextNode = null, bool $registerNodeNS = true): mixed

public query(string $expression, ?DOMNode $contextNode = null, bool $registerNodeNS = true): mixed

public static quote(string $str): string

public registerNamespace(string $prefix, string $namespace): bool

public registerPhpFunctions(string|array|null $restrict = null): void

}

Properties

document
registerNodeNamespaces: When set to true, namespaces in the node are registered.

Changelog

Version	Description
8.4.0	It is no longer possible to clone a DOMXPath object. Doing so will result in an exception being thrown. Prior to PHP 8.4.0 this resulted in an unusable object.
8.0.0	The `registerNodeNamespaces` property has been added.

DOMXPath::__construct — Creates a new DOMXPath object
DOMXPath::evaluate — Evaluates the given XPath expression and returns a typed result if possible
DOMXPath::query — Evaluates the given XPath expression
DOMXPath::quote — Quotes a string for use in an XPath expression
DOMXPath::registerNamespace — Registers the namespace with the DOMXPath object
DOMXPath::registerPhpFunctions — Register PHP functions as XPath functions

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 5 notes

down

Mark Omohundro, ajamyajax dot com ¶

15 years ago

<?php
// to retrieve selected html data, try these DomXPath examples:

$file = $DOCUMENT_ROOT. "test.html";
$doc = new DOMDocument();
$doc->loadHTMLFile($file);

$xpath = new DOMXpath($doc);

// example 1: for everything with an id
//$elements = $xpath->query("//*[@id]");

// example 2: for node data in a selected id
//$elements = $xpath->query("/html/body/div[@id='yourTagIdHere']");

// example 3: same as above with wildcard
$elements = $xpath->query("*/div[@id='yourTagIdHere']");

if (!is_null($elements)) {
  foreach ($elements as $element) {
    echo "<br/>[". $element->nodeName. "]";

    $nodes = $element->childNodes;
    foreach ($nodes as $node) {
      echo $node->nodeValue. "\n";
    }
  }
}
?>

down

TechNyquist ¶

4 years ago

When working with XML (as a strict format) might be very important to give a namespace to XPath object in order to make it work properly.



I was experiencing "query" always returning empty node lists, it could not find anything. Only a broad "//*" was able to show off only the root element.



Then found out that registering the namespace reported in the "xmlns" attribute of the root element in the XPath object, and writing the namespace near the elements name, made it work properly.



So for an XML like this (from a sitemap):



<?xml version="1.0" encoding="UTF-8"?>

<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">

    <url>

        <loc>http://example.com/index.php</loc>

        <lastmod>2005-01-01</lastmod>

        <changefreq>monthly</changefreq>

        <priority>0.5</priority>

    </url>

</urlset>



I needed the following XPath configuration:



<?php



    $doc = new DOMDocument;

    $doc->load("sitemap.xml");

    $xpath = new DOMXPath($doc);

    $xpath->registerNamespace('ns', 'http://www.sitemaps.org/schemas/sitemap/0.9');

    $nodes = $xpath->query('//ns:urlset/ns:url');



?>



Then again, that "xmlns" could be provided dynamically from the root element attribute of course.

down

peter at softcoded dot com ¶

7 years ago

You may not always know at runtime whether your file has
a namespace or not. This can make it difficult to create
XPath queries. Use the seriously underdocumented
"namespaceURI" property of the documentElement of a
DOMDocument to determine if there is a namespace.
Use code such as the following:

$doc = new DOMDocument();
$doc->load($file);
$xpath = new DOMXPath($doc);
$ns = $doc->documentElement->namespaceURI;
if($ns) {
  $xpath->registerNamespace("ns", $ns);
  $nodes = $xpath->query("//ns:em[@class='glossterm']");
} else {
  $nodes = $xpath->query("//em[@class='glossterm']");
}
//look at nodes here

down

peter at softcoded dot com ¶

7 years ago

Using XPath expressions can save a lot of programming
and allow you to home in on only the nodes you want.
Suppose you want to delete all empty <p> tags.
If you create a query using the following XPath expression,
you can find <p> tags that do not have any text
(other than spaces), any attributes,
any children or comments:

$expression = "//p[not(@*)  
   and not(*) 
   and not(./comment())
   and normalize-space(text())='']";
   
This expression will only find para tags that look like:

<p>[any number of spaces]</p>
<p></p>

Imagine the code you would have to add if you used
DOMDocument::getElementsByTagName("p") instead.

down

-5

archimedix32783262 at mailinator dot com ¶

10 years ago

Note that evaluate() will use the same encoding as the XML document.

So if you have a UTF-16 XML, you will have to query using UTF-16 strings.

You can use iconv() to convert from your code's encoding to the target encoding for better legibility.

＋add a note

The DOMXPath class

Introduction

Class synopsis

Properties

Changelog

Table of Contents

Improve This Page

User Contributed Notes 5 notes