trim( string $str[, string $charlist] )は、文字列「$str」の先頭及び末尾から、ホワイトスペース、もしくは、「$charlist」に指定した文字を、取り除く、組み込み関数。
定義
文字列型 trim( 文字列型 $str[, 文字列型 $charlist] );
パラメータ
- 文字列型 $str
先頭及び末尾から、ホワイトスペース、もしくは、「$charlist」に指定した文字を、取り除く、対象文字列を指定する。
- 文字列型 $charlist
オプション。
取り除きたい文字を、複数指定できる。
初期設定値は、下記のホワイトスペース。
\t: タブ\n: 改行\r: 改行\0: NULL\x0B: 垂直タブ
戻り値
文字列「$str」の先頭及び末尾から、ホワイトスペース、もしくは、「$charlist」に指定した文字を、取り除いた文字列。
構文
先頭及び末尾のホワイトスペースを取り除く
取り除き後文字列 = trim( 対象文字列 );
「対象文字列」の先頭及び末尾のホワイトスペースを取り除く。
先頭及び末尾から、指定文字を取り除く
取り除き後文字列 = trim( 対象文字列, 取り除く文字リスト );
「対象文字列」の先頭及び末尾から、「取り除く文字リスト」にある文字を取り除く。
サンプル
先頭及び末尾のホワイトスペースを取り除く
<pre>
<?php
$input = "\tsample text\t\n";
var_dump( $input );
var_dump( trim( $input ) );
?>
</pre>
<?php
$input = "\tsample text\t\n";
var_dump( $input );
var_dump( trim( $input ) );
?>
</pre>
↓↓↓出力結果↓↓↓
string(14) " sample text
"
string(11) "sample text"
"
string(11) "sample text"
先頭及び末尾から、指定文字「\n」を取り除く
<pre>
<?php
$input = "\tsample text\t\n";
var_dump( $input );
var_dump( trim( $input, "\n" ) );
?>
</pre>
<?php
$input = "\tsample text\t\n";
var_dump( $input );
var_dump( trim( $input, "\n" ) );
?>
</pre>
↓↓↓出力結果↓↓↓
string(14) " sample text
"
string(13) " sample text "
"
string(13) " sample text "
先頭及び末尾から、指定文字「*[] 」を取り除く
<pre>
<?php
$input = "**[ ALPHASIS ]**";
var_dump( $input );
var_dump( trim( $input, "*[] " ) );
?>
</pre>
<?php
$input = "**[ ALPHASIS ]**";
var_dump( $input );
var_dump( trim( $input, "*[] " ) );
?>
</pre>
↓↓↓出力結果↓↓↓
string(16) "**[ ALPHASIS ]**"
string(8) "ALPHASIS"
string(8) "ALPHASIS"
先頭及び末尾から、指定文字「A..N」（A～N）を取り除く
<pre>
<?php
$input = "abcdefghijklmnmlkjihgfedcba";
var_dump( $input );
var_dump( trim( $input, "a..f" ) );
?>
</pre>
<?php
$input = "abcdefghijklmnmlkjihgfedcba";
var_dump( $input );
var_dump( trim( $input, "a..f" ) );
?>
</pre>
↓↓↓出力結果↓↓↓
string(27) "abcdefghijklmnmlkjihgfedcba"
string(15) "ghijklmnmlkjihg"
string(15) "ghijklmnmlkjihg"