PHP 8.4.2 Released!

DOMChildNode »

« DOMCharacterData::replaceWith

DOMCharacterData::substringData

(PHP 5, PHP 7, PHP 8)

DOMCharacterData::substringData — Extracts a range of data from the character data

Description

public DOMCharacterData::substringData(int $offset, int $count): string|false

Returns the specified substring.

Parameters

offset: Start offset of substring to extract.
count: The number of characters to extract.

Return Values

The specified substring. If the sum of offset and count exceeds the length, then all UTF-8 codepoints to the end of the data are returned.

Errors/Exceptions

DOM_INDEX_SIZE_ERR: Raised if offset is negative or greater than the number of UTF-8 codepoints in data, or if count is negative.

See Also

DOMCharacterData::appendData() - Append the string to the end of the character data of the node
DOMCharacterData::deleteData() - Remove a range of characters from the character data
DOMCharacterData::insertData() - Insert a string at the specified UTF-8 codepoint offset
DOMCharacterData::replaceData() - Replace a substring within the character data

Found A Problem?

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

User Contributed Notes

There are no user contributed notes for this page.