API17:JString::substr

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

JString::substr

Description

UTF-8 aware alternative to substr Return part of a string given character offset (and optionally length).

Synopsis

public static JString::substr ($str, $offset, $length=FALSE)

Parameter	Type	Default	Description
$str	string
$offset	integer		number of UTF-8 characters offset (from left)
$length	integer	FALSE	(optional) length in UTF-8 characters from offset

Returns

mixed string or FALSE if failure

Defined in

libraries/joomla/utilities/string.php (line 99)

• see source code in BitBucket

Referenced by

• JHtmlString::abridge
• JHtmlList::genericordering
• JHtmlString::truncate

See also

• JString
• Other versions of this method

Examples

<CodeExamplesForm />