PHP trim(): remover espaços em branco de uma string

trim($string) retorna a string sem os espaços em branco do início e do fim: espaços, tabulações, quebras de linha, retornos de carro, bytes NUL e tabulações verticais. O ltrim() os remove só do início e o rtrim() só do fim. Os espaços do meio são mantidos.

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

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

A saída do var_dump() mostra o tamanho de cada resultado, o que deixa visíveis os caracteres removidos. Aplicar trim é a primeira coisa a fazer com a maioria dos valores de um formulário (senhas são a exceção, veja o fim da página): um usuário que digita ada@example.com com um espaço no fim ainda deve conseguir entrar.

Sintaxe

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

O trim() retorna uma nova string; ele não altera a variável que você passa.

Remover caracteres específicos

O segundo argumento substitui a lista padrão. Cada caractere dela é removido das pontas, em qualquer ordem e quantas vezes for. .. define um intervalo, então 'a..z' significa todas as letras minúsculas.

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

Para continuar removendo também os espaços normais, inclua-os na lista: trim($s, " \n\r\t\v\0/").

O segundo argumento é um conjunto de caracteres, não uma string

O trim() não remove uma palavra ou um sufixo. Ele remove qualquer um dos caracteres listados, das duas pontas, até encontrar um que não está na lista. Isso surpreende quem tenta tirar a extensão de um arquivo:

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

A primeira linha também remove o h do início, porque h está no conjunto. Para remover um prefixo ou sufixo fixo, use str_starts_with() ou str_ends_with() com substr(), ou str_replace() se o texto não puder aparecer em outro lugar.

Remover o espaço de largura total (entrada em japonês)

Teclados japoneses muitas vezes produzem o espaço ideográfico 　 (U+3000), por exemplo em volta de um nome digitado num formulário. Ele não está na lista padrão do trim, e colocá-lo no segundo argumento é uma armadilha: o trim() trabalha byte a byte, o espaço são os 3 bytes E3 80 80, e E3 também é o primeiro byte de todo caractere hiragana e katakana, então um nome que começa com um deles perde o primeiro byte desse caractere. Use uma expressão regular com o modificador 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 e \z ancoram no início e no fim da string. Com o modificador u, \s bate com todo espaço Unicode: os espaços ASCII, o espaço de largura total e o espaço não separável (U+00A0) que copiar e colar de páginas web costuma trazer. Sem u, \s só bate com espaços ASCII e o espaço de largura total fica. O PHP 8.4 adiciona mb_trim(), mb_ltrim() e mb_rtrim() para isso; no PHP 8.3 e anteriores, a regex é o caminho.

Aplicar trim em cada valor de um array

array_map('trim', $array) aplica trim em cada valor e mantém as chaves. Um caso típico é uma lista separada por vírgulas vinda de um campo de texto, dividida com 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));

Aplicar trim num valor de formulário antes de validar

Primeiro o trim, depois a verificação de string vazia. Um campo que contém só espaços é então rejeitado como vazio. Rode este bloco, digite um nome com espaços em volta no formulário e clique em Send: o mesmo script roda de novo com $_POST preenchido.

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

Não aplique trim em senhas: um espaço no fim de uma senha faz parte dela.