「trim」関数は、
指定された文字を文字列の両端から削除する関数。

「trim」関数には、
似ている兄弟のような関数がある。

・「trim」関数＝指定された文字を文字列の両端から削除する
・「ltrim」関数＝指定された文字を文字列の先頭から削除する
・「rtirm」関数＝指定された文字を文字列の末尾から削除する

「trim」関数の機能をベースに派生した関数で、それぞれ、「先頭」と「末尾」の文字を削除することができるので、
どちらかの文字を削除したい場合は、「ltrim」関数か、「rtirm」関数を使用する。

「trim」「ltrim」「rtirm」関数の書式はほぼ同じ。
文字列の前後にある指定文字を削除するのに使える関数。
第一引数に、検索対象となる文字列（変数）を指定して、
第二引数に削除したい文字を指定する。

INDEX

■ 「trim」関数の書式

「trim」関数の書式

「trim」関数は、
文字列の「先頭」「末尾」にある文字を削除する関数。
「削除したい文字」を指定しない場合は、デフォルトで登録されている「削除対象文字」が削除される。

「trim」関数の基本書式

trim(string $string, string $characters = " \n\r\t\v\0"): string
trim(削除対象の文字列, 削除したい文字: 返り値（削除された文字列）

$SampleText = trim(文字列, "削除したい文字");
$SampleText = trim($変数名, "削除したい文字");
$SampleText = trim("abcdefga", "a");

「trim」関数の「削除文字」を指定しない書式

第二引数の「削除したい文字」を指定しない場合は、
下記のデフォルトで指定されている「削除対象文字」が、文字列の「先頭」「末尾」から削除される。

$SampleText = trim($変数名);

デフォルトの「削除対象文字」

・「半角の空白（全角は対象外)」＝「" " (ASCII 32 (0x20))」
・「\t(水平タブ)」＝「"\t" (ASCII 9 (0x09))」
・「\n(ラインフィード)」＝「"\n" (ASCII 10 (0x0A))」
・「\r(改行)」＝「"\r" (ASCII 13 (0x0D))」
・「null文字」＝「"\0" (ASCII 0 (0x00))」
・「\v(垂直タブ)」＝「"\v" (ASCII 11 (0x0B))」

デフォルトの「削除対象文字」を個別に削除するサンプルコード

デフォルトの「削除対象文字」を個別に削除したい場合は、
個別に指定することで、個別に削除可能になる。

$SampleText = trim(文字列,"")
$SampleText = trim(文字列,"\t")
$SampleText = trim(文字列,"\n")
$SampleText = trim(文字列,"\r")
$SampleText = trim(文字列,"\r\n")
$SampleText = trim(文字列,"null")
$SampleText = trim(文字列,"\x0B")

「trim」関数のパラメータ

パラメータ	説明

string	ホワイトスペースを取り除きたい文字列を指定する。
characters	「characters」パラメータにより、削除する文字を指定することができる。削除したい文字が複数の場合は、全ての文字をリストにして記述する。「..」は、文字の範囲を指定する際に使用可能。 " " = (ASCII 32 (0x20)) = 通常の空白。 "\t" = (ASCII 9 (0x09)) = タブ "\n" = (ASCII 10 (0x0A)) = リターン "\r" = (ASCII 13 (0x0D)) = 改行 "\0" = (ASCII 0 (0x00)) = NULバイト "\v" = (ASCII 11 (0x0B)) = 垂直タブ
戻り値	「trim」関数は、返り値に、「ホワイトスペース」を取り除いた文字列を返す。

Back