API15

JString/substr

From Joomla! Documentation

< API15:JString

The "API15" 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.

Description[edit]

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

[<! removed edit link to red link >]

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

Syntax[edit]

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[edit]

mixed string or FALSE if failure

Defined in[edit]

libraries/joomla/utilities/string.php

Importing[edit]

jimport( 'joomla.utilities.string' );

Source Body[edit]

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

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples[edit]

Code Examples[edit]