DOMCharacterData::replaceData

(PHP 5, PHP 7, PHP 8)

DOMCharacterData::replaceData — Replace a substring within the character data

Description

public DOMCharacterData::replaceData(int $offset, int $count, string $data): bool

Replace count characters starting from position offset with data.

Parameters

offset

The offset from which to start replacing.

count

The number of characters to replace. If the sum of offset and count exceeds the length, then all characters to the end of the data are replaced.

data

The string with which the range must be replaced.

Return Values

Returns true on success or false on failure.

Errors/Exceptions

May throw a DOMException with the following error codes:

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