rtrim
(PHP 4, PHP 5, PHP 7, PHP 8)
rtrim — Strip whitespace (or other characters) from the end of a string
Description
$string
, string $characters
= " \n\r\t\v\x00"): string
This function returns a string with whitespace (or other characters) stripped from the
end of string
.
Without the second parameter, rtrim() will strip these characters:
-
" " (ASCII
32
(0x20
)), an ordinary space. -
"\t" (ASCII
9
(0x09
)), a tab. -
"\n" (ASCII
10
(0x0A
)), a new line (line feed). -
"\r" (ASCII
13
(0x0D
)), a carriage return. -
"\0" (ASCII
0
(0x00
)), theNULL
-byte. -
"\v" (ASCII
11
(0x0B
)), a vertical tab.
Parameters
-
string
-
The input string.
-
characters
-
You can also specify the characters you want to strip, by means of the
characters
parameter. Simply list all characters that you want to be stripped. With..
you can specify a range of characters.
Return Values
Returns the modified string.
Examples
Example #1 Usage example of rtrim()
<?php
$text = "\t\tThese are a few words :) ... ";
$binary = "\x09Example string\x0A";
$hello = "Hello World";
var_dump($text, $binary, $hello);
print "\n";
$trimmed = rtrim($text);
var_dump($trimmed);
$trimmed = rtrim($text, " \t.");
var_dump($trimmed);
$trimmed = rtrim($hello, "Hdle");
var_dump($trimmed);
// trim the ASCII control characters at the end of $binary
// (from 0 to 31 inclusive)
$clean = rtrim($binary, "\x00..\x1F");
var_dump($clean);
?>
The above example will output:
string(32) " These are a few words :) ... " string(16) " Example string " string(11) "Hello World" string(30) " These are a few words :) ..." string(26) " These are a few words :)" string(9) "Hello Wor" string(15) " Example string"