trim() ב-PHP: הסרת רווחים ממחרוזת

trim($string) מחזירה את המחרוזת בלי רווחים לבנים בהתחלה ובסוף: רווחים, טאבים, ירידות שורה, החזרות גררה, בתי NUL וטאבים אנכיים. ltrim() מסירה אותם רק מההתחלה ו-rtrim() רק מהסוף. רווחים באמצע נשמרים.

<?php
$input = "   Ada Lovelace \n";

var_dump(trim($input));
var_dump(ltrim($input));
var_dump(rtrim($input));

הפלט של var_dump() מראה את האורך של כל תוצאה, וזה הופך את התווים שהוסרו לגלויים. trim הוא הדבר הראשון שעושים לרוב הערכים מטופס (סיסמאות הן היוצא מן הכלל, ראו בסוף העמוד): משתמש שמקליד ada@example.com עם רווח בסוף עדיין צריך להצליח להתחבר.

תחביר

trim(string $string, string $characters = " \n\r\t\v\0"): string
ltrim(string $string, string $characters = " \n\r\t\v\0"): string
rtrim(string $string, string $characters = " \n\r\t\v\0"): string

trim() מחזירה מחרוזת חדשה; היא לא משנה את המשתנה שמעבירים לה.

הסרת תווים מסוימים

הארגומנט השני מחליף את רשימת ברירת המחדל. כל תו שבו מוסר מהקצוות, בכל סדר ובכל כמות. .. מגדיר טווח, ולכן 'a..z' פירושו כל אות קטנה.

<?php
echo trim('***Sale***', '*'), "\n";
echo rtrim('red, green, blue, ', ', '), "\n";   // remove the trailing ", "
echo ltrim('000123', '0'), "\n";                // leading zeros
echo trim('/blog/post/', '/'), "\n";
echo trim('abc123xyz', 'a..z'), "\n";           // every lowercase letter

כדי להמשיך להסיר גם רווחים לבנים רגילים, כללו אותם ברשימה: trim($s, " \n\r\t\v\0/").

הארגומנט השני הוא קבוצת תווים, לא מחרוזת

trim() לא מסירה מילה או סיומת. היא מסירה כל אחד מהתווים שרשמתם, משני הקצוות, עד שהיא מגיעה לתו שלא ברשימה. זה מפתיע אנשים שמנסים להסיר סיומת של קובץ:

<?php
// Looks like "remove .php", but removes the characters . p h from both ends
var_dump(trim('hello.php', '.php'));

// Remove a suffix: check it, then cut it off
$file = 'hello.php';
if (str_ends_with($file, '.php')) {
    $file = substr($file, 0, -strlen('.php'));
}
var_dump($file);

השורה הראשונה מסירה גם את ה-h שבהתחלה, כי h נמצא בקבוצה. כדי להסיר קידומת או סיומת קבועה, השתמשו ב-str_starts_with() או ב-str_ends_with() עם substr(), או ב-str_replace() אם הטקסט לא יכול להופיע בשום מקום אחר.

הסרת הרווח ברוחב מלא (קלט ביפנית)

מקלדות יפניות מפיקות לעיתים קרובות את הרווח האידיאוגרפי 　 (U+3000), למשל סביב שם שהוקלד בטופס. הוא לא נמצא ברשימת ברירת המחדל של trim, ורישום שלו בארגומנט השני הוא מלכודת: trim() עובדת בית אחר בית, הרווח הוא 3 הבתים E3 80 80, ו-E3 הוא גם הבית הראשון של כל תו היראגנה וקטקנה, ולכן שם שמתחיל באחד מהם מאבד את הבית הראשון של התו הזה. השתמשו בביטוי רגולרי עם המשנה u:

<?php
$name = '　さとう 花子　 ';

var_dump(trim($name));   // the full-width spaces stay

// Listing the space as a character breaks さ: the result is not valid UTF-8
var_dump(mb_check_encoding(trim($name, '　'), 'UTF-8'));

function mbTrim(string $s): string
{
    return preg_replace('/\A\s+|\s+\z/u', '', $s);
}

var_dump(mbTrim($name));

\A ו-\z מעגנים להתחלה ולסוף של המחרוזת. עם המשנה u, \s מתאים לכל רווח Unicode: הרווחים הלבנים של ASCII, הרווח ברוחב מלא והרווח הבלתי שביר (U+00A0) שהעתקה והדבקה מדפי אינטרנט מביאה לעיתים קרובות. בלי u, \s מתאים רק לרווחים לבנים של ASCII והרווח ברוחב מלא נשאר. PHP 8.4 מוסיפה את mb_trim(), mb_ltrim() ו-mb_rtrim() לשם כך; ב-PHP 8.3 ומטה הביטוי הרגולרי הוא הדרך.

trim לכל ערך במערך

array_map('trim', $array) עושה trim לכל ערך ושומרת על המפתחות. מקרה טיפוסי הוא רשימה מופרדת בפסיקים משדה טקסט, שפוצלה עם explode():

<?php
$tags = explode(',', ' php , mysql,  laravel ,');

$tags = array_map('trim', $tags);
$tags = array_filter($tags, fn($t) => $t !== '');

print_r(array_values($tags));

// An associative array of form fields keeps its keys
$form = ['name' => '  Ada ', 'email' => " ada@example.com\n"];
print_r(array_map('trim', $form));

trim לערך מטופס לפני אימות

עשו trim קודם, ואז בדקו מחרוזת ריקה. שדה שמכיל רק רווחים נדחה אז כריק. הריצו את הבלוק, הקלידו בטופס שם עם רווחים סביבו ולחצו על Send: אותו סקריפט ירוץ שוב כש-$_POST מלא.

<?php
$raw = $_POST['name'] ?? '';
$name = trim($raw);
$error = '';

if (($_SERVER['REQUEST_METHOD'] ?? 'GET') === 'POST' && $name === '') {
    $error = 'Please enter your name.';
}
?>
<form method="post">
  <input name="name" value="<?= htmlspecialchars($raw) ?>">
  <button>Send</button>
</form>
<?php if ($error !== ''): ?>
  <p style="color: #c00"><?= $error ?></p>
<?php elseif ($name !== ''): ?>
  <p>Sent "<?= htmlspecialchars($raw) ?>", saved "<?= htmlspecialchars($name) ?>" (<?= strlen($raw) ?> bytes became <?= strlen($name) ?>)</p>
<?php endif; ?>

אל תעשו trim לסיסמאות: רווח בסוף סיסמה הוא חלק ממנה.