SPATIE
Login Work with us

String functions

All string functions live in the Spatie\Piper\Str namespace. Import them individually or in groups.

use function Spatie\Piper\Str\{prefix, suffix, upper};

Each function takes its subject as the first argument, so it slots naturally into a pipe. The reference below lists every available function in alphabetical order. Click a name to jump straight to its description.

afterisMatchremovesubstrReplace
afterLastisNotEmptyrepeatswap
appendisUlidreplacetake
beforeisUuidreplaceArraytest
beforeLastkebabreplaceEndtitle
betweenlcfirstreplaceFirsttoBase64
betweenFirstlengthreplaceLasttoBoolean
camellimitreplaceMatchestoFloat
charAtlowerreplaceStarttoInteger
containsltrimreversetoString
deduplicatemaskrtrimtrim
endsWithmatchAllscanucfirst
exactlynewLinesnakeunwrap
explodenumberssplitupper
finishpadBothsquishwordCount
fromBase64padLeftstartwordWrap
headlinepadRightstartsWithwords
ispasswordstripTagswrap
isAsciipositionstudly
isEmptyprependsubstr
isJsonrandomsubstrCount

Returns everything after the given value.

'This is my name' |> after('This is'); // ' my name'

Returns everything after the last occurrence of the given value.

'App\\Models\\User' |> afterLast('\\'); // 'User'

Appends the given values to the string.

'Laravel' |> append(' Framework'); // 'Laravel Framework'

Returns everything before the given value.

'This is my name' |> before('my name'); // 'This is '

Returns everything before the last occurrence of the given value.

'App\\Models\\User' |> beforeLast('\\'); // 'App\\Models'

Returns the portion of the string between two values.

'This is my name' |> between('This', 'name'); // ' is my '

Returns the smallest possible portion of the string between two values.

'[first] middle [second]' |> betweenFirst('[', ']'); // 'first'

Converts the string to camelCase.

'foo_bar' |> camel(); // 'fooBar'

Returns the character at the given index.

'Laravel' |> charAt(1); // 'a'

Determines whether the string contains the given value.

'This is my name' |> contains('my'); // true

Replaces consecutive instances of a character with a single instance.

'foo--bar---baz' |> deduplicate('-'); // 'foo-bar-baz'

Determines whether the string ends with the given value.

'Laravel' |> endsWith('vel'); // true

Determines whether the string exactly matches the given value.

'Laravel' |> exactly('Laravel'); // true

Splits the string by the given separator.

'a,b,c' |> explode(','); // ['a', 'b', 'c']

Adds a single instance of the given value to the end of the string.

'this/string' |> finish('/'); // 'this/string/'

Decodes a Base64 encoded string.

'TGFyYXZlbA==' |> fromBase64(); // 'Laravel'

Converts the string to headline case.

'email_notification_sent' |> headline(); // 'Email Notification Sent'

Determines whether the string matches a pattern.

'foo/bar' |> is('foo/*'); // true

Determines whether the string is 7 bit ASCII.

'Laravel' |> isAscii(); // true

Determines whether the string is empty.

'' |> isEmpty(); // true

Determines whether the string is valid JSON.

'{"name":"Taylor"}' |> isJson(); // true

Determines whether the string matches a regular expression.

'Laravel' |> isMatch('/Lara/'); // true

Determines whether the string is not empty.

'Laravel' |> isNotEmpty(); // true

Determines whether the string is a valid ULID.

'01ARZ3NDEKTSV4RRFFQ69G5FAV' |> isUlid(); // true

Determines whether the string is a valid UUID.

'550e8400-e29b-41d4-a716-446655440000' |> isUuid(); // true

Converts the string to kebab-case.

'fooBar' |> kebab(); // 'foo-bar'

Makes the first character of the string lowercase.

'Laravel' |> lcfirst(); // 'laravel'

Returns the length of the string.

'Laravel' |> length(); // 7

Truncates the string to the given length.

'The Laravel framework' |> limit(11); // 'The Laravel...'

Converts the string to lowercase.

'LARAVEL' |> lower(); // 'laravel'

Trims the left side of the string.

'  Laravel' |> ltrim(); // 'Laravel'

Masks a portion of the string with a repeated character.

'taylor@example.com' |> mask('*', 3); // 'tay***************'

Returns all regex matches for the string.

'abc123def456' |> matchAll('/\d+/'); // ['123', '456']

Appends one or more new lines to the string.

'Laravel' |> newLine(2); // "Laravel\n\n"

Removes all non-numeric characters from the string.

'Phone: +1 (555) 123-4567' |> numbers(); // '15551234567'

Pads both sides of the string to the given length.

'Laravel' |> padBoth(11, '-'); // '--Laravel--'

Pads the left side of the string to the given length.

'Laravel' |> padLeft(10, '-'); // '---Laravel'

Pads the right side of the string to the given length.

'Laravel' |> padRight(10, '-'); // 'Laravel---'

Generates a secure random password.

password(12); // random 12-character password

Returns the position of the first occurrence of a substring.

'Laravel' |> position('vel'); // 4

Prepends the given values to the string.

'Framework' |> prepend('Laravel '); // 'Laravel Framework'

Generates a random string of the given length.

random(16); // random 16-character string

Removes the given value from the string.

'Laravel Framework' |> remove(' Framework'); // 'Laravel'

Repeats the string the given number of times.

'ab' |> repeat(3); // 'ababab'

Replaces a given value in the string.

'Laravel 13.x' |> replace('13.x', '14.x'); // 'Laravel 14.x'

Replaces a value in the string sequentially using an array.

'The event is from ? to ?' |> replaceArray('?', ['8:30', '9:00']); // 'The event is from 8:30 to 9:00'

Replaces the last occurrence of a value if it appears at the end of the string.

'Hello World' |> replaceEnd('World', 'Laravel'); // 'Hello Laravel'

Replaces the first occurrence of a value in the string.

'the quick brown fox' |> replaceFirst('the', 'a'); // 'a quick brown fox'

Replaces the last occurrence of a value in the string.

'the quick brown fox jumps over the lazy dog' |> replaceLast('the', 'a'); // 'the quick brown fox jumps over a lazy dog'

Replaces substrings matching a regular expression.

'(+1) 501-555-1000' |> replaceMatches('/[^A-Za-z0-9]++/', ''); // '15015551000'

Replaces the first occurrence of a value if it appears at the start of the string.

'Hello World' |> replaceStart('Hello', 'Laravel'); // 'Laravel World'

Reverses the string.

'Laravel' |> reverse(); // 'levaraL'

Trims the right side of the string.

'Laravel  ' |> rtrim(); // 'Laravel'

Parses input from the string according to a format.

'filename.jpg' |> scan('%[^.].%s'); // ['filename', 'jpg']

Converts the string to snake_case.

'fooBar' |> snake(); // 'foo_bar'

Splits the string using a regular expression.

'a b  c' |> split('/\s+/'); // ['a', 'b', 'c']

Removes extra whitespace from the string.

"  laravel\tphp   framework  " |> squish(); // 'laravel php framework'

Adds a single instance of the given value to the start of the string.

'this/string' |> start('/'); // '/this/string'

Determines whether the string starts with the given value.

'Laravel' |> startsWith('Lar'); // true

Removes HTML and PHP tags from the string.

'<p>Laravel</p>' |> stripTags(); // 'Laravel'

Converts the string to StudlyCase.

'foo bar' |> studly(); // 'FooBar'

Returns the portion of the string specified by start and length.

'Laravel' |> substr(1, 3); // 'ara'

Returns the number of occurrences of a value in the string.

'one two one' |> substrCount('one'); // 2

Replaces text within a portion of the string.

'1300' |> substrReplace(':', 2, 0); // '13:00'

Replaces multiple values in the string using a map.

'framework' |> swap(['frame' => 'pipe', 'work' => 'line']); // 'pipeline'

Returns the first or last characters from the string.

'Laravel' |> take(-3); // 'vel'

Determines whether the string matches a regular expression.

'Laravel' |> test('/Lara/'); // true

Converts the string to title case.

'laravel framework' |> title(); // 'Laravel Framework'

Encodes the string as Base64.

'Laravel' |> toBase64(); // 'TGFyYXZlbA=='

Casts the string to a boolean.

'true' |> toBoolean(); // true

Casts the string to a float.

'12.5' |> toFloat(); // 12.5

Casts the string to an integer.

'42' |> toInteger(); // 42

Returns the string value.

'Laravel' |> toString(); // 'Laravel'

Trims both sides of the string.

'  Laravel  ' |> trim(); // 'Laravel'

Makes the first character of the string uppercase.

'laravel' |> ucfirst(); // 'Laravel'

Removes the given strings from the beginning and end of the string.

'"Laravel"' |> unwrap('"'); // 'Laravel'

Converts the string to uppercase.

'laravel' |> upper(); // 'LARAVEL'

Returns the number of words in the string.

'hello world' |> wordCount(); // 2

Limits the number of words in the string.

'The Laravel framework' |> words(2); // 'The Laravel...'

Wraps the string to the given number of characters.

'The quick brown fox' |> wordWrap(10); // "The quick\nbrown fox"

Wraps the string with the given strings.

'Laravel' |> wrap('"'); // '"Laravel"'
Array functions
Help us improve this page