API15: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.

Description

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

<! removed transcluded page call, red link never existed >

Syntax

substr($str, $offset, $length=FALSE)

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

Returns

mixed string or FALSE if failure

Defined in

libraries/joomla/utilities/string.php

Importing

jimport( 'joomla.utilities.string' );

Source Body

function substr($str, $offset, $length = FALSE)
{
        if ( $length === FALSE ) {
                return utf8_substr($str, $offset);
        } else {
                return utf8_substr($str, $offset, $length);
        }
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />