XPath function
substring()
A slice of a string, indexed from 1 — not from 0, which is the mistake that shifts every result by one character.
substring(s, start, length) returns length characters beginning at position start. Positions are one-based: substring('hello', 1, 2) is 'he'.
Omitting length takes everything to the end. Out-of-range positions are handled by clipping rather than by erroring, which is convenient and hides mistakes.
- Syntax
substring(string, start, length?) → string- Returns
- string
- Kind
- Function
- Version
- XPath 1.0 (libxml2)
Worked examples
Each result below is what the evaluator returned, asserted on every test run. An empty result means an empty node-set — which is an answer, not an error.
The sample documents
Every example on this page runs against this document. The sitemap one is namespaced on purpose — almost every real XML document is, and that changes which expressions match.
<?xml version="1.0" encoding="UTF-8"?>
<order id="A-1001" tier="gold">
<customer country="NO">Ada Lovelace</customer>
<lines>
<line sku="WIDGET-1" qty="2"><price>14.50</price></line>
<line sku="WIDGET-2" qty="1"><price>39.00</price></line>
<line sku="GIFT-WRAP" qty="1"><price>0.00</price></line>
</lines>
<note> Deliver after 09:00 </note>
</order>Related
- substring-before()Everything before the first occurrence of a marker — and the empty string when the marker is absent, which is not an error you will notice.
- substring-after()Everything after the first occurrence of a marker. Empty when the marker is absent.
- string-length()The number of characters in a string. With no argument, of the context node.
Get started
Bring order to the XML your team can't afford to ignore.
Create a free account and get a private workspace to search, validate, diff, and monitor your XML feeds, sitemaps, schemas, and vendor integrations.