substr() w PHP: wycinanie fragmentu stringa

substr($string, $offset, $length) zwraca fragment $string, który zaczyna się na pozycji $offset (licząc od 0) i ma $length znaków. substr('Hello world', 0, 5) zwraca "Hello". Pomiń $length, aby dostać wszystko do końca.

<?php
$s = 'Hello world';

echo substr($s, 0, 5), "\n";   // from the start, 5 characters
echo substr($s, 6), "\n";      // from position 6 to the end
echo substr($s, 4, 3), "\n";   // 3 characters from position 4

substr() liczy bajty. W tekście angielskim to to samo co znaki, ale nie w japońskim, chińskim, przy emoji czy literach z akcentami i polskich znakach. Dla nich użyj mb_substr(), pokazanego niżej.

Składnia

substr(string $string, int $offset, ?int $length = null): string

• $offset to miejsce startu. 0 to pierwszy znak. Wartość ujemna liczy od końca.
• $length to liczba bajtów do pobrania (w zwykłym tekście ASCII jeden bajt to jeden znak). Wartość ujemna pomija tyle znaków na końcu. null (albo pominięcie) oznacza „do końca”.

Ujemny offset i długość: praca od końca

Ujemny $offset zaczyna liczyć od końca stringa, więc -1 to ostatni znak. Ujemna $length zatrzymuje się tyle znaków przed końcem.

<?php
$file = 'report-2026.pdf';

echo substr($file, -3), "\n";       // last 3 characters
echo substr($file, -8, 4), "\n";    // 4 characters, starting 8 from the end
echo substr($file, 0, -4), "\n";    // everything except the last 4
echo substr($file, 7, -4), "\n";    // from position 7, minus the last 4

substr($s, 0, -1) to zwykły sposób na usunięcie ostatniego znaku, na przykład przecinka pozostawionego przez pętlę.

Pierwszy lub ostatni znak

Dla pojedynczego bajtu możesz też indeksować string bezpośrednio. $s[0] to pierwszy znak, a od PHP 7.1 $s[-1] to ostatni.

<?php
$word = 'banana';

echo substr($word, 0, 1), ' ', $word[0], "\n";    // first character
echo substr($word, -1), ' ', $word[-1], "\n";     // last character
echo substr($word, 1), "\n";                     // drop the first character

Indeksowanie nieistniejącej pozycji wypisuje ostrzeżenie, a substr() po prostu zwraca pusty string. Jeśli string może być pusty, wybierz substr().

Poza zakresem: pusty string, a nie false

Jeśli $offset jest za końcem stringa, substr() w PHP 8 zwraca "". W PHP 7 zwracało false, więc stary kod sprawdzający === false już nie działa.

<?php
var_dump(substr('abc', 5));       // start past the end
var_dump(substr('abc', 1, 100));  // length longer than the rest is fine
var_dump(substr('abc', -10));     // negative offset before the start: from 0

Tekst japoński: użyj mb_substr

UTF-8 zapisuje kana i popularne kanji na 3 bajtach każde (rzadkie kanji, takie jak 𠮷, i emoji zajmują 4). substr() liczy bajty, więc substr('こんにちは', 0, 3) zwraca tylko こ, a długość, która nie trafia w granicę znaku, przecina znak na pół i daje uszkodzony tekst. mb_substr() przyjmuje te same argumenty i liczy znaki.

<?php
$greeting = 'こんにちは世界';

echo substr($greeting, 0, 3), "\n";       // 3 bytes = 1 character
echo mb_substr($greeting, 0, 3), "\n";    // 3 characters
echo mb_substr($greeting, -2), "\n";      // last 2 characters

// Cutting at 4 bytes splits a character: the result is not valid UTF-8
var_dump(mb_check_encoding(substr($greeting, 0, 4), 'UTF-8'));

To samo dotyczy emoji i liter z akcentami, takich jak é, oraz polskich liter, takich jak ą czy ż. Liczbę znaków podaje mb_strlen(); różnicę między bajtami a znakami opisuje strona strlen().

Skracanie tekstu z wielokropkiem

Przycinanie długiego tytułu do listy lub karty to najczęstsze praktyczne użycie substr(). Użyj mb_substr(), żeby tytuł nigdy nie został przecięty w środku znaku, i dodawaj ... tylko wtedy, gdy faktycznie coś skróciłeś.

<?php
function excerpt(string $text, int $max): string
{
    if (mb_strlen($text) <= $max) {
        return $text;
    }
    return rtrim(mb_substr($text, 0, $max)) . '...';
}

echo excerpt('Short title', 20), "\n";
echo excerpt('A much longer title that will not fit in the card', 20), "\n";
echo excerpt('東京から大阪までの新幹線の旅', 8), "\n";

mb_strimwidth($text, 0, $width, '...') robi to samo według szerokości wyświetlania, w której japoński znak pełnej szerokości liczy się jako 2 kolumny, a litera łacińska jako 1. Pasuje do układów o stałej szerokości.

Liczenie podciągu przez substr_count

substr_count($haystack, $needle) zwraca, ile razy występuje $needle. Rozróżnia wielkość liter i nie liczy nakładających się dopasowań.

<?php
echo substr_count('banana', 'an'), "\n";
echo substr_count('aaaa', 'aa'), "\n";      // 2, not 3: no overlaps
echo substr_count('Hello hello', 'hello'), "\n";
echo substr_count(strtolower('Hello hello'), 'hello'), "\n";

substr ze strpos: tekst przed lub po znaku

Połącz substr() ze strpos(), aby ciąć przy znaku, którego pozycji nie znasz z góry, na przykład przy @ w adresie e-mail:

<?php
$email = 'ada.lovelace@example.com';
$at = strpos($email, '@');

echo substr($email, 0, $at), "\n";    // before the @
echo substr($email, $at + 1), "\n";   // after the @

// strstr does the same in one call
echo strstr($email, '@', true), "\n";

Zanim użyjesz wyniku strpos(), sprawdź, czy nie zwróciło false: jeśli znaku brakuje, false jest traktowane jak 0 bez ostrzeżenia, więc substr('nobody', 0, $at) zwraca "", a substr('nobody', $at + 1) zwraca "obody".