Joomla! Documentation™

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

JString::substr

Description

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

public static function 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 on line 95 of libraries/joomla/utilities/string.php
• Referenced by
  • JHtmlString::abridge
  • JHtmlList::genericordering
  • JHtmlString::truncate

See also

• JString::substr source code on BitBucket
• Class JString
• Subpackage Utilities
• Other versions of JString::substr

User contributed notes

<CodeExamplesForm />