PHP - trim() Function



The PHP trim() function is used to remove white spaces and other characters from the "beginning" and "end" of the given string.

It accepts an optional second parameter. If this parameter is omitted, it removes the following characters from both ends:

  • " " − an ordinary space.
  • \t − a tab.
  • \n − a new line.
  • \r − a carriage return.
  • \0 − the NUL-type.
  • \v − a vertical tab.

Note: This function only removes leading and trailing white spaces and other specified characters from both ends of the string. It will not affect any white spaces or other characters that are in the middle of the string.

Syntax

Following is the syntax of the PHP trim() function −

trim(string $str, string $charlist = " \n\r\t\v\x00"): string

Parameters

This function accepts two parameters, which are described below −

  • string − The original string from which white spaces and characters will be removed.
  • charlist (optional) − A string or list of characters that you want to remove from the original string (string).

Return Value

This function returns a string with white spaces and other specified characters removed from the beginning and end of the string.

Example 1: Removing white spaces from both ends

The following is the basic example of the PHP trim() function. It removes white spaces from both ends −

<?php
   $str = " Tutorials point "; 
   echo "The given string: '$str'";
   echo "\nThe modified string (after removing white spaces): ";
   echo "'".trim($str)."'";
?>

Output

The above program produces the following output −

The given string: ' Tutorials point '
The modified string (after removing white spaces): 'Tutorials point'

Example 2: Removing other specified characters

Here is another example of using the PHP trim() function. This function is used to remove specified characters "Language" from this string "I Love PHP! Language" −

<?php
   $str = "I Love PHP! Language"; 
   echo "The given string: '$str'";
   $charslist = "Language";
   echo "\nThe other characters need to be removed: '$charslist'";
   echo "\nThe modified string: ";
   echo trim($str, $charslist);
?>

Output

After executing the above program, the following output will be displayed −

The given string: 'I Love PHP! Language'
The other characters need to be removed: 'Language'
The modified string: I Love PHP!

Example 3: Removing both white spaces and other characters

In the example below, we use the PHP trim() function to remove white spaces as well as other characters (i.e., '!') from both ends of the given string " !!!Hello World!!! " −

<?php
   $str = " !!!Hello World!!! ";
   echo "The given string: '$str'";
   $charslist = " !";
   echo "\nThe other characters need to be removed: '$charslist'";
   echo "\nThe modified string: ";
   #using trim() function
   echo "'".trim($str, $charslist)."'";
?>

Output

Following is the output of the above program −

The given string: ' !!!Hello World!!! '
The other characters need to be removed: ' !'
The modified string: 'Hello World'
php_function_reference.htm
Advertisements