定義と使い方

PHPバージョン
4+

trim()関数は、文字列の両端から空白または引数で指定された文字列を削除します。

この関数は、入力された文字列データの前後にある予期せぬ空白を削除する際によく使用されます。

基本例

PHP 
/* 文字列の両端から空白を削除 */
$string = '   hello world   ';
$trimmed = trim($string);
var_dump($trimmed); // 出力: string(11) "hello world"

/* 引数で指定された文字列を削除 */
$string = 'hello world';
$trimmed = trim($string, 'he');
var_dump($trimmed); // 出力: string(9) "llo world"

/* 注意！日本語のようなマルチバイト文字列には対応していません
   エンコーディングの問題が発生します */
$string = 'こんにちは。';
$trimmed = trim($string, 'こん');
var_dump($trimmed); // 出力: string(12) "にちは。"

構文

PHP 
trim(string $string, string $characters = " \n\r\t\v\x00"): string

引数

trim()関数の引数
$string 必須。削除（trim）する対象となる文字列です。
$characters オプション。削除する文字列です。この値を省略すると、以下の空白文字が削除されます。
  • " ": 空白文字（Space） - キーボードのスペース（Space）キーを押すと入力される文字です。
  • \n: 改行（Newline） - キーボードのエンター（Enter）キーを押した際に行を改める文字を意味します。
  • \r: リターン（Carriage return） - 行（Line）の開始位置にカーソルを移動させる制御文字を指します。これは主にテキストで行を分ける際に使用され、以前はプリンターなどの機械で実際にプリントヘッドを最初の位置に戻すために使用されていました。
  • \t: タブ（Tab） - キーボードのタブ（Tab）キーを押すと入力されるタブを意味します。
  • \v: 垂直タブ（Vertical tab） - 出力装置の垂直タブ位置に移動する制御文字です。
  • \x00: ヌル文字（NUL-byte） - 文字列の終端を示すために使用されます。

trim() 関数は、引数で指定された文字列を削除する際、日本語のようなマルチバイト文字列に対応していないため注意が必要です。

戻り値

文字列の両端から空白または引数で指定された文字列を削除（trim）した文字列を返します。このとき、引数で指定された文字列を削除する際、日本語のようなマルチバイト文字列に対応していないため注意が必要です。

PHP 
/* 注意！日本語のようなマルチバイト文字列をサポートしていません。
   エンコーディング問題が発生します。 */

$string = '歓迎します。';
$trimmed = trim($string, '歓迎');

var_dump($trimmed); 
// 出力: string(10) "��します。"

このような場合、以下のコード例のように preg_replace() 関数などを使用して、マルチバイト文字列に対応することができます。

補足説明
preg_replace() 関数は、文字列内で正規表現を使用して特定のパターンを検索し、別の文字列に置換（交換）する関数です。

PHP 
$original_string = '歓迎します。お会いできて嬉しいです！';
$trim_string = preg_replace('/^歓迎/u', '', $original_string);

var_dump($trim_string); // string(48) "します。お会いできて嬉しいです！"

日本語のようなマルチバイト文字列をサポートしていないという不便さから、trim() 関数は引数で指定した特定の文字列を削除するよりも、主に空白（文字）を削除するために使用されます。

活用例

trim() 関数は、主に提供された文字列の両端にある空白（スペース、タブ、改行など）を事前にフィルタリング（除去）するために使用されます。これは、ユーザーからの入力や外部データを処理する際、文字列を整理し、データの整合性を維持するために頻繁に行われる作業の一つです。

いくつかの実践的な例は次の通りです。

ユーザー入力の処理

PHP 
$username = trim($_POST['username']);
$password = trim($_POST['password']);

ユーザーから受け取った入力から空白を除去することで、ユーザー名やパスワードを処理することができます。

データベースクエリでの使用

PHP 
$input = '   some value   ';
$cleaned_input = trim($input);
$query = "SELECT * FROM table WHERE column = '$cleaned_input'";

データベースクエリを生成する際、入力値に対する前処理として trim()関数を使用することができます。

テキストファイルの処理

PHP 
$lines = file('example.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
$cleaned_lines = array_map(function($line) { return trim($line); }, $lines);

コードの補足説明
array_map() 関数は、各要素に指定されたコールバック関数を適用して、新しい配列を生成するための関数です。

テキストファイルから各行の両端の空白を除去して、配列に保存することができます。各行に trim() 関数を適用することで、$cleaned_lines 配列に保存されます。

参考資料

関連項目