Helpers

• Introduction
• Available Methods

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

Paths

Strings

Fluent Strings

URLs

Miscellaneous

Method Listing

Arrays & Objects

Arr::accessible() {.collection-method .first-collection-method}

The Arr::accessible method determines if the given value is array accessible:

use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);
// true
$isAccessible = Arr::accessible(new Collection);
// true
$isAccessible = Arr::accessible('abc');
// false
$isAccessible = Arr::accessible(new stdClass);
// false

Arr::add() {.collection-method}

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:

use Illuminate\Support\Arr;
$array = Arr::add(['name' => 'Desk'], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
// ['name' => 'Desk', 'price' => 100]

Arr::collapse() {.collection-method}

The Arr::collapse method collapses an array of arrays into a single array:

use Illuminate\Support\Arr;
$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
// [1, 2, 3, 4, 5, 6, 7, 8, 9]

Arr::crossJoin() {.collection-method}

The Arr::crossJoin method cross joins the given arrays, returning a Cartesian product with all possible permutations:

use Illuminate\Support\Arr;
$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
/*
    [
        [1, 'a'],
        [1, 'b'],
        [2, 'a'],
        [2, 'b'],
    ]
*/
$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
/*
    [
        [1, 'a', 'I'],
        [1, 'a', 'II'],
        [1, 'b', 'I'],
        [1, 'b', 'II'],
        [2, 'a', 'I'],
        [2, 'a', 'II'],
        [2, 'b', 'I'],
        [2, 'b', 'II'],
    ]
*/

Arr::divide() {.collection-method}

The Arr::divide method returns two arrays: one containing the keys and the other containing the values of the given array:

use Illuminate\Support\Arr;
[$keys, $values] = Arr::divide(['name' => 'Desk']);
// $keys: ['name']
// $values: ['Desk']

Arr::dot() {.collection-method}

The Arr::dot method flattens a multi-dimensional array into a single level array that uses “dot” notation to indicate depth:

use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$flattened = Arr::dot($array);
// ['products.desk.price' => 100]

Arr::except() {.collection-method}

The Arr::except method removes the given key / value pairs from an array:

use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$filtered = Arr::except($array, ['price']);
// ['name' => 'Desk']

Arr::exists() {.collection-method}

The Arr::exists method checks that the given key exists in the provided array:

use Illuminate\Support\Arr;
$array = ['name' => 'John Doe', 'age' => 17];
$exists = Arr::exists($array, 'name');
// true
$exists = Arr::exists($array, 'salary');
// false

Arr::first() {.collection-method}

The Arr::first method returns the first element of an array passing a given truth test:

use Illuminate\Support\Arr;
$array = [100, 200, 300];
$first = Arr::first($array, function ($value, $key) {
    return $value >= 150;
});
// 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:

use Illuminate\Support\Arr;
$first = Arr::first($array, $callback, $default);

Arr::flatten() {.collection-method}

The Arr::flatten method flattens a multi-dimensional array into a single level array:

use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$flattened = Arr::flatten($array);
// ['Joe', 'PHP', 'Ruby']

Arr::forget() {.collection-method}

The Arr::forget method removes a given key / value pair from a deeply nested array using “dot” notation:

use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::forget($array, 'products.desk');
// ['products' => []]

Arr::get() {.collection-method}

The Arr::get method retrieves a value from a deeply nested array using “dot” notation:

use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$price = Arr::get($array, 'products.desk.price');
// 100

The Arr::get method also accepts a default value, which will be returned if the specified key is not present in the array:

use Illuminate\Support\Arr;
$discount = Arr::get($array, 'products.desk.discount', 0);
// 0

Arr::has() {.collection-method}

The Arr::has method checks whether a given item or items exists in an array using “dot” notation:

use Illuminate\Support\Arr;
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = Arr::has($array, 'product.name');
// true
$contains = Arr::has($array, ['product.price', 'product.discount']);
// false

Arr::hasAny() {.collection-method}

The Arr::hasAny method checks whether any item in a given set exists in an array using “dot” notation:

use Illuminate\Support\Arr;
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = Arr::hasAny($array, 'product.name');
// true
$contains = Arr::hasAny($array, ['product.name', 'product.discount']);
// true
$contains = Arr::hasAny($array, ['category', 'product.discount']);
// false

Arr::isAssoc() {.collection-method}

The Arr::isAssoc 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:

use Illuminate\Support\Arr;
$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
// true
$isAssoc = Arr::isAssoc([1, 2, 3]);
// false

Arr::last() {.collection-method}

The Arr::last method returns the last element of an array passing a given truth test:

use Illuminate\Support\Arr;
$array = [100, 200, 300, 110];
$last = Arr::last($array, function ($value, $key) {
    return $value >= 150;
});
// 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:

use Illuminate\Support\Arr;
$last = Arr::last($array, $callback, $default);

Arr::only() {.collection-method}

The Arr::only method returns only the specified key / value pairs from the given array:

use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
$slice = Arr::only($array, ['name', 'price']);
// ['name' => 'Desk', 'price' => 100]

Arr::pluck() {.collection-method}

The Arr::pluck method retrieves all of the values for a given key from an array:

use Illuminate\Support\Arr;
$array = [
    ['developer' => ['id' => 1, 'name' => 'Taylor']],
    ['developer' => ['id' => 2, 'name' => 'Abigail']],
];
$names = Arr::pluck($array, 'developer.name');
// ['Taylor', 'Abigail']

You may also specify how you wish the resulting list to be keyed:

use Illuminate\Support\Arr;
$names = Arr::pluck($array, 'developer.name', 'developer.id');
// [1 => 'Taylor', 2 => 'Abigail']

Arr::prepend() {.collection-method}

The Arr::prepend method will push an item onto the beginning of an array:

use Illuminate\Support\Arr;
$array = ['one', 'two', 'three', 'four'];
$array = Arr::prepend($array, 'zero');
// ['zero', 'one', 'two', 'three', 'four']

If needed, you may specify the key that should be used for the value:

use Illuminate\Support\Arr;
$array = ['price' => 100];
$array = Arr::prepend($array, 'Desk', 'name');
// ['name' => 'Desk', 'price' => 100]

Arr::pull() {.collection-method}

The Arr::pull method returns and removes a key / value pair from an array:

use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$name = Arr::pull($array, 'name');
// $name: Desk
// $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:

use Illuminate\Support\Arr;
$value = Arr::pull($array, $key, $default);

Arr::query() {.collection-method}

The Arr::query method converts the array into a query string:

use Illuminate\Support\Arr;
$array = [
    'name' => 'Taylor',
    'order' => [
        'column' => 'created_at',
        'direction' => 'desc'
    ]
];
Arr::query($array);
// name=Taylor&order[column]=created_at&order[direction]=desc

Arr::random() {.collection-method}

The Arr::random method returns a random value from an array:

use Illuminate\Support\Arr;
$array = [1, 2, 3, 4, 5];
$random = Arr::random($array);
// 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:

use Illuminate\Support\Arr;
$items = Arr::random($array, 2);
// [2, 5] - (retrieved randomly)

Arr::set() {.collection-method}

The Arr::set method sets a value within a deeply nested array using “dot” notation:

use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::set($array, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]

Arr::shuffle() {.collection-method}

The Arr::shuffle method randomly shuffles the items in the array:

use Illuminate\Support\Arr;
$array = Arr::shuffle([1, 2, 3, 4, 5]);
// [3, 2, 5, 1, 4] - (generated randomly)

Arr::sort() {.collection-method}

The Arr::sort method sorts an array by its values:

use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sort($array);
// ['Chair', 'Desk', 'Table']

You may also sort the array by the results of a given closure:

use Illuminate\Support\Arr;
$array = [
    ['name' => 'Desk'],
    ['name' => 'Table'],
    ['name' => 'Chair'],
];
$sorted = array_values(Arr::sort($array, function ($value) {
    return $value['name'];
}));
/*
    [
        ['name' => 'Chair'],
        ['name' => 'Desk'],
        ['name' => 'Table'],
    ]
*/

Arr::sortRecursive() {.collection-method}

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:

use Illuminate\Support\Arr;
$array = [
    ['Roman', 'Taylor', 'Li'],
    ['PHP', 'Ruby', 'JavaScript'],
    ['one' => 1, 'two' => 2, 'three' => 3],
];
$sorted = Arr::sortRecursive($array);
/*
    [
        ['JavaScript', 'PHP', 'Ruby'],
        ['one' => 1, 'three' => 3, 'two' => 2],
        ['Li', 'Roman', 'Taylor'],
    ]
*/

Arr::toCssClasses() {.collection-method}

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:

use Illuminate\Support\Arr;
$isActive = false;
$hasError = true;
$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];
$classes = Arr::toCssClasses($array);
/*
    'p-4 bg-red'
*/

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() {.collection-method}

The Arr::undot method expands a single-dimensional array that uses “dot” notation into a multi-dimensional array:

use Illuminate\Support\Arr;
$array = [
    'user.name' => 'Kevin Malone',
    'user.occupation' => 'Accountant',
];
$array = Arr::undot($array);
// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]

Arr::where() {.collection-method}

The Arr::where method filters an array using the given closure:

use Illuminate\Support\Arr;
$array = [100, '200', 300, '400', 500];
$filtered = Arr::where($array, function ($value, $key) {
    return is_string($value);
});
// [1 => '200', 3 => '400']

Arr::whereNotNull() {.collection-method}

The Arr::whereNotNull method removes all null values from the given array:

use Illuminate\Support\Arr;
$array = [0, null];
$filtered = Arr::whereNotNull($array);
// [0 => 0]

Arr::wrap() {.collection-method}

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:

use Illuminate\Support\Arr;
$string = 'Laravel';
$array = Arr::wrap($string);
// ['Laravel']

If the given value is null, an empty array will be returned:

use Illuminate\Support\Arr;
$array = Arr::wrap(null);
// []

data_fill() {.collection-method}

The data_fill function sets a missing value within a nested array or object using “dot” notation:

$data = ['products' => ['desk' => ['price' => 100]]];
data_fill($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 100]]]
data_fill($data, 'products.desk.discount', 10);
// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]

This function also accepts asterisks as wildcards and will fill the target accordingly:

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2'],
    ],
];
data_fill($data, 'products.*.price', 200);
/*
    [
        'products' => [
            ['name' => 'Desk 1', 'price' => 100],
            ['name' => 'Desk 2', 'price' => 200],
        ],
    ]
*/

data_get() {.collection-method}

The data_get function retrieves a value from a nested array or object using “dot” notation:

$data = ['products' => ['desk' => ['price' => 100]]];
$price = data_get($data, 'products.desk.price');
// 100

The data_get function also accepts a default value, which will be returned if the specified key is not found:

$discount = data_get($data, 'products.desk.discount', 0);
// 0

The function also accepts wildcards using asterisks, which may target any key of the array or object:

$data = [
    'product-one' => ['name' => 'Desk 1', 'price' => 100],
    'product-two' => ['name' => 'Desk 2', 'price' => 150],
];
data_get($data, '*.name');
// ['Desk 1', 'Desk 2'];

data_set() {.collection-method}

The data_set function sets a value within a nested array or object using “dot” notation:

$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]

This function also accepts wildcards using asterisks and will set values on the target accordingly:

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2', 'price' => 150],
    ],
];
data_set($data, 'products.*.price', 200);
/*
    [
        'products' => [
            ['name' => 'Desk 1', 'price' => 200],
            ['name' => 'Desk 2', 'price' => 200],
        ],
    ]
*/

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:

$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200, $overwrite = false);
// ['products' => ['desk' => ['price' => 100]]]

head() {.collection-method}

The head function returns the first element in the given array:

$array = [100, 200, 300];
$first = head($array);
// 100

last() {.collection-method}

The last function returns the last element in the given array:

$array = [100, 200, 300];
$last = last($array);
// 300

Paths

app_path() {.collection-method}

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:

$path = app_path();
$path = app_path('Http/Controllers/Controller.php');

base_path() {.collection-method}

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:

$path = base_path();
$path = base_path('vendor/bin');

config_path() {.collection-method}

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:

$path = config_path();
$path = config_path('app.php');

database_path() {.collection-method}

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:

$path = database_path();
$path = database_path('factories/UserFactory.php');

mix() {.collection-method}

The mix function returns the path to a versioned Mix file:

$path = mix('css/app.css');

public_path() {.collection-method}

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:

$path = public_path();
$path = public_path('css/app.css');

resource_path() {.collection-method}

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:

$path = resource_path();
$path = resource_path('sass/app.scss');

storage_path() {.collection-method}

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:

$path = storage_path();
$path = storage_path('app/file.txt');

Strings

__() {.collection-method}

The __ function translates the given translation string or translation key using your localization files:

echo __('Welcome to our application');
echo __('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() {.collection-method}

The class_basename function returns the class name of the given class with the class’s namespace removed:

$class = class_basename('Foo\Bar\Baz');
// Baz

e() {.collection-method}

The e function runs PHP’s htmlspecialchars function with the double_encode option set to true by default:

echo e('<html>foo</html>');
// &lt;html&gt;foo&lt;/html&gt;

preg_replace_array() {.collection-method}

The preg_replace_array function replaces a given pattern in the string sequentially using an array:

$string = 'The event will take place between :start and :end';
$replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string);
// The event will take place between 8:30 and 9:00

Str::after() {.collection-method}

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:

use Illuminate\Support\Str;
$slice = Str::after('This is my name', 'This is');
// ' my name'

Str::afterLast() {.collection-method}

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:

use Illuminate\Support\Str;
$slice = Str::afterLast('App\Http\Controllers\Controller', '\\');
// 'Controller'

Str::ascii() {.collection-method}

The Str::ascii method will attempt to transliterate the string into an ASCII value:

use Illuminate\Support\Str;
$slice = Str::ascii('û');
// 'u'

Str::before() {.collection-method}

The Str::before method returns everything before the given value in a string:

use Illuminate\Support\Str;
$slice = Str::before('This is my name', 'my name');
// 'This is '

Str::beforeLast() {.collection-method}

The Str::beforeLast method returns everything before the last occurrence of the given value in a string:

use Illuminate\Support\Str;
$slice = Str::beforeLast('This is my name', 'is');
// 'This '

Str::between() {.collection-method}

The Str::between method returns the portion of a string between two values:

use Illuminate\Support\Str;
$slice = Str::between('This is my name', 'This', 'name');
// ' is my '

Str::camel() {.collection-method}

The Str::camel method converts the given string to camelCase:

use Illuminate\Support\Str;
$converted = Str::camel('foo_bar');
// fooBar

Str::contains() {.collection-method}

The Str::contains method determines if the given string contains the given value. This method is case sensitive:

use Illuminate\Support\Str;
$contains = Str::contains('This is my name', 'my');
// true

You may also pass an array of values to determine if the given string contains any of the values in the array:

use Illuminate\Support\Str;
$contains = Str::contains('This is my name', ['my', 'foo']);
// true

Str::containsAll() {.collection-method}

The Str::containsAll method determines if the given string contains all of the values in a given array:

use Illuminate\Support\Str;
$containsAll = Str::containsAll('This is my name', ['my', 'name']);
// true

Str::endsWith() {.collection-method}

The Str::endsWith method determines if the given string ends with the given value:

use Illuminate\Support\Str;
$result = Str::endsWith('This is my name', 'name');
// true

You may also pass an array of values to determine if the given string ends with any of the values in the array:

use Illuminate\Support\Str;
$result = Str::endsWith('This is my name', ['name', 'foo']);
// true
$result = Str::endsWith('This is my name', ['this', 'foo']);
// false

Str::finish() {.collection-method}

The Str::finish method adds a single instance of the given value to a string if it does not already end with that value:

use Illuminate\Support\Str;
$adjusted = Str::finish('this/string', '/');
// this/string/
$adjusted = Str::finish('this/string/', '/');
// this/string/

Str::headline() {.collection-method}

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:

use Illuminate\Support\Str;
$headline = Str::headline('steve_jobs');
// Steve Jobs
$headline = Str::headline('EmailNotificationSent');
// Email Notification Sent

Str::is() {.collection-method}

The Str::is method determines if a given string matches a given pattern. Asterisks may be used as wildcard values:

use Illuminate\Support\Str;
$matches = Str::is('foo*', 'foobar');
// true
$matches = Str::is('baz*', 'foobar');
// false

Str::isAscii() {.collection-method}

The Str::isAscii method determines if a given string is 7 bit ASCII:

use Illuminate\Support\Str;
$isAscii = Str::isAscii('Taylor');
// true
$isAscii = Str::isAscii('ü');
// false

Str::isUuid() {.collection-method}

The Str::isUuid method determines if the given string is a valid UUID:

use Illuminate\Support\Str;
$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');
// true
$isUuid = Str::isUuid('laravel');
// false

Str::kebab() {.collection-method}

The Str::kebab method converts the given string to kebab-case:

use Illuminate\Support\Str;
$converted = Str::kebab('fooBar');
// foo-bar

Str::length() {.collection-method}

The Str::length method returns the length of the given string:

use Illuminate\Support\Str;
$length = Str::length('Laravel');
// 7

Str::limit() {.collection-method}

The Str::limit method truncates the given string to the specified length:

use Illuminate\Support\Str;
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);
// 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:

use Illuminate\Support\Str;
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');
// The quick brown fox (...)

Str::lower() {.collection-method}

The Str::lower method converts the given string to lowercase:

use Illuminate\Support\Str;
$converted = Str::lower('LARAVEL');
// laravel

Str::markdown() {.collection-method}

The Str::markdown method converts GitHub flavored Markdown into HTML:

use Illuminate\Support\Str;
$html = Str::markdown('# Laravel');
// <h1>Laravel</h1>
$html = Str::markdown('# Taylor <b>Otwell</b>', [
    'html_input' => 'strip',
]);
// <h1>Taylor Otwell</h1>

Str::mask() {.collection-method}

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:

use Illuminate\Support\Str;
$string = Str::mask('taylor@example.com', '*', 3);
// 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:

$string = Str::mask('taylor@example.com', '*', -15, 3);
// tay***@example.com

Str::orderedUuid() {.collection-method}

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:

use Illuminate\Support\Str;
return (string) Str::orderedUuid();

Str::padBoth() {.collection-method}

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:

use Illuminate\Support\Str;
$padded = Str::padBoth('James', 10, '_');
// '__James___'
$padded = Str::padBoth('James', 10);
// '  James   '

Str::padLeft() {.collection-method}

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:

use Illuminate\Support\Str;
$padded = Str::padLeft('James', 10, '-=');
// '-=-=-James'
$padded = Str::padLeft('James', 10);
// '     James'

Str::padRight() {.collection-method}

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:

use Illuminate\Support\Str;
$padded = Str::padRight('James', 10, '-');
// 'James-----'
$padded = Str::padRight('James', 10);
// 'James     '

Str::plural() {.collection-method}

The Str::plural method converts a singular word string to its plural form. This function currently only supports the English language:

use Illuminate\Support\Str;
$plural = Str::plural('car');
// cars
$plural = Str::plural('child');
// children

You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:

use Illuminate\Support\Str;
$plural = Str::plural('child', 2);
// children
$singular = Str::plural('child', 1);
// child

Str::pluralStudly() {.collection-method}

The Str::pluralStudly method converts a singular word string formatted in studly caps case to its plural form. This function currently only supports the English language:

use Illuminate\Support\Str;
$plural = Str::pluralStudly('VerifiedHuman');
// VerifiedHumans
$plural = Str::pluralStudly('UserFeedback');
// UserFeedback

You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:

use Illuminate\Support\Str;
$plural = Str::pluralStudly('VerifiedHuman', 2);
// VerifiedHumans
$singular = Str::pluralStudly('VerifiedHuman', 1);
// VerifiedHuman

Str::random() {.collection-method}

The Str::random method generates a random string of the specified length. This function uses PHP’s random_bytes function:

use Illuminate\Support\Str;
$random = Str::random(40);

Str::remove() {.collection-method}

The Str::remove method removes the given value or array of values from the string:

use Illuminate\Support\Str;
$string = 'Peter Piper picked a peck of pickled peppers.';
$removed = Str::remove('e', $string);
// 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() {.collection-method}

The Str::replace method replaces a given string within the string:

use Illuminate\Support\Str;
$string = 'Laravel 8.x';
$replaced = Str::replace('8.x', '9.x', $string);
// Laravel 9.x

Str::replaceArray() {.collection-method}

The Str::replaceArray method replaces a given value in the string sequentially using an array:

use Illuminate\Support\Str;
$string = 'The event will take place between ? and ?';
$replaced = Str::replaceArray('?', ['8:30', '9:00'], $string);
// The event will take place between 8:30 and 9:00

Str::replaceFirst() {.collection-method}

The Str::replaceFirst method replaces the first occurrence of a given value in a string:

use Illuminate\Support\Str;
$replaced = Str::replaceFirst('the', 'a', 'the quick brown fox jumps over the lazy dog');
// a quick brown fox jumps over the lazy dog

Str::replaceLast() {.collection-method}

The Str::replaceLast method replaces the last occurrence of a given value in a string:

use Illuminate\Support\Str;
$replaced = Str::replaceLast('the', 'a', 'the quick brown fox jumps over the lazy dog');
// the quick brown fox jumps over a lazy dog

Str::reverse() {.collection-method}

The Str::reverse method reverses the given string:

use Illuminate\Support\Str;
$reversed = Str::reverse('Hello World');
// dlroW olleH

Str::singular() {.collection-method}

The Str::singular method converts a string to its singular form. This function currently only supports the English language:

use Illuminate\Support\Str;
$singular = Str::singular('cars');
// car
$singular = Str::singular('children');
// child

Str::slug() {.collection-method}

The Str::slug method generates a URL friendly “slug” from the given string:

use Illuminate\Support\Str;
$slug = Str::slug('Laravel 5 Framework', '-');
// laravel-5-framework

Str::snake() {.collection-method}

The Str::snake method converts the given string to snake_case:

use Illuminate\Support\Str;
$converted = Str::snake('fooBar');
// foo_bar
$converted = Str::snake('fooBar', '-');
// foo-bar

Str::start() {.collection-method}

The Str::start method adds a single instance of the given value to a string if it does not already start with that value:

use Illuminate\Support\Str;
$adjusted = Str::start('this/string', '/');
// /this/string
$adjusted = Str::start('/this/string', '/');
// /this/string

Str::startsWith() {.collection-method}

The Str::startsWith method determines if the given string begins with the given value:

use Illuminate\Support\Str;
$result = Str::startsWith('This is my name', 'This');
// 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:

$result = Str::startsWith('This is my name', ['This', 'That', 'There']);
// true

Str::studly() {.collection-method}

The Str::studly method converts the given string to StudlyCase:

use Illuminate\Support\Str;
$converted = Str::studly('foo_bar');
// FooBar

Str::substr() {.collection-method}

The Str::substr method returns the portion of string specified by the start and length parameters:

use Illuminate\Support\Str;
$converted = Str::substr('The Laravel Framework', 4, 7);
// Laravel

Str::substrCount() {.collection-method}

The Str::substrCount method returns the number of occurrences of a given value in the given string:

use Illuminate\Support\Str;
$count = Str::substrCount('If you like ice cream, you will like snow cones.', 'like');
// 2

Str::substrReplace() {.collection-method}

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:

use Illuminate\Support\Str;
$result = Str::substrReplace('1300', ':', 2); 
// 13:
$result = Str::substrReplace('1300', ':', 2, 0); 
// 13:00

Str::swap() {.collection-method}

The Str::swap method replaces multiple values in the given string using PHP’s strtr function:

use Illuminate\Support\Str;
$string = Str::swap([
    'Tacos' => 'Burritos',
    'great' => 'fantastic',
], 'Tacos are great!');
// Burritos are fantastic!

Str::title() {.collection-method}

The Str::title method converts the given string to Title Case:

use Illuminate\Support\Str;
$converted = Str::title('a nice title uses the correct case');
// A Nice Title Uses The Correct Case

Str::toHtmlString() {.collection-method}

The Str::toHtmlString method converts the string instance to an instance of Illuminate\Support\HtmlString, which may be displayed in Blade templates:

use Illuminate\Support\Str;
$htmlString = Str::of('Nuno Maduro')->toHtmlString();

Str::ucfirst() {.collection-method}

The Str::ucfirst method returns the given string with the first character capitalized:

use Illuminate\Support\Str;
$string = Str::ucfirst('foo bar');
// Foo bar

Str::upper() {.collection-method}

The Str::upper method converts the given string to uppercase:

use Illuminate\Support\Str;
$string = Str::upper('laravel');
// LARAVEL

Str::uuid() {.collection-method}

The Str::uuid method generates a UUID (version 4):

use Illuminate\Support\Str;
return (string) Str::uuid();

Str::wordCount() {.collection-method}

The Str::wordCount method returns the number of words that a string contains:

use Illuminate\Support\Str;
Str::wordCount('Hello, world!'); // 2

Str::words() {.collection-method}

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:

use Illuminate\Support\Str;
return Str::words('Perfectly balanced, as all things should be.', 3, ' >>>');
// Perfectly balanced, as >>>

str() {.collection-method}

The str function returns a new Illuminate\Support\Stringable instance of the given string. This function is equivalent to the Str::of method:

$string = str('Taylor')->append(' Otwell');
// 'Taylor Otwell'

If no argument is provided to the str function, the function returns an instance of Illuminate\Support\Str:

$snake = str()->snake('FooBar');
// 'foo_bar'

trans() {.collection-method}

The trans function translates the given translation key using your localization files:

echo 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() {.collection-method}

The trans_choice function translates the given translation key with inflection:

echo 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 {.collection-method}

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:

use Illuminate\Support\Str;
$slice = Str::of('This is my name')->after('This is');
// ' my name'

afterLast {.collection-method}

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:

use Illuminate\Support\Str;
$slice = Str::of('App\Http\Controllers\Controller')->afterLast('\\');
// 'Controller'

append {.collection-method}

The append method appends the given values to the string:

use Illuminate\Support\Str;
$string = Str::of('Taylor')->append(' Otwell');
// 'Taylor Otwell'

ascii {.collection-method}

The ascii method will attempt to transliterate the string into an ASCII value:

use Illuminate\Support\Str;
$string = Str::of('ü')->ascii();
// 'u'

basename {.collection-method}

The basename method will return the trailing name component of the given string:

use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->basename();
// 'baz'

If needed, you may provide an “extension” that will be removed from the trailing component:

use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz.jpg')->basename('.jpg');
// 'baz'

before {.collection-method}

The before method returns everything before the given value in a string:

use Illuminate\Support\Str;
$slice = Str::of('This is my name')->before('my name');
// 'This is '

beforeLast {.collection-method}

The beforeLast method returns everything before the last occurrence of the given value in a string:

use Illuminate\Support\Str;
$slice = Str::of('This is my name')->beforeLast('is');
// 'This '

between {.collection-method}

The between method returns the portion of a string between two values:

use Illuminate\Support\Str;
$converted = Str::of('This is my name')->between('This', 'name');
// ' is my '

camel {.collection-method}

The camel method converts the given string to camelCase:

use Illuminate\Support\Str;
$converted = Str::of('foo_bar')->camel();
// fooBar

contains {.collection-method}

The contains method determines if the given string contains the given value. This method is case sensitive:

use Illuminate\Support\Str;
$contains = Str::of('This is my name')->contains('my');
// true

You may also pass an array of values to determine if the given string contains any of the values in the array:

use Illuminate\Support\Str;
$contains = Str::of('This is my name')->contains(['my', 'foo']);
// true

containsAll {.collection-method}

The containsAll method determines if the given string contains all of the values in the given array:

use Illuminate\Support\Str;
$containsAll = Str::of('This is my name')->containsAll(['my', 'name']);
// true

dirname {.collection-method}

The dirname method returns the parent directory portion of the given string:

use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->dirname();
// '/foo/bar'

If necessary, you may specify how many directory levels you wish to trim from the string:

use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->dirname(2);
// '/foo'

endsWith {.collection-method}

The endsWith method determines if the given string ends with the given value:

use Illuminate\Support\Str;
$result = Str::of('This is my name')->endsWith('name');
// true

You may also pass an array of values to determine if the given string ends with any of the values in the array:

use Illuminate\Support\Str;
$result = Str::of('This is my name')->endsWith(['name', 'foo']);
// true
$result = Str::of('This is my name')->endsWith(['this', 'foo']);
// false

exactly {.collection-method}

The exactly method determines if the given string is an exact match with another string:

use Illuminate\Support\Str;
$result = Str::of('Laravel')->exactly('Laravel');
// true

explode {.collection-method}

The explode method splits the string by the given delimiter and returns a collection containing each section of the split string:

use Illuminate\Support\Str;
$collection = Str::of('foo bar baz')->explode(' ');
// collect(['foo', 'bar', 'baz'])

finish {.collection-method}

The finish method adds a single instance of the given value to a string if it does not already end with that value:

use Illuminate\Support\Str;
$adjusted = Str::of('this/string')->finish('/');
// this/string/
$adjusted = Str::of('this/string/')->finish('/');
// this/string/

is {.collection-method}

The is method determines if a given string matches a given pattern. Asterisks may be used as wildcard values

use Illuminate\Support\Str;
$matches = Str::of('foobar')->is('foo*');
// true
$matches = Str::of('foobar')->is('baz*');
// false

isAscii {.collection-method}

The isAscii method determines if a given string is an ASCII string:

use Illuminate\Support\Str;
$result = Str::of('Taylor')->isAscii();
// true
$result = Str::of('ü')->isAscii();
// false