rtrim

Strip whitespace (or other characters) from the end of a string

Syntax

rtrim ( string $str [, string $character_mask = " \t\n\r\0\x0B" ] ) : string

Parameters

str

The input string.

character_mask

You can also specify the characters you want to strip, by means of the character_mask parameter. Simply list all characters that you want to be stripped. With .. you can specify a range of characters. Without the character_mask parameter, rtrim() will strip these characters:

"\0"	ASCII 0 (0x00)	NUL-byte
"\t"	ASCII 9 (0x09)	horizontal tab
"\n"	ASCII 10 (0x0A)	new line (line feed)
"\v"	ASCII 11 (0x0B)	vertical tab
"\r"	ASCII 13 (0x0D)	carriage return
" "	ASCII 32 (0x20)	ordinary space

Return

Returns a string with whitespace stripped from the end of str.

Examples

str

<?

$str = "rtrim\0\t\n\v\r \x00\x09\x0A\x0B\x0D\x20";

$return = rtrim($str);

var_dump($str, $return);

?>

string(17) "rtrim    

     

 "
string(5) "rtrim"

character_mask | list

<?

$str = "rtrim\0\t\n\v\r \x00\x09\x0A\x0B\x0D\x20";
$character_mask = "\0\t\n\v\r im";

$return = rtrim($str, $character_mask);

var_dump($str, $return);

?>

string(17) "rtrim    

     

 "
string(3) "rtr"

character_mask | Range

<?

$str = "rtrim\0\t\n\v\r \x00\x09\x0A\x0B\x0D\x20";
$character_mask = "\x00..\x20im";

$return = rtrim($str, $character_mask);

var_dump($str, $return);

?>

string(17) "rtrim    

     

 "
string(3) "rtr"