Helpers
Introduction
Laravel includes a variety of global "helper" PHP functions. Many of these functions are used by the framework itself; however, you are free to use them in your own applications if you find them convenient.
Available Methods
Arrays & Objects
Arr::accessible Arr::add Arr::collapse Arr::crossJoin Arr::divide Arr::dot Arr::except Arr::exists Arr::first Arr::flatten Arr::forget Arr::get Arr::has Arr::hasAny Arr::isAssoc Arr::isList Arr::join Arr::keyBy Arr::last Arr::map Arr::only Arr::pluck Arr::prepend Arr::prependKeysWith Arr::pull Arr::query Arr::random Arr::set Arr::shuffle Arr::sort Arr::sortDesc Arr::sortRecursive Arr::toCssClasses Arr::undot Arr::where Arr::whereNotNull Arr::wrap data_fill data_get data_set head last
Paths
Strings
__ class_basename e preg_replace_array Str::after Str::afterLast Str::ascii Str::before Str::beforeLast Str::between Str::betweenFirst Str::camel Str::contains Str::containsAll Str::endsWith Str::excerpt Str::finish Str::headline Str::inlineMarkdown Str::is Str::isAscii Str::isJson Str::isUlid Str::isUuid Str::kebab Str::lcfirst Str::length Str::limit Str::lower Str::markdown Str::mask Str::orderedUuid Str::padBoth Str::padLeft Str::padRight Str::plural Str::pluralStudly Str::random Str::remove Str::replace Str::replaceArray Str::replaceFirst Str::replaceLast Str::reverse Str::singular Str::slug Str::snake Str::squish Str::start Str::startsWith Str::studly Str::substr Str::substrCount Str::substrReplace Str::swap Str::title Str::toHtmlString Str::ucfirst Str::ucsplit Str::upper Str::ulid Str::uuid Str::wordCount Str::words str trans trans_choice
Fluent Strings
after afterLast append ascii basename before beforeLast between betweenFirst camel classBasename contains containsAll dirname endsWith excerpt exactly explode finish headline inlineMarkdown is isAscii isEmpty isNotEmpty isJson isUlid isUuid kebab lcfirst length limit lower ltrim markdown mask match matchAll newLine padBoth padLeft padRight pipe plural prepend remove replace replaceArray replaceFirst replaceLast replaceMatches rtrim scan singular slug snake split squish start startsWith studly substr substrReplace swap tap test title trim ucfirst ucsplit upper when whenContains whenContainsAll whenEmpty whenNotEmpty whenStartsWith whenEndsWith whenExactly whenNotExactly whenIs whenIsAscii whenIsUlid whenIsUuid whenTest wordCount words
URLs
Miscellaneous
abort abort_if abort_unless app auth back bcrypt blank broadcast cache class_uses_recursive collect config cookie csrf_field csrf_token decrypt dd dispatch dump encrypt env event fake filled info logger method_field now old optional policy redirect report report_if report_unless request rescue resolve response retry session tap throw_if throw_unless today trait_uses_recursive transform validator value view with
Method Listing
Arrays & Objects
Arr::accessible()
The Arr::accessible
method determines if the given value is array accessible:
1use Illuminate\Support\Arr;2use Illuminate\Support\Collection;34$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);56// true78$isAccessible = Arr::accessible(new Collection);910// true1112$isAccessible = Arr::accessible('abc');1314// false1516$isAccessible = Arr::accessible(new stdClass);1718// false
1use Illuminate\Support\Arr;2use Illuminate\Support\Collection;34$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);56// true78$isAccessible = Arr::accessible(new Collection);910// true1112$isAccessible = Arr::accessible('abc');1314// false1516$isAccessible = Arr::accessible(new stdClass);1718// false
Arr::add()
The Arr::add
method adds a given key / value pair to an array if the given key doesn't already exist in the array or is set to null
:
1use Illuminate\Support\Arr;23$array = Arr::add(['name' => 'Desk'], 'price', 100);45// ['name' => 'Desk', 'price' => 100]67$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);89// ['name' => 'Desk', 'price' => 100]
1use Illuminate\Support\Arr;23$array = Arr::add(['name' => 'Desk'], 'price', 100);45// ['name' => 'Desk', 'price' => 100]67$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);89// ['name' => 'Desk', 'price' => 100]
Arr::collapse()
The Arr::collapse
method collapses an array of arrays into a single array:
1use Illuminate\Support\Arr;23$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);45// [1, 2, 3, 4, 5, 6, 7, 8, 9]
1use Illuminate\Support\Arr;23$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);45// [1, 2, 3, 4, 5, 6, 7, 8, 9]
Arr::crossJoin()
The Arr::crossJoin
method cross joins the given arrays, returning a Cartesian product with all possible permutations:
1use Illuminate\Support\Arr;23$matrix = Arr::crossJoin([1, 2], ['a', 'b']);45/*6 [7 [1, 'a'],8 [1, 'b'],9 [2, 'a'],10 [2, 'b'],11 ]12*/1314$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);1516/*17 [18 [1, 'a', 'I'],19 [1, 'a', 'II'],20 [1, 'b', 'I'],21 [1, 'b', 'II'],22 [2, 'a', 'I'],23 [2, 'a', 'II'],24 [2, 'b', 'I'],25 [2, 'b', 'II'],26 ]27*/
1use Illuminate\Support\Arr;23$matrix = Arr::crossJoin([1, 2], ['a', 'b']);45/*6 [7 [1, 'a'],8 [1, 'b'],9 [2, 'a'],10 [2, 'b'],11 ]12*/1314$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);1516/*17 [18 [1, 'a', 'I'],19 [1, 'a', 'II'],20 [1, 'b', 'I'],21 [1, 'b', 'II'],22 [2, 'a', 'I'],23 [2, 'a', 'II'],24 [2, 'b', 'I'],25 [2, 'b', 'II'],26 ]27*/
Arr::divide()
The Arr::divide
method returns two arrays: one containing the keys and the other containing the values of the given array:
1use Illuminate\Support\Arr;23[$keys, $values] = Arr::divide(['name' => 'Desk']);45// $keys: ['name']67// $values: ['Desk']
1use Illuminate\Support\Arr;23[$keys, $values] = Arr::divide(['name' => 'Desk']);45// $keys: ['name']67// $values: ['Desk']
Arr::dot()
The Arr::dot
method flattens a multi-dimensional array into a single level array that uses "dot" notation to indicate depth:
1use Illuminate\Support\Arr;23$array = ['products' => ['desk' => ['price' => 100]]];45$flattened = Arr::dot($array);67// ['products.desk.price' => 100]
1use Illuminate\Support\Arr;23$array = ['products' => ['desk' => ['price' => 100]]];45$flattened = Arr::dot($array);67// ['products.desk.price' => 100]
Arr::except()
The Arr::except
method removes the given key / value pairs from an array:
1use Illuminate\Support\Arr;23$array = ['name' => 'Desk', 'price' => 100];45$filtered = Arr::except($array, ['price']);67// ['name' => 'Desk']
1use Illuminate\Support\Arr;23$array = ['name' => 'Desk', 'price' => 100];45$filtered = Arr::except($array, ['price']);67// ['name' => 'Desk']
Arr::exists()
The Arr::exists
method checks that the given key exists in the provided array:
1use Illuminate\Support\Arr;23$array = ['name' => 'John Doe', 'age' => 17];45$exists = Arr::exists($array, 'name');67// true89$exists = Arr::exists($array, 'salary');1011// false
1use Illuminate\Support\Arr;23$array = ['name' => 'John Doe', 'age' => 17];45$exists = Arr::exists($array, 'name');67// true89$exists = Arr::exists($array, 'salary');1011// false
Arr::first()
The Arr::first
method returns the first element of an array passing a given truth test:
1use Illuminate\Support\Arr;23$array = [100, 200, 300];45$first = Arr::first($array, function ($value, $key) {6 return $value >= 150;7});89// 200
1use Illuminate\Support\Arr;23$array = [100, 200, 300];45$first = Arr::first($array, function ($value, $key) {6 return $value >= 150;7});89// 200
A default value may also be passed as the third parameter to the method. This value will be returned if no value passes the truth test:
1use Illuminate\Support\Arr;23$first = Arr::first($array, $callback, $default);
1use Illuminate\Support\Arr;23$first = Arr::first($array, $callback, $default);
Arr::flatten()
The Arr::flatten
method flattens a multi-dimensional array into a single level array:
1use Illuminate\Support\Arr;23$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];45$flattened = Arr::flatten($array);67// ['Joe', 'PHP', 'Ruby']
1use Illuminate\Support\Arr;23$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];45$flattened = Arr::flatten($array);67// ['Joe', 'PHP', 'Ruby']
Arr::forget()
The Arr::forget
method removes a given key / value pair from a deeply nested array using "dot" notation:
1use Illuminate\Support\Arr;23$array = ['products' => ['desk' => ['price' => 100]]];45Arr::forget($array, 'products.desk');67// ['products' => []]
1use Illuminate\Support\Arr;23$array = ['products' => ['desk' => ['price' => 100]]];45Arr::forget($array, 'products.desk');67// ['products' => []]
Arr::get()
The Arr::get
method retrieves a value from a deeply nested array using "dot" notation:
1use Illuminate\Support\Arr;23$array = ['products' => ['desk' => ['price' => 100]]];45$price = Arr::get($array, 'products.desk.price');67// 100
1use Illuminate\Support\Arr;23$array = ['products' => ['desk' => ['price' => 100]]];45$price = Arr::get($array, 'products.desk.price');67// 100
The Arr::get
method also accepts a default value, which will be returned if the specified key is not present in the array:
1use Illuminate\Support\Arr;23$discount = Arr::get($array, 'products.desk.discount', 0);45// 0
1use Illuminate\Support\Arr;23$discount = Arr::get($array, 'products.desk.discount', 0);45// 0
Arr::has()
The Arr::has
method checks whether a given item or items exists in an array using "dot" notation:
1use Illuminate\Support\Arr;23$array = ['product' => ['name' => 'Desk', 'price' => 100]];45$contains = Arr::has($array, 'product.name');67// true89$contains = Arr::has($array, ['product.price', 'product.discount']);1011// false
1use Illuminate\Support\Arr;23$array = ['product' => ['name' => 'Desk', 'price' => 100]];45$contains = Arr::has($array, 'product.name');67// true89$contains = Arr::has($array, ['product.price', 'product.discount']);1011// false
Arr::hasAny()
The Arr::hasAny
method checks whether any item in a given set exists in an array using "dot" notation:
1use Illuminate\Support\Arr;23$array = ['product' => ['name' => 'Desk', 'price' => 100]];45$contains = Arr::hasAny($array, 'product.name');67// true89$contains = Arr::hasAny($array, ['product.name', 'product.discount']);1011// true1213$contains = Arr::hasAny($array, ['category', 'product.discount']);1415// false
1use Illuminate\Support\Arr;23$array = ['product' => ['name' => 'Desk', 'price' => 100]];45$contains = Arr::hasAny($array, 'product.name');67// true89$contains = Arr::hasAny($array, ['product.name', 'product.discount']);1011// true1213$contains = Arr::hasAny($array, ['category', 'product.discount']);1415// false
Arr::isAssoc()
The Arr::isAssoc
method returns true
if the given array is an associative array. An array is considered "associative" if it doesn't have sequential numerical keys beginning with zero:
1use Illuminate\Support\Arr;23$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);45// true67$isAssoc = Arr::isAssoc([1, 2, 3]);89// false
1use Illuminate\Support\Arr;23$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);45// true67$isAssoc = Arr::isAssoc([1, 2, 3]);89// false
Arr::isList()
The Arr::isList
method returns true
if the given array's keys are sequential integers beginning from zero:
1use Illuminate\Support\Arr;23$isList = Arr::isList(['foo', 'bar', 'baz']);45// true67$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);89// false
1use Illuminate\Support\Arr;23$isList = Arr::isList(['foo', 'bar', 'baz']);45// true67$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);89// false
Arr::join()
The Arr::join
method joins array elements with a string. Using this method's second argument, you may also specify the joining string for the final element of the array:
1use Illuminate\Support\Arr;23$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];45$joined = Arr::join($array, ', ');67// Tailwind, Alpine, Laravel, Livewire89$joined = Arr::join($array, ', ', ' and ');1011// Tailwind, Alpine, Laravel and Livewire
1use Illuminate\Support\Arr;23$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];45$joined = Arr::join($array, ', ');67// Tailwind, Alpine, Laravel, Livewire89$joined = Arr::join($array, ', ', ' and ');1011// Tailwind, Alpine, Laravel and Livewire
Arr::keyBy()
The Arr::keyBy
method keys the array by the given key. If multiple items have the same key, only the last one will appear in the new array:
1use Illuminate\Support\Arr;23$array = [4 ['product_id' => 'prod-100', 'name' => 'Desk'],5 ['product_id' => 'prod-200', 'name' => 'Chair'],6];78$keyed = Arr::keyBy($array, 'product_id');910/*11 [12 'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],13 'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],14 ]15*/
1use Illuminate\Support\Arr;23$array = [4 ['product_id' => 'prod-100', 'name' => 'Desk'],5 ['product_id' => 'prod-200', 'name' => 'Chair'],6];78$keyed = Arr::keyBy($array, 'product_id');910/*11 [12 'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],13 'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],14 ]15*/
Arr::last()
The Arr::last
method returns the last element of an array passing a given truth test:
1use Illuminate\Support\Arr;23$array = [100, 200, 300, 110];45$last = Arr::last($array, function ($value, $key) {6 return $value >= 150;7});89// 300
1use Illuminate\Support\Arr;23$array = [100, 200, 300, 110];45$last = Arr::last($array, function ($value, $key) {6 return $value >= 150;7});89// 300
A default value may be passed as the third argument to the method. This value will be returned if no value passes the truth test:
1use Illuminate\Support\Arr;23$last = Arr::last($array, $callback, $default);
1use Illuminate\Support\Arr;23$last = Arr::last($array, $callback, $default);
Arr::map()
The Arr::map
method iterates through the array and passes each value and key to the given callback. The array value is replaced by the value returned by the callback:
1use Illuminate\Support\Arr;23$array = ['first' => 'james', 'last' => 'kirk'];45$mapped = Arr::map($array, function ($value, $key) {6 return ucfirst($value);7});89// ['first' => 'James', 'last' => 'Kirk']
1use Illuminate\Support\Arr;23$array = ['first' => 'james', 'last' => 'kirk'];45$mapped = Arr::map($array, function ($value, $key) {6 return ucfirst($value);7});89// ['first' => 'James', 'last' => 'Kirk']
Arr::only()
The Arr::only
method returns only the specified key / value pairs from the given array:
1use Illuminate\Support\Arr;23$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];45$slice = Arr::only($array, ['name', 'price']);67// ['name' => 'Desk', 'price' => 100]
1use Illuminate\Support\Arr;23$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];45$slice = Arr::only($array, ['name', 'price']);67// ['name' => 'Desk', 'price' => 100]
Arr::pluck()
The Arr::pluck
method retrieves all of the values for a given key from an array:
1use Illuminate\Support\Arr;23$array = [4 ['developer' => ['id' => 1, 'name' => 'Taylor']],5 ['developer' => ['id' => 2, 'name' => 'Abigail']],6];78$names = Arr::pluck($array, 'developer.name');910// ['Taylor', 'Abigail']
1use Illuminate\Support\Arr;23$array = [4 ['developer' => ['id' => 1, 'name' => 'Taylor']],5 ['developer' => ['id' => 2, 'name' => 'Abigail']],6];78$names = Arr::pluck($array, 'developer.name');910// ['Taylor', 'Abigail']
You may also specify how you wish the resulting list to be keyed:
1use Illuminate\Support\Arr;23$names = Arr::pluck($array, 'developer.name', 'developer.id');45// [1 => 'Taylor', 2 => 'Abigail']
1use Illuminate\Support\Arr;23$names = Arr::pluck($array, 'developer.name', 'developer.id');45// [1 => 'Taylor', 2 => 'Abigail']
Arr::prepend()
The Arr::prepend
method will push an item onto the beginning of an array:
1use Illuminate\Support\Arr;23$array = ['one', 'two', 'three', 'four'];45$array = Arr::prepend($array, 'zero');67// ['zero', 'one', 'two', 'three', 'four']
1use Illuminate\Support\Arr;23$array = ['one', 'two', 'three', 'four'];45$array = Arr::prepend($array, 'zero');67// ['zero', 'one', 'two', 'three', 'four']
If needed, you may specify the key that should be used for the value:
1use Illuminate\Support\Arr;23$array = ['price' => 100];45$array = Arr::prepend($array, 'Desk', 'name');67// ['name' => 'Desk', 'price' => 100]
1use Illuminate\Support\Arr;23$array = ['price' => 100];45$array = Arr::prepend($array, 'Desk', 'name');67// ['name' => 'Desk', 'price' => 100]
Arr::prependKeysWith()
The Arr::prependKeysWith
prepends all key names of an associative array with the given prefix:
1use Illuminate\Support\Arr;23$array = [4 'name' => 'Desk',5 'price' => 100,6];78$keyed = Arr::prependKeysWith($array, 'product.');910/*11 [12 'product.name' => 'Desk',13 'product.price' => 100,14 ]15*/
1use Illuminate\Support\Arr;23$array = [4 'name' => 'Desk',5 'price' => 100,6];78$keyed = Arr::prependKeysWith($array, 'product.');910/*11 [12 'product.name' => 'Desk',13 'product.price' => 100,14 ]15*/
Arr::pull()
The Arr::pull
method returns and removes a key / value pair from an array:
1use Illuminate\Support\Arr;23$array = ['name' => 'Desk', 'price' => 100];45$name = Arr::pull($array, 'name');67// $name: Desk89// $array: ['price' => 100]
1use Illuminate\Support\Arr;23$array = ['name' => 'Desk', 'price' => 100];45$name = Arr::pull($array, 'name');67// $name: Desk89// $array: ['price' => 100]
A default value may be passed as the third argument to the method. This value will be returned if the key doesn't exist:
1use Illuminate\Support\Arr;23$value = Arr::pull($array, $key, $default);
1use Illuminate\Support\Arr;23$value = Arr::pull($array, $key, $default);
Arr::query()
The Arr::query
method converts the array into a query string:
1use Illuminate\Support\Arr;23$array = [4 'name' => 'Taylor',5 'order' => [6 'column' => 'created_at',7 'direction' => 'desc'8 ]9];1011Arr::query($array);1213// name=Taylor&order[column]=created_at&order[direction]=desc
1use Illuminate\Support\Arr;23$array = [4 'name' => 'Taylor',5 'order' => [6 'column' => 'created_at',7 'direction' => 'desc'8 ]9];1011Arr::query($array);1213// name=Taylor&order[column]=created_at&order[direction]=desc
Arr::random()
The Arr::random
method returns a random value from an array:
1use Illuminate\Support\Arr;23$array = [1, 2, 3, 4, 5];45$random = Arr::random($array);67// 4 - (retrieved randomly)
1use Illuminate\Support\Arr;23$array = [1, 2, 3, 4, 5];45$random = Arr::random($array);67// 4 - (retrieved randomly)
You may also specify the number of items to return as an optional second argument. Note that providing this argument will return an array even if only one item is desired:
1use Illuminate\Support\Arr;23$items = Arr::random($array, 2);45// [2, 5] - (retrieved randomly)
1use Illuminate\Support\Arr;23$items = Arr::random($array, 2);45// [2, 5] - (retrieved randomly)
Arr::set()
The Arr::set
method sets a value within a deeply nested array using "dot" notation:
1use Illuminate\Support\Arr;23$array = ['products' => ['desk' => ['price' => 100]]];45Arr::set($array, 'products.desk.price', 200);67// ['products' => ['desk' => ['price' => 200]]]
1use Illuminate\Support\Arr;23$array = ['products' => ['desk' => ['price' => 100]]];45Arr::set($array, 'products.desk.price', 200);67// ['products' => ['desk' => ['price' => 200]]]
Arr::shuffle()
The Arr::shuffle
method randomly shuffles the items in the array:
1use Illuminate\Support\Arr;23$array = Arr::shuffle([1, 2, 3, 4, 5]);45// [3, 2, 5, 1, 4] - (generated randomly)
1use Illuminate\Support\Arr;23$array = Arr::shuffle([1, 2, 3, 4, 5]);45// [3, 2, 5, 1, 4] - (generated randomly)
Arr::sort()
The Arr::sort
method sorts an array by its values:
1use Illuminate\Support\Arr;23$array = ['Desk', 'Table', 'Chair'];45$sorted = Arr::sort($array);67// ['Chair', 'Desk', 'Table']
1use Illuminate\Support\Arr;23$array = ['Desk', 'Table', 'Chair'];45$sorted = Arr::sort($array);67// ['Chair', 'Desk', 'Table']
You may also sort the array by the results of a given closure:
1use Illuminate\Support\Arr;23$array = [4 ['name' => 'Desk'],5 ['name' => 'Table'],6 ['name' => 'Chair'],7];89$sorted = array_values(Arr::sort($array, function ($value) {10 return $value['name'];11}));1213/*14 [15 ['name' => 'Chair'],16 ['name' => 'Desk'],17 ['name' => 'Table'],18 ]19*/
1use Illuminate\Support\Arr;23$array = [4 ['name' => 'Desk'],5 ['name' => 'Table'],6 ['name' => 'Chair'],7];89$sorted = array_values(Arr::sort($array, function ($value) {10 return $value['name'];11}));1213/*14 [15 ['name' => 'Chair'],16 ['name' => 'Desk'],17 ['name' => 'Table'],18 ]19*/
Arr::sortDesc()
The Arr::sortDesc
method sorts an array in descending order by its values:
1use Illuminate\Support\Arr;23$array = ['Desk', 'Table', 'Chair'];45$sorted = Arr::sortDesc($array);67// ['Table', 'Desk', 'Chair']
1use Illuminate\Support\Arr;23$array = ['Desk', 'Table', 'Chair'];45$sorted = Arr::sortDesc($array);67// ['Table', 'Desk', 'Chair']
You may also sort the array by the results of a given closure:
1use Illuminate\Support\Arr;23$array = [4 ['name' => 'Desk'],5 ['name' => 'Table'],6 ['name' => 'Chair'],7];89$sorted = array_values(Arr::sortDesc($array, function ($value) {10 return $value['name'];11}));1213/*14 [15 ['name' => 'Table'],16 ['name' => 'Desk'],17 ['name' => 'Chair'],18 ]19*/
1use Illuminate\Support\Arr;23$array = [4 ['name' => 'Desk'],5 ['name' => 'Table'],6 ['name' => 'Chair'],7];89$sorted = array_values(Arr::sortDesc($array, function ($value) {10 return $value['name'];11}));1213/*14 [15 ['name' => 'Table'],16 ['name' => 'Desk'],17 ['name' => 'Chair'],18 ]19*/
Arr::sortRecursive()
The Arr::sortRecursive
method recursively sorts an array using the sort
function for numerically indexed sub-arrays and the ksort
function for associative sub-arrays:
1use Illuminate\Support\Arr;23$array = [4 ['Roman', 'Taylor', 'Li'],5 ['PHP', 'Ruby', 'JavaScript'],6 ['one' => 1, 'two' => 2, 'three' => 3],7];89$sorted = Arr::sortRecursive($array);1011/*12 [13 ['JavaScript', 'PHP', 'Ruby'],14 ['one' => 1, 'three' => 3, 'two' => 2],15 ['Li', 'Roman', 'Taylor'],16 ]17*/
1use Illuminate\Support\Arr;23$array = [4 ['Roman', 'Taylor', 'Li'],5 ['PHP', 'Ruby', 'JavaScript'],6 ['one' => 1, 'two' => 2, 'three' => 3],7];89$sorted = Arr::sortRecursive($array);1011/*12 [13 ['JavaScript', 'PHP', 'Ruby'],14 ['one' => 1, 'three' => 3, 'two' => 2],15 ['Li', 'Roman', 'Taylor'],16 ]17*/
Arr::toCssClasses()
The Arr::toCssClasses
conditionally compiles a CSS class string. The method accepts an array of classes where the array key contains the class or classes you wish to add, while the value is a boolean expression. If the array element has a numeric key, it will always be included in the rendered class list:
1use Illuminate\Support\Arr;23$isActive = false;4$hasError = true;56$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];78$classes = Arr::toCssClasses($array);910/*11 'p-4 bg-red'12*/
1use Illuminate\Support\Arr;23$isActive = false;4$hasError = true;56$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];78$classes = Arr::toCssClasses($array);910/*11 'p-4 bg-red'12*/
This method powers Laravel's functionality allowing merging classes with a Blade component's attribute bag as well as the @class
Blade directive.
Arr::undot()
The Arr::undot
method expands a single-dimensional array that uses "dot" notation into a multi-dimensional array:
1use Illuminate\Support\Arr;23$array = [4 'user.name' => 'Kevin Malone',5 'user.occupation' => 'Accountant',6];78$array = Arr::undot($array);910// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]
1use Illuminate\Support\Arr;23$array = [4 'user.name' => 'Kevin Malone',5 'user.occupation' => 'Accountant',6];78$array = Arr::undot($array);910// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]
Arr::where()
The Arr::where
method filters an array using the given closure:
1use Illuminate\Support\Arr;23$array = [100, '200', 300, '400', 500];45$filtered = Arr::where($array, function ($value, $key) {6 return is_string($value);7});89// [1 => '200', 3 => '400']
1use Illuminate\Support\Arr;23$array = [100, '200', 300, '400', 500];45$filtered = Arr::where($array, function ($value, $key) {6 return is_string($value);7});89// [1 => '200', 3 => '400']
Arr::whereNotNull()
The Arr::whereNotNull
method removes all null
values from the given array:
1use Illuminate\Support\Arr;23$array = [0, null];45$filtered = Arr::whereNotNull($array);67// [0 => 0]
1use Illuminate\Support\Arr;23$array = [0, null];45$filtered = Arr::whereNotNull($array);67// [0 => 0]
Arr::wrap()
The Arr::wrap
method wraps the given value in an array. If the given value is already an array it will be returned without modification:
1use Illuminate\Support\Arr;23$string = 'Laravel';45$array = Arr::wrap($string);67// ['Laravel']
1use Illuminate\Support\Arr;23$string = 'Laravel';45$array = Arr::wrap($string);67// ['Laravel']
If the given value is null
, an empty array will be returned:
1use Illuminate\Support\Arr;23$array = Arr::wrap(null);45// []
1use Illuminate\Support\Arr;23$array = Arr::wrap(null);45// []
data_fill()
The data_fill
function sets a missing value within a nested array or object using "dot" notation:
1$data = ['products' => ['desk' => ['price' => 100]]];23data_fill($data, 'products.desk.price', 200);45// ['products' => ['desk' => ['price' => 100]]]67data_fill($data, 'products.desk.discount', 10);89// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]
1$data = ['products' => ['desk' => ['price' => 100]]];23data_fill($data, 'products.desk.price', 200);45// ['products' => ['desk' => ['price' => 100]]]67data_fill($data, 'products.desk.discount', 10);89// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]
This function also accepts asterisks as wildcards and will fill the target accordingly:
1$data = [2 'products' => [3 ['name' => 'Desk 1', 'price' => 100],4 ['name' => 'Desk 2'],5 ],6];78data_fill($data, 'products.*.price', 200);910/*11 [12 'products' => [13 ['name' => 'Desk 1', 'price' => 100],14 ['name' => 'Desk 2', 'price' => 200],15 ],16 ]17*/
1$data = [2 'products' => [3 ['name' => 'Desk 1', 'price' => 100],4 ['name' => 'Desk 2'],5 ],6];78data_fill($data, 'products.*.price', 200);910/*11 [12 'products' => [13 ['name' => 'Desk 1', 'price' => 100],14 ['name' => 'Desk 2', 'price' => 200],15 ],16 ]17*/
data_get()
The data_get
function retrieves a value from a nested array or object using "dot" notation:
1$data = ['products' => ['desk' => ['price' => 100]]];23$price = data_get($data, 'products.desk.price');45// 100
1$data = ['products' => ['desk' => ['price' => 100]]];23$price = data_get($data, 'products.desk.price');45// 100
The data_get
function also accepts a default value, which will be returned if the specified key is not found:
1$discount = data_get($data, 'products.desk.discount', 0);23// 0
1$discount = data_get($data, 'products.desk.discount', 0);23// 0
The function also accepts wildcards using asterisks, which may target any key of the array or object:
1$data = [2 'product-one' => ['name' => 'Desk 1', 'price' => 100],3 'product-two' => ['name' => 'Desk 2', 'price' => 150],4];56data_get($data, '*.name');78// ['Desk 1', 'Desk 2'];
1$data = [2 'product-one' => ['name' => 'Desk 1', 'price' => 100],3 'product-two' => ['name' => 'Desk 2', 'price' => 150],4];56data_get($data, '*.name');78// ['Desk 1', 'Desk 2'];
data_set()
The data_set
function sets a value within a nested array or object using "dot" notation:
1$data = ['products' => ['desk' => ['price' => 100]]];23data_set($data, 'products.desk.price', 200);45// ['products' => ['desk' => ['price' => 200]]]
1$data = ['products' => ['desk' => ['price' => 100]]];23data_set($data, 'products.desk.price', 200);45// ['products' => ['desk' => ['price' => 200]]]
This function also accepts wildcards using asterisks and will set values on the target accordingly:
1$data = [2 'products' => [3 ['name' => 'Desk 1', 'price' => 100],4 ['name' => 'Desk 2', 'price' => 150],5 ],6];78data_set($data, 'products.*.price', 200);910/*11 [12 'products' => [13 ['name' => 'Desk 1', 'price' => 200],14 ['name' => 'Desk 2', 'price' => 200],15 ],16 ]17*/
1$data = [2 'products' => [3 ['name' => 'Desk 1', 'price' => 100],4 ['name' => 'Desk 2', 'price' => 150],5 ],6];78data_set($data, 'products.*.price', 200);910/*11 [12 'products' => [13 ['name' => 'Desk 1', 'price' => 200],14 ['name' => 'Desk 2', 'price' => 200],15 ],16 ]17*/
By default, any existing values are overwritten. If you wish to only set a value if it doesn't exist, you may pass false
as the fourth argument to the function:
1$data = ['products' => ['desk' => ['price' => 100]]];23data_set($data, 'products.desk.price', 200, overwrite: false);45// ['products' => ['desk' => ['price' => 100]]]
1$data = ['products' => ['desk' => ['price' => 100]]];23data_set($data, 'products.desk.price', 200, overwrite: false);45// ['products' => ['desk' => ['price' => 100]]]
head()
The head
function returns the first element in the given array:
1$array = [100, 200, 300];23$first = head($array);45// 100
1$array = [100, 200, 300];23$first = head($array);45// 100
last()
The last
function returns the last element in the given array:
1$array = [100, 200, 300];23$last = last($array);45// 300
1$array = [100, 200, 300];23$last = last($array);45// 300
Paths
app_path()
The app_path
function returns the fully qualified path to your application's app
directory. You may also use the app_path
function to generate a fully qualified path to a file relative to the application directory:
1$path = app_path();23$path = app_path('Http/Controllers/Controller.php');
1$path = app_path();23$path = app_path('Http/Controllers/Controller.php');
base_path()
The base_path
function returns the fully qualified path to your application's root directory. You may also use the base_path
function to generate a fully qualified path to a given file relative to the project root directory:
1$path = base_path();23$path = base_path('vendor/bin');
1$path = base_path();23$path = base_path('vendor/bin');
config_path()
The config_path
function returns the fully qualified path to your application's config
directory. You may also use the config_path
function to generate a fully qualified path to a given file within the application's configuration directory:
1$path = config_path();23$path = config_path('app.php');
1$path = config_path();23$path = config_path('app.php');
database_path()
The database_path
function returns the fully qualified path to your application's database
directory. You may also use the database_path
function to generate a fully qualified path to a given file within the database directory:
1$path = database_path();23$path = database_path('factories/UserFactory.php');
1$path = database_path();23$path = database_path('factories/UserFactory.php');
lang_path()
The lang_path
function returns the fully qualified path to your application's lang
directory. You may also use the lang_path
function to generate a fully qualified path to a given file within the directory:
1$path = lang_path();23$path = lang_path('en/messages.php');
1$path = lang_path();23$path = lang_path('en/messages.php');
mix()
The mix
function returns the path to a versioned Mix file:
1$path = mix('css/app.css');
1$path = mix('css/app.css');
public_path()
The public_path
function returns the fully qualified path to your application's public
directory. You may also use the public_path
function to generate a fully qualified path to a given file within the public directory:
1$path = public_path();23$path = public_path('css/app.css');
1$path = public_path();23$path = public_path('css/app.css');
resource_path()
The resource_path
function returns the fully qualified path to your application's resources
directory. You may also use the resource_path
function to generate a fully qualified path to a given file within the resources directory:
1$path = resource_path();23$path = resource_path('sass/app.scss');
1$path = resource_path();23$path = resource_path('sass/app.scss');
storage_path()
The storage_path
function returns the fully qualified path to your application's storage
directory. You may also use the storage_path
function to generate a fully qualified path to a given file within the storage directory:
1$path = storage_path();23$path = storage_path('app/file.txt');
1$path = storage_path();23$path = storage_path('app/file.txt');
Strings
__()
The __
function translates the given translation string or translation key using your localization files:
1echo __('Welcome to our application');23echo __('messages.welcome');
1echo __('Welcome to our application');23echo __('messages.welcome');
If the specified translation string or key does not exist, the __
function will return the given value. So, using the example above, the __
function would return messages.welcome
if that translation key does not exist.
class_basename()
The class_basename
function returns the class name of the given class with the class's namespace removed:
1$class = class_basename('Foo\Bar\Baz');23// Baz
1$class = class_basename('Foo\Bar\Baz');23// Baz
e()
The e
function runs PHP's htmlspecialchars
function with the double_encode
option set to true
by default:
1echo e('<html>foo</html>');23// <html>foo</html>
1echo e('<html>foo</html>');23// <html>foo</html>
preg_replace_array()
The preg_replace_array
function replaces a given pattern in the string sequentially using an array:
1$string = 'The event will take place between :start and :end';23$replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string);45// The event will take place between 8:30 and 9:00
1$string = 'The event will take place between :start and :end';23$replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string);45// The event will take place between 8:30 and 9:00
Str::after()
The Str::after
method returns everything after the given value in a string. The entire string will be returned if the value does not exist within the string:
1use Illuminate\Support\Str;23$slice = Str::after('This is my name', 'This is');45// ' my name'
1use Illuminate\Support\Str;23$slice = Str::after('This is my name', 'This is');45// ' my name'
Str::afterLast()
The Str::afterLast
method returns everything after the last occurrence of the given value in a string. The entire string will be returned if the value does not exist within the string:
1use Illuminate\Support\Str;23$slice = Str::afterLast('App\Http\Controllers\Controller', '\\');45// 'Controller'
1use Illuminate\Support\Str;23$slice = Str::afterLast('App\Http\Controllers\Controller', '\\');45// 'Controller'
Str::ascii()
The Str::ascii
method will attempt to transliterate the string into an ASCII value:
1use Illuminate\Support\Str;23$slice = Str::ascii('û');45// 'u'
1use Illuminate\Support\Str;23$slice = Str::ascii('û');45// 'u'
Str::before()
The Str::before
method returns everything before the given value in a string:
1use Illuminate\Support\Str;23$slice = Str::before('This is my name', 'my name');45// 'This is '
1use Illuminate\Support\Str;23$slice = Str::before('This is my name', 'my name');45// 'This is '
Str::beforeLast()
The Str::beforeLast
method returns everything before the last occurrence of the given value in a string:
1use Illuminate\Support\Str;23$slice = Str::beforeLast('This is my name', 'is');45// 'This '
1use Illuminate\Support\Str;23$slice = Str::beforeLast('This is my name', 'is');45// 'This '
Str::between()
The Str::between
method returns the portion of a string between two values:
1use Illuminate\Support\Str;23$slice = Str::between('This is my name', 'This', 'name');45// ' is my '
1use Illuminate\Support\Str;23$slice = Str::between('This is my name', 'This', 'name');45// ' is my '
Str::betweenFirst()
The Str::betweenFirst
method returns the smallest possible portion of a string between two values:
1use Illuminate\Support\Str;23$slice = Str::betweenFirst('[a] bc [d]', '[', ']');45// 'a'
1use Illuminate\Support\Str;23$slice = Str::betweenFirst('[a] bc [d]', '[', ']');45// 'a'
Str::camel()
The Str::camel
method converts the given string to camelCase
:
1use Illuminate\Support\Str;23$converted = Str::camel('foo_bar');45// fooBar
1use Illuminate\Support\Str;23$converted = Str::camel('foo_bar');45// fooBar
Str::contains()
The Str::contains
method determines if the given string contains the given value. This method is case sensitive:
1use Illuminate\Support\Str;23$contains = Str::contains('This is my name', 'my');45// true
1use Illuminate\Support\Str;23$contains = Str::contains('This is my name', 'my');45// true
You may also pass an array of values to determine if the given string contains any of the values in the array:
1use Illuminate\Support\Str;23$contains = Str::contains('This is my name', ['my', 'foo']);45// true
1use Illuminate\Support\Str;23$contains = Str::contains('This is my name', ['my', 'foo']);45// true
Str::containsAll()
The Str::containsAll
method determines if the given string contains all of the values in a given array:
1use Illuminate\Support\Str;23$containsAll = Str::containsAll('This is my name', ['my', 'name']);45// true
1use Illuminate\Support\Str;23$containsAll = Str::containsAll('This is my name', ['my', 'name']);45// true
Str::endsWith()
The Str::endsWith
method determines if the given string ends with the given value:
1use Illuminate\Support\Str;23$result = Str::endsWith('This is my name', 'name');45// true
1use Illuminate\Support\Str;23$result = Str::endsWith('This is my name', 'name');45// true
You may also pass an array of values to determine if the given string ends with any of the values in the array:
1use Illuminate\Support\Str;23$result = Str::endsWith('This is my name', ['name', 'foo']);45// true67$result = Str::endsWith('This is my name', ['this', 'foo']);89// false
1use Illuminate\Support\Str;23$result = Str::endsWith('This is my name', ['name', 'foo']);45// true67$result = Str::endsWith('This is my name', ['this', 'foo']);89// false
Str::excerpt()
The Str::excerpt
method extracts an excerpt from a given string that matches the first instance of a phrase within that string:
1use Illuminate\Support\Str;23$excerpt = Str::excerpt('This is my name', 'my', [4 'radius' => 35]);67// '...is my na...'
1use Illuminate\Support\Str;23$excerpt = Str::excerpt('This is my name', 'my', [4 'radius' => 35]);67// '...is my na...'
The radius
option, which defaults to 100
, allows you to define the number of characters that should appear on each side of the truncated string.
In addition, you may use the omission
option to define the string that will be prepended and appended to the truncated string:
1use Illuminate\Support\Str;23$excerpt = Str::excerpt('This is my name', 'name', [4 'radius' => 3,5 'omission' => '(...) '6]);78// '(...) my name'
1use Illuminate\Support\Str;23$excerpt = Str::excerpt('This is my name', 'name', [4 'radius' => 3,5 'omission' => '(...) '6]);78// '(...) my name'
Str::finish()
The Str::finish
method adds a single instance of the given value to a string if it does not already end with that value:
1use Illuminate\Support\Str;23$adjusted = Str::finish('this/string', '/');45// this/string/67$adjusted = Str::finish('this/string/', '/');89// this/string/
1use Illuminate\Support\Str;23$adjusted = Str::finish('this/string', '/');45// this/string/67$adjusted = Str::finish('this/string/', '/');89// this/string/
Str::headline()
The Str::headline
method will convert strings delimited by casing, hyphens, or underscores into a space delimited string with each word's first letter capitalized:
1use Illuminate\Support\Str;23$headline = Str::headline('steve_jobs');45// Steve Jobs67$headline = Str::headline('EmailNotificationSent');89// Email Notification Sent
1use Illuminate\Support\Str;23$headline = Str::headline('steve_jobs');45// Steve Jobs67$headline = Str::headline('EmailNotificationSent');89// Email Notification Sent
Str::inlineMarkdown()
The Str::inlineMarkdown
method converts GitHub flavored Markdown into inline HTML using CommonMark. However, unlike the markdown
method, it does not wrap all generated HTML in a block-level element:
1use Illuminate\Support\Str;23$html = Str::inlineMarkdown('**Laravel**');45// <strong>Laravel</strong>
1use Illuminate\Support\Str;23$html = Str::inlineMarkdown('**Laravel**');45// <strong>Laravel</strong>
Str::is()
The Str::is
method determines if a given string matches a given pattern. Asterisks may be used as wildcard values:
1use Illuminate\Support\Str;23$matches = Str::is('foo*', 'foobar');45// true67$matches = Str::is('baz*', 'foobar');89// false
1use Illuminate\Support\Str;23$matches = Str::is('foo*', 'foobar');45// true67$matches = Str::is('baz*', 'foobar');89// false
Str::isAscii()
The Str::isAscii
method determines if a given string is 7 bit ASCII:
1use Illuminate\Support\Str;23$isAscii = Str::isAscii('Taylor');45// true67$isAscii = Str::isAscii('ü');89// false
1use Illuminate\Support\Str;23$isAscii = Str::isAscii('Taylor');45// true67$isAscii = Str::isAscii('ü');89// false
Str::isJson()
The Str::isJson
method determines if the given string is valid JSON:
1use Illuminate\Support\Str;23$result = Str::isJson('[1,2,3]');45// true67$result = Str::isJson('{"first": "John", "last": "Doe"}');89// true1011$result = Str::isJson('{first: "John", last: "Doe"}');1213// false
1use Illuminate\Support\Str;23$result = Str::isJson('[1,2,3]');45// true67$result = Str::isJson('{"first": "John", "last": "Doe"}');89// true1011$result = Str::isJson('{first: "John", last: "Doe"}');1213// false
Str::isUlid()
The Str::isUlid
method determines if the given string is a valid ULID:
1use Illuminate\Support\Str;23$isUlid = Str::isUlid('01gd6r360bp37zj17nxb55yv40');45// true67$isUlid = Str::isUlid('laravel');89// false
1use Illuminate\Support\Str;23$isUlid = Str::isUlid('01gd6r360bp37zj17nxb55yv40');45// true67$isUlid = Str::isUlid('laravel');89// false
Str::isUuid()
The Str::isUuid
method determines if the given string is a valid UUID:
1use Illuminate\Support\Str;23$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');45// true67$isUuid = Str::isUuid('laravel');89// false
1use Illuminate\Support\Str;23$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');45// true67$isUuid = Str::isUuid('laravel');89// false
Str::kebab()
The Str::kebab
method converts the given string to kebab-case
:
1use Illuminate\Support\Str;23$converted = Str::kebab('fooBar');45// foo-bar
1use Illuminate\Support\Str;23$converted = Str::kebab('fooBar');45// foo-bar
Str::lcfirst()
The Str::lcfirst
method returns the given string with the first character lowercased:
1use Illuminate\Support\Str;23$string = Str::lcfirst('Foo Bar');45// foo Bar
1use Illuminate\Support\Str;23$string = Str::lcfirst('Foo Bar');45// foo Bar
Str::length()
The Str::length
method returns the length of the given string:
1use Illuminate\Support\Str;23$length = Str::length('Laravel');45// 7
1use Illuminate\Support\Str;23$length = Str::length('Laravel');45// 7
Str::limit()
The Str::limit
method truncates the given string to the specified length:
1use Illuminate\Support\Str;23$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);45// The quick brown fox...
1use Illuminate\Support\Str;23$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);45// The quick brown fox...
You may pass a third argument to the method to change the string that will be appended to the end of the truncated string:
1use Illuminate\Support\Str;23$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');45// The quick brown fox (...)
1use Illuminate\Support\Str;23$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');45// The quick brown fox (...)
Str::lower()
The Str::lower
method converts the given string to lowercase:
1use Illuminate\Support\Str;23$converted = Str::lower('LARAVEL');45// laravel
1use Illuminate\Support\Str;23$converted = Str::lower('LARAVEL');45// laravel
Str::markdown()
The Str::markdown
method converts GitHub flavored Markdown into HTML using CommonMark:
1use Illuminate\Support\Str;23$html = Str::markdown('# Laravel');45// <h1>Laravel</h1>67$html = Str::markdown('# Taylor <b>Otwell</b>', [8 'html_input' => 'strip',9]);1011// <h1>Taylor Otwell</h1>
1use Illuminate\Support\Str;23$html = Str::markdown('# Laravel');45// <h1>Laravel</h1>67$html = Str::markdown('# Taylor <b>Otwell</b>', [8 'html_input' => 'strip',9]);1011// <h1>Taylor Otwell</h1>
Str::mask()
The Str::mask
method masks a portion of a string with a repeated character, and may be used to obfuscate segments of strings such as email addresses and phone numbers:
1use Illuminate\Support\Str;245// tay***************
1use Illuminate\Support\Str;245// tay***************
If needed, you provide a negative number as the third argument to the mask
method, which will instruct the method to begin masking at the given distance from the end of the string:
23// tay***@example.com
23// tay***@example.com
Str::orderedUuid()
The Str::orderedUuid
method generates a "timestamp first" UUID that may be efficiently stored in an indexed database column. Each UUID that is generated using this method will be sorted after UUIDs previously generated using the method:
1use Illuminate\Support\Str;23return (string) Str::orderedUuid();
1use Illuminate\Support\Str;23return (string) Str::orderedUuid();
Str::padBoth()
The Str::padBoth
method wraps PHP's str_pad
function, padding both sides of a string with another string until the final string reaches a desired length:
1use Illuminate\Support\Str;23$padded = Str::padBoth('James', 10, '_');45// '__James___'67$padded = Str::padBoth('James', 10);89// ' James '
1use Illuminate\Support\Str;23$padded = Str::padBoth('James', 10, '_');45// '__James___'67$padded = Str::padBoth('James', 10);89// ' James '
Str::padLeft()
The Str::padLeft
method wraps PHP's str_pad
function, padding the left side of a string with another string until the final string reaches a desired length:
1use Illuminate\Support\Str;23$padded = Str::padLeft('James', 10, '-=');45// '-=-=-James'67$padded = Str::padLeft('James', 10);89// ' James'
1use Illuminate\Support\Str;23$padded = Str::padLeft('James', 10, '-=');45// '-=-=-James'67$padded = Str::padLeft('James', 10);89// ' James'
Str::padRight()
The Str::padRight
method wraps PHP's str_pad
function, padding the right side of a string with another string until the final string reaches a desired length:
1use Illuminate\Support\Str;23$padded = Str::padRight('James', 10, '-');45// 'James-----'67$padded = Str::padRight('James', 10);89// 'James '
1use Illuminate\Support\Str;23$padded = Str::padRight('James', 10, '-');45// 'James-----'67$padded = Str::padRight('James', 10);89// 'James '
Str::plural()
The Str::plural
method converts a singular word string to its plural form. This function supports any of the languages support by Laravel's pluralizer:
1use Illuminate\Support\Str;23$plural = Str::plural('car');45// cars67$plural = Str::plural('child');89// children
1use Illuminate\Support\Str;23$plural = Str::plural('car');45// cars67$plural = Str::plural('child');89// children
You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:
1use Illuminate\Support\Str;23$plural = Str::plural('child', 2);45// children67$singular = Str::plural('child', 1);89// child
1use Illuminate\Support\Str;23$plural = Str::plural('child', 2);45// children67$singular = Str::plural('child', 1);89// child
Str::pluralStudly()
The Str::pluralStudly
method converts a singular word string formatted in studly caps case to its plural form. This function supports any of the languages support by Laravel's pluralizer:
1use Illuminate\Support\Str;23$plural = Str::pluralStudly('VerifiedHuman');45// VerifiedHumans67$plural = Str::pluralStudly('UserFeedback');89// UserFeedback
1use Illuminate\Support\Str;23$plural = Str::pluralStudly('VerifiedHuman');45// VerifiedHumans67$plural = Str::pluralStudly('UserFeedback');89// UserFeedback
You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:
1use Illuminate\Support\Str;23$plural = Str::pluralStudly('VerifiedHuman', 2);45// VerifiedHumans67$singular = Str::pluralStudly('VerifiedHuman', 1);89// VerifiedHuman
1use Illuminate\Support\Str;23$plural = Str::pluralStudly('VerifiedHuman', 2);45// VerifiedHumans67$singular = Str::pluralStudly('VerifiedHuman', 1);89// VerifiedHuman
Str::random()
The Str::random
method generates a random string of the specified length. This function uses PHP's random_bytes
function:
1use Illuminate\Support\Str;23$random = Str::random(40);
1use Illuminate\Support\Str;23$random = Str::random(40);
Str::remove()
The Str::remove
method removes the given value or array of values from the string:
1use Illuminate\Support\Str;23$string = 'Peter Piper picked a peck of pickled peppers.';45$removed = Str::remove('e', $string);67// Ptr Pipr pickd a pck of pickld ppprs.
1use Illuminate\Support\Str;23$string = 'Peter Piper picked a peck of pickled peppers.';45$removed = Str::remove('e', $string);67// Ptr Pipr pickd a pck of pickld ppprs.
You may also pass false
as a third argument to the remove
method to ignore case when removing strings.
Str::replace()
The Str::replace
method replaces a given string within the string:
1use Illuminate\Support\Str;23$string = 'Laravel 8.x';45$replaced = Str::replace('8.x', '9.x', $string);67// Laravel 9.x
1use Illuminate\Support\Str;23$string = 'Laravel 8.x';45$replaced = Str::replace('8.x', '9.x', $string);67// Laravel 9.x
Str::replaceArray()
The Str::replaceArray
method replaces a given value in the string sequentially using an array:
1use Illuminate\Support\Str;23$string = 'The event will take place between ? and ?';45$replaced = Str::replaceArray('?', ['8:30', '9:00'], $string);67// The event will take place between 8:30 and 9:00
1use Illuminate\Support\Str;23$string = 'The event will take place between ? and ?';45$replaced = Str::replaceArray('?', ['8:30', '9:00'], $string);67// The event will take place between 8:30 and 9:00
Str::replaceFirst()
The Str::replaceFirst
method replaces the first occurrence of a given value in a string:
1use Illuminate\Support\Str;23$replaced = Str::replaceFirst('the', 'a', 'the quick brown fox jumps over the lazy dog');45// a quick brown fox jumps over the lazy dog
1use Illuminate\Support\Str;23$replaced = Str::replaceFirst('the', 'a', 'the quick brown fox jumps over the lazy dog');45// a quick brown fox jumps over the lazy dog
Str::replaceLast()
The Str::replaceLast
method replaces the last occurrence of a given value in a string:
1use Illuminate\Support\Str;23$replaced = Str::replaceLast('the', 'a', 'the quick brown fox jumps over the lazy dog');45// the quick brown fox jumps over a lazy dog
1use Illuminate\Support\Str;23$replaced = Str::replaceLast('the', 'a', 'the quick brown fox jumps over the lazy dog');45// the quick brown fox jumps over a lazy dog
Str::reverse()
The Str::reverse
method reverses the given string:
1use Illuminate\Support\Str;23$reversed = Str::reverse('Hello World');45// dlroW olleH
1use Illuminate\Support\Str;23$reversed = Str::reverse('Hello World');45// dlroW olleH
Str::singular()
The Str::singular
method converts a string to its singular form. This function supports any of the languages support by Laravel's pluralizer:
1use Illuminate\Support\Str;23$singular = Str::singular('cars');45// car67$singular = Str::singular('children');89// child
1use Illuminate\Support\Str;23$singular = Str::singular('cars');45// car67$singular = Str::singular('children');89// child
Str::slug()
The Str::slug
method generates a URL friendly "slug" from the given string:
1use Illuminate\Support\Str;23$slug = Str::slug('Laravel 5 Framework', '-');45// laravel-5-framework
1use Illuminate\Support\Str;23$slug = Str::slug('Laravel 5 Framework', '-');45// laravel-5-framework
Str::snake()
The Str::snake
method converts the given string to snake_case
:
1use Illuminate\Support\Str;23$converted = Str::snake('fooBar');45// foo_bar67$converted = Str::snake('fooBar', '-');89// foo-bar
1use Illuminate\Support\Str;23$converted = Str::snake('fooBar');45// foo_bar67$converted = Str::snake('fooBar', '-');89// foo-bar
Str::squish()
The Str::squish
method removes all extraneous white space from a string, including extraneous white space between words:
1use Illuminate\Support\Str;23$string = Str::squish(' laravel framework ');45// laravel framework
1use Illuminate\Support\Str;23$string = Str::squish(' laravel framework ');45// laravel framework
Str::start()
The Str::start
method adds a single instance of the given value to a string if it does not already start with that value:
1use Illuminate\Support\Str;23$adjusted = Str::start('this/string', '/');45// /this/string67$adjusted = Str::start('/this/string', '/');89// /this/string
1use Illuminate\Support\Str;23$adjusted = Str::start('this/string', '/');45// /this/string67$adjusted = Str::start('/this/string', '/');89// /this/string
Str::startsWith()
The Str::startsWith
method determines if the given string begins with the given value:
1use Illuminate\Support\Str;23$result = Str::startsWith('This is my name', 'This');45// true
1use Illuminate\Support\Str;23$result = Str::startsWith('This is my name', 'This');45// true
If an array of possible values is passed, the startsWith
method will return true
if the string begins with any of the given values:
1$result = Str::startsWith('This is my name', ['This', 'That', 'There']);23// true
1$result = Str::startsWith('This is my name', ['This', 'That', 'There']);23// true
Str::studly()
The Str::studly
method converts the given string to StudlyCase
:
1use Illuminate\Support\Str;23$converted = Str::studly('foo_bar');45// FooBar
1use Illuminate\Support\Str;23$converted = Str::studly('foo_bar');45// FooBar
Str::substr()
The Str::substr
method returns the portion of string specified by the start and length parameters:
1use Illuminate\Support\Str;23$converted = Str::substr('The Laravel Framework', 4, 7);45// Laravel
1use Illuminate\Support\Str;23$converted = Str::substr('The Laravel Framework', 4, 7);45// Laravel
Str::substrCount()
The Str::substrCount
method returns the number of occurrences of a given value in the given string:
1use Illuminate\Support\Str;23$count = Str::substrCount('If you like ice cream, you will like snow cones.', 'like');45// 2
1use Illuminate\Support\Str;23$count = Str::substrCount('If you like ice cream, you will like snow cones.', 'like');45// 2
Str::substrReplace()
The Str::substrReplace
method replaces text within a portion of a string, starting at the position specified by the third argument and replacing the number of characters specified by the fourth argument. Passing 0
to the method's fourth argument will insert the string at the specified position without replacing any of the existing characters in the string:
1use Illuminate\Support\Str;23$result = Str::substrReplace('1300', ':', 2);4// 13:56$result = Str::substrReplace('1300', ':', 2, 0);7// 13:00
1use Illuminate\Support\Str;23$result = Str::substrReplace('1300', ':', 2);4// 13:56$result = Str::substrReplace('1300', ':', 2, 0);7// 13:00
Str::swap()
The Str::swap
method replaces multiple values in the given string using PHP's strtr
function:
1use Illuminate\Support\Str;23$string = Str::swap([4 'Tacos' => 'Burritos',5 'great' => 'fantastic',6], 'Tacos are great!');78// Burritos are fantastic!
1use Illuminate\Support\Str;23$string = Str::swap([4 'Tacos' => 'Burritos',5 'great' => 'fantastic',6], 'Tacos are great!');78// Burritos are fantastic!
Str::title()
The Str::title
method converts the given string to Title Case
:
1use Illuminate\Support\Str;23$converted = Str::title('a nice title uses the correct case');45// A Nice Title Uses The Correct Case
1use Illuminate\Support\Str;23$converted = Str::title('a nice title uses the correct case');45// A Nice Title Uses The Correct Case
Str::toHtmlString()
The Str::toHtmlString
method converts the string instance to an instance of Illuminate\Support\HtmlString
, which may be displayed in Blade templates:
1use Illuminate\Support\Str;23$htmlString = Str::of('Nuno Maduro')->toHtmlString();
1use Illuminate\Support\Str;23$htmlString = Str::of('Nuno Maduro')->toHtmlString();
Str::ucfirst()
The Str::ucfirst
method returns the given string with the first character capitalized:
1use Illuminate\Support\Str;23$string = Str::ucfirst('foo bar');45// Foo bar
1use Illuminate\Support\Str;23$string = Str::ucfirst('foo bar');45// Foo bar
Str::ucsplit()
The Str::ucsplit
method splits the given string into an array by uppercase characters:
1use Illuminate\Support\Str;23$segments = Str::ucsplit('FooBar');45// [0 => 'Foo', 1 => 'Bar']
1use Illuminate\Support\Str;23$segments = Str::ucsplit('FooBar');45// [0 => 'Foo', 1 => 'Bar']
Str::upper()
The Str::upper
method converts the given string to uppercase:
1use Illuminate\Support\Str;23$string = Str::upper('laravel');45// LARAVEL
1use Illuminate\Support\Str;23$string = Str::upper('laravel');45// LARAVEL
Str::ulid()
The Str::ulid
method generates a ULID:
1use Illuminate\Support\Str;23return (string) Str::ulid();45// 01gd6r360bp37zj17nxb55yv40
1use Illuminate\Support\Str;23return (string) Str::ulid();45// 01gd6r360bp37zj17nxb55yv40
Str::uuid()
The Str::uuid
method generates a UUID (version 4):
1use Illuminate\Support\Str;23return (string) Str::uuid();
1use Illuminate\Support\Str;23return (string) Str::uuid();
Str::wordCount()
The Str::wordCount
method returns the number of words that a string contains:
1use Illuminate\Support\Str;23Str::wordCount('Hello, world!'); // 2
1use Illuminate\Support\Str;23Str::wordCount('Hello, world!'); // 2
Str::words()
The Str::words
method limits the number of words in a string. An additional string may be passed to this method via its third argument to specify which string should be appended to the end of the truncated string:
1use Illuminate\Support\Str;23return Str::words('Perfectly balanced, as all things should be.', 3, ' >>>');45// Perfectly balanced, as >>>
1use Illuminate\Support\Str;23return Str::words('Perfectly balanced, as all things should be.', 3, ' >>>');45// Perfectly balanced, as >>>
str()
The str
function returns a new Illuminate\Support\Stringable
instance of the given string. This function is equivalent to the Str::of
method:
1$string = str('Taylor')->append(' Otwell');23// 'Taylor Otwell'
1$string = str('Taylor')->append(' Otwell');23// 'Taylor Otwell'
If no argument is provided to the str
function, the function returns an instance of Illuminate\Support\Str
:
1$snake = str()->snake('FooBar');23// 'foo_bar'
1$snake = str()->snake('FooBar');23// 'foo_bar'
trans()
The trans
function translates the given translation key using your localization files:
1echo trans('messages.welcome');
1echo trans('messages.welcome');
If the specified translation key does not exist, the trans
function will return the given key. So, using the example above, the trans
function would return messages.welcome
if the translation key does not exist.
trans_choice()
The trans_choice
function translates the given translation key with inflection:
1echo trans_choice('messages.notifications', $unreadCount);
1echo trans_choice('messages.notifications', $unreadCount);
If the specified translation key does not exist, the trans_choice
function will return the given key. So, using the example above, the trans_choice
function would return messages.notifications
if the translation key does not exist.
Fluent Strings
Fluent strings provide a more fluent, object-oriented interface for working with string values, allowing you to chain multiple string operations together using a more readable syntax compared to traditional string operations.
after
The after
method returns everything after the given value in a string. The entire string will be returned if the value does not exist within the string:
1use Illuminate\Support\Str;23$slice = Str::of('This is my name')->after('This is');45// ' my name'
1use Illuminate\Support\Str;23$slice = Str::of('This is my name')->after('This is');45// ' my name'
afterLast
The afterLast
method returns everything after the last occurrence of the given value in a string. The entire string will be returned if the value does not exist within the string:
1use Illuminate\Support\Str;23$slice = Str::of('App\Http\Controllers\Controller')->afterLast('\\');45// 'Controller'
1use Illuminate\Support\Str;23$slice = Str::of('App\Http\Controllers\Controller')->afterLast('\\');45// 'Controller'
append
The append
method appends the given values to the string:
1use Illuminate\Support\Str;23$string = Str::of('Taylor')->append(' Otwell');45// 'Taylor Otwell'
1use Illuminate\Support\Str;23$string = Str::of('Taylor')->append(' Otwell');45// 'Taylor Otwell'
ascii
The ascii
method will attempt to transliterate the string into an ASCII value:
1use Illuminate\Support\Str;23$string = Str::of('ü')->ascii();45// 'u'
1use Illuminate\Support\Str;23$string = Str::of('ü')->ascii();45// 'u'
basename
The basename
method will return the trailing name component of the given string:
1use Illuminate\Support\Str;23$string = Str::of('/foo/bar/baz')->basename();45// 'baz'
1use Illuminate\Support\Str;23$string = Str::of('/foo/bar/baz')->basename();45// 'baz'
If needed, you may provide an "extension" that will be removed from the trailing component:
1use Illuminate\Support\Str;23$string = Str::of('/foo/bar/baz.jpg')->basename('.jpg');45// 'baz'
1use Illuminate\Support\Str;23$string = Str::of('/foo/bar/baz.jpg')->basename('.jpg');45// 'baz'
before
The before
method returns everything before the given value in a string:
1use Illuminate\Support\Str;23$slice = Str::of('This is my name')->before('my name');45// 'This is '
1use Illuminate\Support\Str;23$slice = Str::of('This is my name')->before('my name');45// 'This is '
beforeLast
The beforeLast
method returns everything before the last occurrence of the given value in a string:
1use Illuminate\Support\Str;23$slice = Str::of('This is my name')->beforeLast('is');45// 'This '
1use Illuminate\Support\Str;23$slice = Str::of('This is my name')->beforeLast('is');45// 'This '
between
The between
method returns the portion of a string between two values:
1use Illuminate\Support\Str;23$converted = Str::of('This is my name')->between('This', 'name');45// ' is my '
1use Illuminate\Support\Str;23$converted = Str::of('This is my name')->between('This', 'name');45// ' is my '
betweenFirst
The betweenFirst
method returns the smallest possible portion of a string between two values:
1use Illuminate\Support\Str;23$converted = Str::of('[a] bc [d]')->betweenFirst('[', ']');45// 'a'
1use Illuminate\Support\Str;23$converted = Str::of('[a] bc [d]')->betweenFirst('[', ']');45// 'a'
camel
The camel
method converts the given string to camelCase
:
1use Illuminate\Support\Str;23$converted = Str::of('foo_bar')->camel();45// fooBar
1use Illuminate\Support\Str;23$converted = Str::of('foo_bar')->camel();45// fooBar
classBasename
The classBasename
method returns the class name of the given class with the class's namespace removed:
1use Illuminate\Support\Str;23$class = Str::of('Foo\Bar\Baz')->classBasename();45// Baz
1use Illuminate\Support\Str;23$class = Str::of('Foo\Bar\Baz')->classBasename();45// Baz
contains
The contains
method determines if the given string contains the given value. This method is case sensitive:
1use Illuminate\Support\Str;23$contains = Str::of('This is my name')->contains('my');45// true
1use Illuminate\Support\Str;23$contains = Str::of('This is my name')->contains('my');45// true
You may also pass an array of values to determine if the given string contains any of the values in the array:
1use Illuminate\Support\Str;23$contains = Str::of('This is my name')->contains(['my', 'foo']);45// true
1use Illuminate\Support\Str;23$contains = Str::of('This is my name')->contains(['my', 'foo']);45// true
containsAll
The containsAll
method determines if the given string contains all of the values in the given array:
1use Illuminate\Support\Str;23$containsAll = Str::of('This is my name')->containsAll(['my', 'name']);45// true
1use Illuminate\Support\Str;23$containsAll = Str::of('This is my name')->containsAll(['my', 'name']);45// true
dirname
The dirname
method returns the parent directory portion of the given string:
1use Illuminate\Support\Str;23$string = Str::of('/foo/bar/baz')->dirname();45// '/foo/bar'
1use Illuminate\Support\Str;23$string = Str::of('/foo/bar/baz')->dirname();45// '/foo/bar'
If necessary, you may specify how many directory levels you wish to trim from the string:
1use Illuminate\Support\Str;23$string = Str::of('/foo/bar/baz')->dirname(2);45// '/foo'
1use Illuminate\Support\Str;23$string = Str::of('/foo/bar/baz')->dirname(2);45// '/foo'
excerpt
The excerpt
method extracts an excerpt from the string that matches the first instance of a phrase within that string:
1use Illuminate\Support\Str;23$excerpt = Str::of('This is my name')->excerpt('my', [4 'radius' => 35]);67// '...is my na...'
1use Illuminate\Support\Str;23$excerpt = Str::of('This is my name')->excerpt('my', [4 'radius' => 35]);67// '...is my na...'
The radius
option, which defaults to 100
, allows you to define the number of characters that should appear on each side of the truncated string.
In addition, you may use the omission
option to change the string that will be prepended and appended to the truncated string:
1use Illuminate\Support\Str;23$excerpt = Str::of('This is my name')->excerpt('name', [4 'radius' => 3,5 'omission' => '(...) '6]);78// '(...) my name'
1use Illuminate\Support\Str;23$excerpt = Str::of('This is my name')->excerpt('name', [4 'radius' => 3,5 'omission' => '(...) '6]);78// '(...) my name'
endsWith
The endsWith
method determines if the given string ends with the given value:
1use Illuminate\Support\Str;23$result = Str::of('This is my name')->endsWith('name');45// true
1use Illuminate\Support\Str;23$result = Str::of('This is my name')->endsWith('name');45// true
You may also pass an array of values to determine if the given string ends with any of the values in the array:
1use Illuminate\Support\Str;23$result = Str::of('This is my name')->endsWith(['name', 'foo']);45// true67$result = Str::of('This is my name')->endsWith(['this', 'foo']);89// false
1use Illuminate\Support\Str;23$result = Str::of('This is my name')->endsWith(['name', 'foo']);45// true67$result = Str::of('This is my name')->endsWith(['this', 'foo']);89// false
exactly
The exactly
method determines if the given string is an exact match with another string:
1use Illuminate\Support\Str;23$result = Str::of('Laravel')->exactly('Laravel');45// true
1use Illuminate\Support\Str;23$result = Str::of('Laravel')->exactly('Laravel');45// true
explode
The explode
method splits the string by the given delimiter and returns a collection containing each section of the split string:
1use Illuminate\Support\Str;23$collection = Str::of('foo bar baz')->explode(' ');45// collect(['foo', 'bar', 'baz'])
1use Illuminate\Support\Str;23$collection = Str::of('foo bar baz')->explode(' ');45// collect(['foo', 'bar', 'baz'])
finish
The finish
method adds a single instance of the given value to a string if it does not already end with that value:
1use Illuminate\Support\Str;23$adjusted = Str::of('this/string')->finish('/');45// this/string/67$adjusted = Str::of('this/string/')->finish('/');89// this/string/
1use Illuminate\Support\Str;23$adjusted = Str::of('this/string')->finish('/');45// this/string/67$adjusted = Str::of('this/string/')->finish('/');89// this/string/
headline
The headline
method will convert strings delimited by casing, hyphens, or underscores into a space delimited string with each word's first letter capitalized:
1use Illuminate\Support\Str;23$headline = Str::of('taylor_otwell')->headline();45// Taylor Otwell67$headline = Str::of('EmailNotificationSent')->headline();89// Email Notification Sent
1use Illuminate\Support\Str;23$headline = Str::of('taylor_otwell')->headline();45// Taylor Otwell67$headline = Str::of('EmailNotificationSent')->headline();89// Email Notification Sent
inlineMarkdown
The inlineMarkdown
method converts GitHub flavored Markdown into inline HTML using CommonMark. However, unlike the markdown
method, it does not wrap all generated HTML in a block-level element:
1use Illuminate\Support\Str;23$html = Str::of('**Laravel**')->inlineMarkdown();45// <strong>Laravel</strong>
1use Illuminate\Support\Str;23$html = Str::of('**Laravel**')->inlineMarkdown();45// <strong>Laravel</strong>
is
The is
method determines if a given string matches a given pattern. Asterisks may be used as wildcard values
1use Illuminate\Support\Str;23$matches = Str::of('foobar')->is('foo*');45// true67$matches = Str::of('foobar')->is('baz*');89// false
1use Illuminate\Support\Str;23$matches = Str::of('foobar')->is('foo*');45// true67$matches = Str::of('foobar')->is('baz*');89// false
isAscii
The isAscii
method determines if a given string is an ASCII string:
1use Illuminate\Support\Str;23$result = Str::of('Taylor')->isAscii();45// true67$result = Str::of('ü')->isAscii();89// false
1use Illuminate\Support\Str;23$result = Str::of('Taylor')->isAscii();45// true67$result = Str::of('ü')->isAscii();89// false
isEmpty
The isEmpty
method determines if the given string is empty:
1use Illuminate\Support\Str;23$result = Str::of(' ')->trim()->isEmpty();45// true67$result = Str::of('Laravel')->trim()->isEmpty();89// false
1use Illuminate\Support\Str;23$result = Str::of(' ')->trim()->isEmpty();45// true67$result = Str::of('Laravel')->trim()->isEmpty();89// false
isNotEmpty
The isNotEmpty
method determines if the given string is not empty:
1use Illuminate\Support\Str;23$result = Str::of(' ')->trim()->isNotEmpty();45// false67$result = Str::of('Laravel')->trim()->isNotEmpty();89// true
1use Illuminate\Support\Str;23$result = Str::of(' ')->trim()->isNotEmpty();45// false67$result = Str::of('Laravel')->trim()->isNotEmpty();89// true
isJson
The isJson
method determines if a given string is valid JSON:
1use Illuminate\Support\Str;23$result = Str::of('[1,2,3]')->isJson();45// true67$result = Str::of('{"first": "John", "last": "Doe"}')->isJson();89// true1011$result = Str::of('{first: "John", last: "Doe"}')->isJson();1213// false
1use Illuminate\Support\Str;23$result = Str::of('[1,2,3]')->isJson();45// true67$result = Str::of('{"first": "John", "last": "Doe"}')->isJson();89// true1011$result = Str::of('{first: "John", last: "Doe"}')->isJson();1213// false
isUlid
The isUlid
method determines if a given string is a ULID:
1use Illuminate\Support\Str;23$result = Str::of('01gd6r360bp37zj17nxb55yv40')->isUlid();45// true67$result = Str::of('Taylor')->isUlid();89// false
1use Illuminate\Support\Str;23$result = Str::of('01gd6r360bp37zj17nxb55yv40')->isUlid();45// true67$result = Str::of('Taylor')->isUlid();89// false
isUuid
The isUuid
method determines if a given string is a UUID:
1use Illuminate\Support\Str;23$result = Str::of('5ace9ab9-e9cf-4ec6-a19d-5881212a452c')->isUuid();45// true67$result = Str::of('Taylor')->isUuid();89// false
1use Illuminate\Support\Str;23$result = Str::of('5ace9ab9-e9cf-4ec6-a19d-5881212a452c')->isUuid();45// true67$result = Str::of('Taylor')->isUuid();89// false
kebab
The kebab
method converts the given string to kebab-case
:
1use Illuminate\Support\Str;23$converted = Str::of('fooBar')->kebab();45// foo-bar
1use Illuminate\Support\Str;23$converted = Str::of('fooBar')->kebab();45// foo-bar
lcfirst
The lcfirst
method returns the given string with the first character lowercased:
1use Illuminate\Support\Str;23$string = Str::of('Foo Bar')->lcfirst();45// foo Bar
1use Illuminate\Support\Str;23$string = Str::of('Foo Bar')->lcfirst();45// foo Bar
length
The length
method returns the length of the given string:
1use Illuminate\Support\Str;23$length = Str::of('Laravel')->length();45// 7
1use Illuminate\Support\Str;23$length = Str::of('Laravel')->length();45// 7
limit
The limit
method truncates the given string to the specified length:
1use Illuminate\Support\Str;23$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20);45// The quick brown fox...
1use Illuminate\Support\Str;23$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20);45// The quick brown fox...
You may also pass a second argument to change the string that will be appended to the end of the truncated string:
1use Illuminate\Support\Str;23$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20, ' (...)');45// The quick brown fox (...)
1use Illuminate\Support\Str;23$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20, ' (...)');45// The quick brown fox (...)
lower
The lower
method converts the given string to lowercase:
1use Illuminate\Support\Str;23$result = Str::of('LARAVEL')->lower();45// 'laravel'
1use Illuminate\Support\Str;23$result = Str::of('LARAVEL')->lower();45// 'laravel'
ltrim
The ltrim
method trims the left side of the string:
1use Illuminate\Support\Str;23$string = Str::of(' Laravel ')->ltrim();45// 'Laravel '67$string = Str::of('/Laravel/')->ltrim('/');89// 'Laravel/'
1use Illuminate\Support\Str;23$string = Str::of(' Laravel ')->ltrim();45// 'Laravel '67$string = Str::of('/Laravel/')->ltrim('/');89// 'Laravel/'
markdown
The markdown
method converts GitHub flavored Markdown into HTML:
1use Illuminate\Support\Str;23$html = Str::of('# Laravel')->markdown();45// <h1>Laravel</h1>67$html = Str::of('# Taylor <b>Otwell</b>')->markdown([8 'html_input' => 'strip',9]);1011// <h1>Taylor Otwell</h1>
1use Illuminate\Support\Str;23$html = Str::of('# Laravel')->markdown();45// <h1>Laravel</h1>67$html = Str::of('# Taylor <b>Otwell</b>')->markdown([8 'html_input' => 'strip',9]);1011// <h1>Taylor Otwell</h1>
mask
The mask
method masks a portion of a string with a repeated character, and may be used to obfuscate segments of strings such as email addresses and phone numbers:
1use Illuminate\Support\Str;245// tay***************
1use Illuminate\Support\Str;245// tay***************
If needed, you may provide negative numbers as the third or fourth argument to the mask
method, which will instruct the method to begin masking at the given distance from the end of the string:
23// tay***@example.com467// tayl**********.com
23// tay***@example.com467// tayl**********.com
match
The match
method will return the portion of a string that matches a given regular expression pattern:
1use Illuminate\Support\Str;23$result = Str::of('foo bar')->match('/bar/');45// 'bar'67$result = Str::of('foo bar')->match('/foo (.*)/');89// 'bar'
1use Illuminate\Support\Str;23$result = Str::of('foo bar')->match('/bar/');45// 'bar'67$result = Str::of('foo bar')->match('/foo (.*)/');89// 'bar'
matchAll
The matchAll
method will return a collection containing the portions of a string that match a given regular expression pattern:
1use Illuminate\Support\Str;23$result = Str::of('bar foo bar')->matchAll('/bar/');45// collect(['bar', 'bar'])
1use Illuminate\Support\Str;23$result = Str::of('bar foo bar')->matchAll('/bar/');45// collect(['bar', 'bar'])
If you specify a matching group within the expression, Laravel will return a collection of that group's matches:
1use Illuminate\Support\Str;23$result = Str::of('bar fun bar fly')->matchAll('/f(\w*)/');45// collect(['un', 'ly']);
1use Illuminate\Support\Str;23$result = Str::of('bar fun bar fly')->matchAll('/f(\w*)/');45// collect(['un', 'ly']);
If no matches are found, an empty collection will be returned.
newLine
The newLine
method appends an "end of line" character to a string:
1use Illuminate\Support\Str;23$padded = Str::of('Laravel')->newLine()->append('Framework');45// 'Laravel6// Framework'
1use Illuminate\Support\Str;23$padded = Str::of('Laravel')->newLine()->append('Framework');45// 'Laravel6// Framework'
padBoth
The padBoth
method wraps PHP's str_pad
function, padding both sides of a string with another string until the final string reaches the desired length:
1use Illuminate\Support\Str;23$padded = Str::of('James')->padBoth(10, '_');45// '__James___'67$padded = Str::of('James')->padBoth(10);89// ' James '
1use Illuminate\Support\Str;23$padded = Str::of('James')->padBoth(10, '_');45// '__James___'67$padded = Str::of('James')->padBoth(10);89// ' James '
padLeft
The padLeft
method wraps PHP's str_pad
function, padding the left side of a string with another string until the final string reaches the desired length:
1use Illuminate\Support\Str;23$padded = Str::of('James')->padLeft(10, '-=');45// '-=-=-James'67$padded = Str::of('James')->padLeft(10);89// ' James'
1use Illuminate\Support\Str;23$padded = Str::of('James')->padLeft(10, '-=');45// '-=-=-James'67$padded = Str::of('James')->padLeft(10);89// ' James'
padRight
The padRight
method wraps PHP's str_pad
function, padding the right side of a string with another string until the final string reaches the desired length:
1use Illuminate\Support\Str;23$padded = Str::of('James')->padRight(10, '-');45// 'James-----'67$padded = Str::of('James')->padRight(10);89// 'James '
1use Illuminate\Support\Str;23$padded = Str::of('James')->padRight(10, '-');45// 'James-----'67$padded = Str::of('James')->padRight(10);89// 'James '
pipe
The pipe
method allows you to transform the string by passing its current value to the given callable:
1use Illuminate\Support\Str;23$hash = Str::of('Laravel')->pipe('md5')->prepend('Checksum: ');45// 'Checksum: a5c95b86291ea299fcbe64458ed12702'67$closure = Str::of('foo')->pipe(function ($str) {8 return 'bar';9});1011// 'bar'
1use Illuminate\Support\Str;23$hash = Str::of('Laravel')->pipe('md5')->prepend('Checksum: ');45// 'Checksum: a5c95b86291ea299fcbe64458ed12702'67$closure = Str::of('foo')->pipe(function ($str) {8 return 'bar';9});1011// 'bar'
plural
The plural
method converts a singular word string to its plural form. This function supports any of the languages support by Laravel's pluralizer:
1use Illuminate\Support\Str;23$plural = Str::of('car')->plural();45// cars67$plural = Str::of('child')->plural();89// children
1use Illuminate\Support\Str;23$plural = Str::of('car')->plural();45// cars67$plural = Str::of('child')->plural();89// children
You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:
1use Illuminate\Support\Str;23$plural = Str::of('child')->plural(2);45// children67$plural = Str::of('child')->plural(1);89// child
1use Illuminate\Support\Str;23$plural = Str::of('child')->plural(2);45// children67$plural = Str::of('child')->plural(1);89// child
prepend
The prepend
method prepends the given values onto the string:
1use Illuminate\Support\Str;23$string = Str::of('Framework')->prepend('Laravel ');45// Laravel Framework
1use Illuminate\Support\Str;23$string = Str::of('Framework')->prepend('Laravel ');45// Laravel Framework
remove
The remove
method removes the given value or array of values from the string:
1use Illuminate\Support\Str;23$string = Str::of('Arkansas is quite beautiful!')->remove('quite');45// Arkansas is beautiful!
1use Illuminate\Support\Str;23$string = Str::of('Arkansas is quite beautiful!')->remove('quite');45// Arkansas is beautiful!
You may also pass false
as a second parameter to ignore case when removing strings.
replace
The replace
method replaces a given string within the string:
1use Illuminate\Support\Str;23$replaced = Str::of('Laravel 6.x')->replace('6.x', '7.x');45// Laravel 7.x
1use Illuminate\Support\Str;23$replaced = Str::of('Laravel 6.x')->replace('6.x', '7.x');45// Laravel 7.x
replaceArray
The replaceArray
method replaces a given value in the string sequentially using an array:
1use Illuminate\Support\Str;23$string = 'The event will take place between ? and ?';45$replaced = Str::of($string)->replaceArray('?', ['8:30', '9:00']);67// The event will take place between 8:30 and 9:00
1use Illuminate\Support\Str;23$string = 'The event will take place between ? and ?';45$replaced = Str::of($string)->replaceArray('?', ['8:30', '9:00']);67// The event will take place between 8:30 and 9:00
replaceFirst
The replaceFirst
method replaces the first occurrence of a given value in a string:
1use Illuminate\Support\Str;23$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceFirst('the', 'a');45// a quick brown fox jumps over the lazy dog
1use Illuminate\Support\Str;23$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceFirst('the', 'a');45// a quick brown fox jumps over the lazy dog
replaceLast
The replaceLast
method replaces the last occurrence of a given value in a string:
1use Illuminate\Support\Str;23$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceLast('the', 'a');45// the quick brown fox jumps over a lazy dog
1use Illuminate\Support\Str;23$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceLast('the', 'a');45// the quick brown fox jumps over a lazy dog
replaceMatches
The replaceMatches
method replaces all portions of a string matching a pattern with the given replacement string:
1use Illuminate\Support\Str;23$replaced = Str::of('(+1) 501-555-1000')->replaceMatches('/[^A-Za-z0-9]++/', '')45// '15015551000'
1use Illuminate\Support\Str;23$replaced = Str::of('(+1) 501-555-1000')->replaceMatches('/[^A-Za-z0-9]++/', '')45// '15015551000'
The replaceMatches
method also accepts a closure that will be invoked with each portion of the string matching the given pattern, allowing you to perform the replacement logic within the closure and return the replaced value:
1use Illuminate\Support\Str;23$replaced = Str::of('123')->replaceMatches('/\d/', function ($match) {4 return '['.$match[0].']';5});67// '[1][2][3]'
1use Illuminate\Support\Str;23$replaced = Str::of('123')->replaceMatches('/\d/', function ($match) {4 return '['.$match[0].']';5});67// '[1][2][3]'
rtrim
The rtrim
method trims the right side of the given string:
1use Illuminate\Support\Str;23$string = Str::of(' Laravel ')->rtrim();45// ' Laravel'67$string = Str::of('/Laravel/')->rtrim('/');89// '/Laravel'
1use Illuminate\Support\Str;23$string = Str::of(' Laravel ')->rtrim();45// ' Laravel'67$string = Str::of('/Laravel/')->rtrim('/');89// '/Laravel'
scan
The scan
method parses input from a string into a collection according to a format supported by the sscanf
PHP function:
1use Illuminate\Support\Str;23$collection = Str::of('filename.jpg')->scan('%[^.].%s');45// collect(['filename', 'jpg'])
1use Illuminate\Support\Str;23$collection = Str::of('filename.jpg')->scan('%[^.].%s');45// collect(['filename', 'jpg'])
singular
The singular
method converts a string to its singular form. This function supports any of the languages support by Laravel's pluralizer:
1use Illuminate\Support\Str;23$singular = Str::of('cars')->singular();45// car67$singular = Str::of('children')->singular();89// child
1use Illuminate\Support\Str;23$singular = Str::of('cars')->singular();45// car67$singular = Str::of('children')->singular();89// child
slug
The slug
method generates a URL friendly "slug" from the given string:
1use Illuminate\Support\Str;23$slug = Str::of('Laravel Framework')->slug('-');45// laravel-framework
1use Illuminate\Support\Str;23$slug = Str::of('Laravel Framework')->slug('-');45// laravel-framework
snake
The snake
method converts the given string to snake_case
:
1use Illuminate\Support\Str;23$converted = Str::of('fooBar')->snake();45// foo_bar
1use Illuminate\Support\Str;23$converted = Str::of('fooBar')->snake();45// foo_bar
split
The split
method splits a string into a collection using a regular expression:
1use Illuminate\Support\Str;23$segments = Str::of('one, two, three')->split('/[\s,]+/');45// collect(["one", "two", "three"])
1use Illuminate\Support\Str;23$segments = Str::of('one, two, three')->split('/[\s,]+/');45// collect(["one", "two", "three"])
squish
The squish
method removes all extraneous white space from a string, including extraneous white space between words:
1use Illuminate\Support\Str;23$string = Str::of(' laravel framework ')->squish();45// laravel framework
1use Illuminate\Support\Str;23$string = Str::of(' laravel framework ')->squish();45// laravel framework
start
The start
method adds a single instance of the given value to a string if it does not already start with that value:
1use Illuminate\Support\Str;23$adjusted = Str::of('this/string')->start('/');45// /this/string67$adjusted = Str::of('/this/string')->start('/');89// /this/string
1use Illuminate\Support\Str;23$adjusted = Str::of('this/string')->start('/');45// /this/string67$adjusted = Str::of('/this/string')->start('/');89// /this/string
startsWith
The startsWith
method determines if the given string begins with the given value:
1use Illuminate\Support\Str;23$result = Str::of('This is my name')->startsWith('This');45// true
1use Illuminate\Support\Str;23$result = Str::of('This is my name')->startsWith('This');45// true
studly
The studly
method converts the given string to StudlyCase
:
1use Illuminate\Support\Str;23$converted = Str::of('foo_bar')->studly();45// FooBar
1use Illuminate\Support\Str;23$converted = Str::of('foo_bar')->studly();45// FooBar
substr
The substr
method returns the portion of the string specified by the given start and length parameters:
1use Illuminate\Support\Str;23$string = Str::of('Laravel Framework')->substr(8);45// Framework67$string = Str::of('Laravel Framework')->substr(8, 5);89// Frame
1use Illuminate\Support\Str;23$string = Str::of('Laravel Framework')->substr(8);45// Framework67$string = Str::of('Laravel Framework')->substr(8, 5);89// Frame
substrReplace
The substrReplace
method replaces text within a portion of a string, starting at the position specified by the second argument and replacing the number of characters specified by the third argument. Passing 0
to the method's third argument will insert the string at the specified position without replacing any of the existing characters in the string:
1use Illuminate\Support\Str;2 3$string = Str::of('1300')->substrReplace<