JString/rtrim

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 rtrim() Strip whitespace (or other characters) from the end 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 rtrim will work normally on a UTF-8 string

[Edit Descripton]

Template:Description:JString/rtrim

Syntax[edit]

rtrim($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 rtrim( $str, $charlist = FALSE )
{
        jimport('phputf8.trim');
        if ( $charlist === FALSE ) {
                return utf8_rtrim($str);
        } else {
                return utf8_rtrim( $str, $charlist );
        }
}

Examples[edit]

API15