trim() w PHP: usuwanie białych znaków ze stringa

trim($string) zwraca string z usuniętymi białymi znakami z początku i końca: spacjami, tabulatorami, znakami nowej linii, powrotami karetki, bajtami NUL i tabulatorami pionowymi. ltrim() usuwa je tylko z początku, a rtrim() tylko z końca. Spacje w środku zostają.

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

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

Wynik var_dump() pokazuje długość każdego wyniku, dzięki czemu widać usunięte znaki. Przycinanie to pierwsza rzecz do zrobienia z większością wartości z formularza (wyjątkiem są hasła, zobacz koniec strony): użytkownik, który wpisze ada@example.com ze spacją na końcu, nadal powinien móc się zalogować.

Składnia

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() zwraca nowy string; nie zmienia przekazanej zmiennej.

Usuwanie wybranych znaków

Drugi argument zastępuje domyślną listę. Każdy znak z niej jest usuwany z końców, w dowolnej kolejności i dowolną liczbę razy. .. definiuje zakres, więc 'a..z' oznacza każdą małą literę.

<?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

Aby nadal usuwać też zwykłe białe znaki, dodaj je do listy: trim($s, " \n\r\t\v\0/").

Drugi argument to zbiór znaków, a nie string

trim() nie usuwa słowa ani sufiksu. Usuwa z obu końców dowolne z wymienionych znaków, dopóki nie trafi na znak spoza listy. Zaskakuje to osoby, które próbują usunąć rozszerzenie pliku:

<?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);

Pierwsza linia usuwa też h na początku, bo h jest w zbiorze. Aby usunąć stały prefiks lub sufiks, użyj str_starts_with() albo str_ends_with() z substr(), albo str_replace(), jeśli ten tekst nie może pojawić się nigdzie indziej.

Usuwanie spacji pełnej szerokości (dane z Japonii)

Japońskie klawiatury często wstawiają spację ideograficzną 　 (U+3000), na przykład wokół imienia wpisanego w formularzu. Nie ma jej na domyślnej liście trim, a podanie jej w drugim argumencie to pułapka: trim() działa bajt po bajcie, spacja to 3 bajty E3 80 80, a E3 jest też pierwszym bajtem każdego znaku hiragany i katakany, więc imię zaczynające się od takiego znaku traci jego pierwszy bajt. Użyj wyrażenia regularnego z modyfikatorem 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 i \z kotwiczą początek i koniec stringa. Z modyfikatorem u wzorzec \s pasuje do każdej spacji Unicode: białych znaków ASCII, spacji pełnej szerokości i twardej spacji (U+00A0), którą często przynosi kopiowanie ze stron WWW. Bez u \s pasuje tylko do białych znaków ASCII i spacja pełnej szerokości zostaje. PHP 8.4 dodaje do tego mb_trim(), mb_ltrim() i mb_rtrim(); w PHP 8.3 i starszych sposobem jest wyrażenie regularne.

Przycinanie każdej wartości w tablicy

array_map('trim', $array) przycina każdą wartość i zachowuje klucze. Typowy przypadek to lista rozdzielona przecinkami z pola tekstowego, podzielona przez 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));

Przycięcie wartości z formularza przed walidacją

Najpierw przytnij, potem sprawdź pusty string. Pole zawierające same spacje zostanie wtedy odrzucone jako puste. Uruchom ten blok, wpisz w formularzu imię otoczone spacjami i naciśnij Send: ten sam skrypt uruchomi się ponownie z wypełnionym $_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; ?>

Nie przycinaj haseł: spacja na końcu hasła jest jego częścią.