Actions

API16

JString/substr

< API16:JString

The "API16" 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

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



Syntax

static 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

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



Examples

Code Examples


Advertisement