JString/ltrim

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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 replacement for ltrim() Strip whitespace (or other characters) from the beginning of a string Note: you only need to use this if you are supplying the charlist optional arg and it contains UTF-8 characters. Otherwise ltrim will work normally on a UTF-8 string

[<! removed edit link to red link >]

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

Syntax[edit]

ltrim($str, $charlist=FALSE)

Parameter Name	Default Value	Description
$str		the string to be trimmed
$charlist	FALSE	the optional charlist of additional characters to trim

Returns[edit]

string the trimmed string

Defined in[edit]

libraries/joomla/utilities/string.php

Importing[edit]

jimport( 'joomla.utilities.string' );

Source Body[edit]

function ltrim( $str, $charlist = FALSE )
{
        jimport('phputf8.trim');
        if ( $charlist === FALSE ) {
                return utf8_ltrim( $str );
        } else {
                return utf8_ltrim( $str, $charlist );
        }
}

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

Examples[edit]

Code Examples[edit]

API15