イントロダクションIntroduction
Laravelはさまざまな、グローバル「ヘルパ」PHP関数を用意しています。これらの多くはフレームワーク自身で使用されています。便利なものが見つかれば、皆さんのアプリケーションでも大いに活用してください。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文字列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
URLURLs
その他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() Arr::accessible()
Arr::accessibleメソッドは、指定した値が配列アクセス可能かどうかを判別します。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() Arr::add()
Arr::addメソッドは指定キー／値のペアをそのキーが存在していない場合とnullがセットされている場合に、配列に追加します。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() Arr::collapse()
Arr::collapseメソッドは配列の配列を一次元の配列へ展開します。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() Arr::crossJoin()
Arr::crossJoinメソッドは指定配列をクロス結合し、可能性があるすべての順列の直積集合を返します。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() Arr::divide()
Arr::divideメソッドは２つの配列を返します。１つは指定した配列のキーを含み、もう１つは値を含みます。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() Arr::dot()
Arr::dotメソッドは多次元配列を「ドット」記法で深さを表した一次元配列に変換します。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() Arr::except()
Arr::exceptメソッドは指定キー／値ペアを配列から削除します。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() Arr::exists()
Arr::existsメソッドは指定キーが指定配列に存在するかをチェックします。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() Arr::first()
Arr::firstメソッドは指定したテストにパスした最初の要素を返します。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() Arr::flatten()
Arr::flattenメソッドは、多次元配列を一次元配列へ変換します。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() Arr::forget()
Arr::forgetメソッドは「ドット記法」で指定キー／値のペアを深くネストされた配列から取り除きます。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() Arr::get()
Arr::getメソッドは「ドット」記法で指定した値を深くネストされた配列から取得します。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
Arr::getメソッドはデフォルト値も引数に取ります。これは、指定したキーが配列で存在しない場合に返されます。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() Arr::has()
Arr::hasメソッドは、「ドット」記法で指定したアイテムが配列に存在するかをチェックします。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() Arr::hasAny()
Arr::hasAnyメソッドは「ドット」記法を使い、配列中に一連のアイテムが存在するかを調べます。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() Arr::isAssoc()
Arr::isAssocメソッドは、指定した配列が連想配列である場合、trueを返します。配列が0から始まる連続したキーを持たない場合、その配列を「連想配列」であると見なします。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:
use Illuminate\Support\Arr;
$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
// true
$isAssoc = Arr::isAssoc([1, 2, 3]);
// false
Arr::isList() Arr::isList()
Arr::isListメソッドは、指定した配列のキーが0から始まる連続した整数である場合、trueを返します。The Arr::isList method returns true if the given array's keys are sequential integers beginning from zero:
use Illuminate\Support\Arr;
$isList = Arr::isList(['foo', 'bar', 'baz']);
// true
$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);
// false
Arr::join() Arr::join()
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:
use Illuminate\Support\Arr;
$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];
$joined = Arr::join($array, ', ');
// Tailwind, Alpine, Laravel, Livewire
$joined = Arr::join($array, ', ', ' and ');
// Tailwind, Alpine, Laravel and Livewire
Arr::keyBy() Arr::keyBy()
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:
use Illuminate\Support\Arr;
$array = [
['product_id' => 'prod-100', 'name' => 'Desk'],
['product_id' => 'prod-200', 'name' => 'Chair'],
];
$keyed = Arr::keyBy($array, 'product_id');
/*
[
'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
]
*/
Arr::last() Arr::last()
Arr::lastメソッドは、テストでパスした最後の配列要素を返します。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::map() Arr::map()
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:
use Illuminate\Support\Arr;
$array = ['first' => 'james', 'last' => 'kirk'];
$mapped = Arr::map($array, function ($value, $key) {
return ucfirst($value);
});
// ['first' => 'James', 'last' => 'Kirk']
Arr::only() Arr::only()
Arr::onlyメソッドは配列中に存在する、指定したキー／値ペアのアイテムのみを返します。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() Arr::pluck()
Arr::pluckメソッドは配列中の指定キーに対する値をすべて取得します。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() Arr::prepend()
Arr::prependメソッドは配列の先頭にアイテムを追加します。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::prependKeysWith() Arr::prependKeysWith()
Arr::prependKeysWithは、連想配列のすべてのキー名の前に、指定したプレフィックスを付加します。The Arr::prependKeysWith prepends all key names of an associative array with the given prefix:
use Illuminate\Support\Arr;
$array = [
'name' => 'Desk',
'price' => 100,
];
$keyed = Arr::prependKeysWith($array, 'product.');
/*
[
'product.name' => 'Desk',
'product.price' => 100,
]
*/
Arr::pull() Arr::pull()
Arr::pullメソッドは配列から指定キー／値ペアを取得し、同時に削除します。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() Arr::query()
Arr::queryメソッドは配列をクエリ文字列へ変換します。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() Arr::random()
Arr::randomメソッドは配列からランダムに値を返します。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() Arr::set()
Arr::setメソッドは「ドット」記法を使用し、深くネストした配列に値をセットします。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() Arr::shuffle()
Arr::shuffleメソッドは、配列中のアイテムをランダムにシャッフルします。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] - (無作為に入れ替えた結果)
Arr::sort() Arr::sort()
Arr::sortメソッドは、配列の値に基づきソートします。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::sortDesc() Arr::sortDesc()
Arr::sortDescメソッドは、配列を値の降順でソートします。The Arr::sortDesc method sorts an array in descending order by its values:
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sortDesc($array);
// ['Table', 'Desk', 'Chair']
また、指定クロージャの結果により、配列をソートすることもできます。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::sortDesc($array, function ($value) {
return $value['name'];
}));
/*
[
['name' => 'Table'],
['name' => 'Desk'],
['name' => 'Chair'],
]
*/
Arr::sortRecursive() Arr::sortRecursive()
Arr::sortRecursiveメソッドは、数値インデックス付きサブ配列の場合はsort関数を使用し、連想サブ配列の場合はksort関数を使用して、配列を再帰的に並べ替えます。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() Arr::toCssClasses()
Arr::toCssClassesは、CSSクラス文字列を条件付きでコンパイルします。この方法はクラスの配列を引数に取り、配列キーに追加したいクラス、値は論理式です。配列要素に数字キーがある場合は、レンダするクラスリストへ常に含めます。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'
*/
このメソッドは、Bladeコンポーネントのアトリビュートバッグを使ったクラスのマージと、@class Bladeディレクティブを提供するLaravelの機能を強化します。This method powers Laravel's functionality allowing merging classes with a Blade component's attribute bag[/docs/{{version}}/blade#conditionally-merge-classes] as well as the @class Blade directive[/docs/{{version}}/blade#conditional-classes].
Arr::undot() Arr::undot()
Arr::undotメソッドは、「ドット」記法を用いた一次元配列を多次元配列へ展開します。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() Arr::where()
Arr::whereメソッドは、指定したクロージャを使用して配列をフィルタリングします。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() Arr::whereNotNull()
Arr::whereNotNullメソッドは、指定する配列からすべてのnull値を削除します。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() Arr::wrap()
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:
use Illuminate\Support\Arr;
$string = 'Laravel';
$array = Arr::wrap($string);
// ['Laravel']
指定値がnullの場合、空の配列を返します。If the given value is null, an empty array will be returned:
use Illuminate\Support\Arr;
$array = Arr::wrap(null);
// []
data_fill() data_fill()
data_fill関数は「ドット」記法を使用し、ターゲットの配列やオブジェクトへ足りない値をセットします。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() data_get()
data_get関数は「ドット」記法を使用し、ネストした配列やオブジェクトから値を取得します。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
data_get関数は、指定したキーが存在しない場合に返す、デフォルト値も指定できます。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() data_set()
data_set関数は「ドット」記法を使用し、ネストした配列やオブジェクトに値をセットします。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],
]
]
*/
デフォルトでは、既存の値はすべて上書きされます。値が存在しない場合にのみ値をセットする場合は、関数の4番目の引数にfalseを渡してください。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() head()
head関数は、配列の最初の要素を返します。The head function returns the first element in the given array:
$array = [100, 200, 300];
$first = head($array);
// 100
last() last()
last関数は指定した配列の最後の要素を返します。The last function returns the last element in the given array:
$array = [100, 200, 300];
$last = last($array);
// 300
パスPaths
app_path() app_path()
app_path関数は、アプリケーションのappディレクトリの完全修飾パスを返します。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:
$path = app_path();
$path = app_path('Http/Controllers/Controller.php');
base_path() base_path()
base_path関数は、アプリケーションのルートディレクトリへの完全修飾パスを返します。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:
$path = base_path();
$path = base_path('vendor/bin');
config_path() config_path()
config_path関数は、アプリケーションのconfigディレクトリへの完全修飾パスを返します。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:
$path = config_path();
$path = config_path('app.php');
database_path() database_path()
database_path関数は、アプリケーションのdatabaseディレクトリへの完全修飾パスを返します。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:
$path = database_path();
$path = database_path('factories/UserFactory.php');
lang_path() lang_path()
lang_path関数は、アプリケーションのlangディレクトリの完全修飾パスを返します。また、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:
$path = lang_path();
$path = lang_path('en/messages.php');
mix() mix()
mix関数は、バージョンつけしたMixファイルのパスを取得します。The mix function returns the path to a versioned Mix file[/docs/{{version}}/mix]:
$path = mix('css/app.css');
public_path() public_path()
public_path関数は、アプリケーションのpublicディレクトリへの完全修飾パスを返します。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:
$path = public_path();
$path = public_path('css/app.css');
resource_path() resource_path()
resource_path関数は、アプリケーションのresourcesディレクトリへの完全修飾パスを返します。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:
$path = resource_path();
$path = resource_path('sass/app.scss');
storage_path() storage_path()
storage_path関数は、アプリケーションのstorageディレクトリへの完全修飾パスを返します。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:
$path = storage_path();
$path = storage_path('app/file.txt');
文字列Strings
__() __()
__関数は、指定した翻訳文字列か翻訳キーをローカリゼーションファイルを使用し、翻訳します。The __ function translates the given translation string or translation key using your localization files[/docs/{{version}}/localization]:
echo __('Welcome to our application');
echo __('messages.welcome');
指定した翻訳文字列や翻訳キーが存在しない場合、__関数は指定値をそのまま返します。たとえば、上記の場合に翻訳キーが存在しなければ、__関数は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() class_basename()
class_basename関数は、指定クラスの名前から名前空間を取り除いて返します。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() e()
e関数は、PHPのhtmlspecialchars関数をdouble_encodeオプションにデフォルトでtrueを指定し、実行します。The e function runs PHP's htmlspecialchars function with the double_encode option set to true by default:
echo e('<html>foo</html>');
// <html>foo</html>
preg_replace_array() preg_replace_array()
preg_replace_array関数は、指定パターンを順番に配列中の値に置き換えます。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() Str::after()
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:
use Illuminate\Support\Str;
$slice = Str::after('This is my name', 'This is');
// ' my name'
Str::afterLast() Str::afterLast()
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:
use Illuminate\Support\Str;
$slice = Str::afterLast('App\Http\Controllers\Controller', '\');
// 'Controller'
Str::ascii() Str::ascii()
Str::asciiメソッドは文字列をASCII値へ変換しようと試みます。The Str::ascii method will attempt to transliterate the string into an ASCII value:
use Illuminate\Support\Str;
$slice = Str::ascii('û');
// 'u'
Str::before() Str::before()
Str::before関数は、文字列中の指定値より前の文字列を全部返します。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() Str::beforeLast()
Str::beforeLastメソッドは、文字列で指定値が現れる最後の場所から、前の部分を返します。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() Str::between()
Str::betweenメソッドは、２つの値間の部分文字列を返します。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::betweenFirst() Str::betweenFirst()
Str::betweenFirstメソッドは、２つの値の間にある文字列のうち、可能な限り小さい部分を返します。The Str::betweenFirst method returns the smallest possible portion of a string between two values:
use Illuminate\Support\Str;
$slice = Str::betweenFirst('[a] bc [d]', '[', ']');
// 'a'
Str::camel() Str::camel()
Str::camelメソッドは、文字列をキャメルケース（camelCase）へ変換します。The Str::camel method converts the given string to camelCase:
use Illuminate\Support\Str;
$converted = Str::camel('foo_bar');
// fooBar
Str::contains() Str::contains()
Str::containsメソッドは、指定文字列に指定値が含まれているかどうかを判別します。このメソッドは大文字と小文字を区別します。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() Str::containsAll()
Str::containsAllメソッドは、指定文字列に指定配列のすべての値が含まれているかどうかを判別します。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() Str::endsWith()
Str::endsWithメソッドは、最初の文字列が２つ目の引数の文字列で終わっているか判定します。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::excerpt() Str::excerpt()
Str::excerptメソッドは指定した文字列から、その文字列内のフレーズの最初のインスタンスにマッチする部分を抜き出します。The Str::excerpt method extracts an excerpt from a given string that matches the first instance of a phrase within that string:
use Illuminate\Support\Str;
$excerpt = Str::excerpt('This is my name', 'my', [
'radius' => 3
]);
// '...is my na...'
radiusオプションはデフォルトが100で、抜き出した文字列の両側に表示する文字数を定義します。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.
さらに、omissionオプションを使い、抜き出した文字列の前後に追加する文字列を定義できます。In addition, you may use the omission option to define the string that will be prepended and appended to the truncated string:
use Illuminate\Support\Str;
$excerpt = Str::excerpt('This is my name', 'name', [
'radius' => 3,
'omission' => '(...) '
]);
// '(...) my name'
Str::finish() Str::finish()
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:
use Illuminate\Support\Str;
$adjusted = Str::finish('this/string', '/');
// this/string/
$adjusted = Str::finish('this/string/', '/');
// this/string/
Str::headline() Str::headline()
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:
use Illuminate\Support\Str;
$headline = Str::headline('steve_jobs');
// Steve Jobs
$headline = Str::headline('EmailNotificationSent');
// Email Notification Sent
Str::inlineMarkdown() Str::inlineMarkdown()
Str::inlineMarkdownメソッドは、GitHub仕様のMarkdownをCommonMarkにより、インラインHTMLへ変換します。しかし、markdownメソッドとは異なり、生成したすべてのHTMLをブロックレベルの要素中へラップはできません。The Str::inlineMarkdown method converts GitHub flavored Markdown into inline HTML using CommonMark[https://commonmark.thephpleague.com/]. However, unlike the markdown method, it does not wrap all generated HTML in a block-level element:
use Illuminate\Support\Str;
$html = Str::inlineMarkdown('**Laravel**');
// <strong>Laravel</strong>
Str::is() Str::is()
Str::isメソッドは、指定文字列が指定パターンに一致するかどうかを判別します。アスタリスクをワイルドカード値として使用できます。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() Str::isAscii()
Str::isAsciiメソッドは、指定文字列が7ビットASCIIであるかを判定します。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::isJson() Str::isJson()
Str::isJsonメソッドは、指定文字列が有効なJSONであるかを判定します。The Str::isJson method determines if the given string is valid JSON:
use Illuminate\Support\Str;
$result = Str::isJson('[1,2,3]');
// true
$result = Str::isJson('{"first": "John", "last": "Doe"}');
// true
$result = Str::isJson('{first: "John", last: "Doe"}');
// false
Str::isUlid() Str::isUlid()
Str::isUlidメソッドは、指定文字列が有効なULIDであることを判定します。The Str::isUlid method determines if the given string is a valid ULID:
use Illuminate\Support\Str;
$isUlid = Str::isUlid('01gd6r360bp37zj17nxb55yv40');
// true
$isUlid = Str::isUlid('laravel');
// false
Str::isUuid() Str::isUuid()
Str::isUuidメソッドは、指定した文字列が有効なUUIDであることを判定します。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() Str::kebab()
Str::kebabメソッドは、指定した文字列をケバブケース（kebab-case）に変換します。The Str::kebab method converts the given string to kebab-case:
use Illuminate\Support\Str;
$converted = Str::kebab('fooBar');
// foo-bar
Str::lcfirst() Str::lcfirst()
Str::lcfirstメソッドは、指定した文字列の最初の文字を小文字に変換して返します。The Str::lcfirst method returns the given string with the first character lowercased:
use Illuminate\Support\Str;
$string = Str::lcfirst('Foo Bar');
// foo Bar
Str::length() Str::length()
Str::lengthメソッドは、指定文字列の長さを返します。The Str::length method returns the length of the given string:
use Illuminate\Support\Str;
$length = Str::length('Laravel');
// 7
Str::limit() Str::limit()
Str::limitメソッドは、指定文字列を指定する長さへ切り捨てます。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() Str::lower()
Str::lowerメソッドは指定文字列を小文字に変換します。The Str::lower method converts the given string to lowercase:
use Illuminate\Support\Str;
$converted = Str::lower('LARAVEL');
// laravel
Str::markdown() Str::markdown()
Str::markdownメソッドは、GitHub風なマークダウンをHTMLへ、CommonMarkを用い変換します。The Str::markdown method converts GitHub flavored Markdown into HTML using CommonMark[https://commonmark.thephpleague.com/]:
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() Str::mask()
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:
use Illuminate\Support\Str;
$string = Str::mask('taylor@example.com', '*', 3);
// tay***************
必要であれば、maskメソッドの第３引数に負の数を指定し、文字列の最後から指定する文字数分戻った箇所からマスキングを開始するように指示できます。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() Str::orderedUuid()
Str::orderedUuidメソッドは、インデックス付きデータベース列に効率的に格納できる「タイムスタンプファースト」UUIDを生成します。このメソッドを使用して生成した各UUIDは、以前にこのメソッドを使用して生成されたUUIDの後にソートされます。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() Str::padBoth()
Str::padBothメソッドは、PHPのstr_pad関数をラップし、最後の文字列が目的の長さに達するまで、文字列の両側を別の文字列でパディングします。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() Str::padLeft()
String::padLeftメソッドは、PHPのstr_pad関数をラップし、最後の文字列が目的の長さに達するまで、文字列の左側を別の文字列でパディングします。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() Str::padRight()
String::padRightメソッドは、PHPのstr_pad関数をラップし、最後の文字列が目的の長さに達するまで、文字列の右側を別の文字列でパディングします。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() Str::plural()
Str::pluralメソッドは、単数形の単語文字列を複数形に変換します。この関数は、Laravelの複数形化機能により、どんな言語もサポートしています。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[/docs/{{version}}/localization#pluralization-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() Str::pluralStudly()
Str::pluralStudlyメソッドは、アッパーキャメルケースでフォーマットされた文字列の単語を複数形に変換します。この関数は、Laravelの複数形化機能により、どんな言語もサポートしています。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[/docs/{{version}}/localization#pluralization-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() Str::random()
Str::randomメソッドは指定した長さのランダムな文字列を生成します。このメソッドは、PHPのrandom_bytes関数を使用します。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() Str::remove()
Str::removeメソッドは、文字列から指定する値または値の配列を削除します。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.
文字列を削除するときにケースを無視するには、removeメソッドの３番目の引数にfalseを渡してください。You may also pass false as a third argument to the remove method to ignore case when removing strings.
Str::replace() Str::replace()
Str::replaceメソッドは、文字列内の指定した文字列を置き換えます。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() Str::replaceArray()
Str::replaceArrayメソッドは配列を使い、文字列を指定値へ順番に置き換えます。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() Str::replaceFirst()
Str::replaceFirstメソッドは、文字列中で最初に出現した値を指定値で置き換えます。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() Str::replaceLast()
Str::replaceLastメソッドは、文字列中で最後に出現した値を指定値で置き換えます。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() Str::reverse()
Str::reverseメソッドは、指定文字列を逆順にします。The Str::reverse method reverses the given string:
use Illuminate\Support\Str;
$reversed = Str::reverse('Hello World');
// dlroW olleH
Str::singular() Str::singular()
Str::singularメソッドは複数形を単数形へ変換します。この関数は、Laravelの複数形化機能により、どんな言語もサポートしています。The Str::singular method converts a string to its singular form. This function supports any of the languages support by Laravel's pluralizer[/docs/{{version}}/localization#pluralization-language]:
use Illuminate\Support\Str;
$singular = Str::singular('cars');
// car
$singular = Str::singular('children');
// child
Str::slug() Str::slug()
Str::slugメソッドは指定された文字列から、URLフレンドリーな「スラグ」を生成します。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() Str::snake()
Str::snakeメソッドは文字列をスネークケース（snake_case）に変換します。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::squish() Str::squish()
Str::squishメソッドは、単語間の余分な空白を含め、文字列から余分な空白をすべて削除します。The Str::squish method removes all extraneous white space from a string, including extraneous white space between words:
use Illuminate\Support\Str;
$string = Str::squish(' laravel framework ');
// laravel framework
Str::start() Str::start()
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:
use Illuminate\Support\Str;
$adjusted = Str::start('this/string', '/');
// /this/string
$adjusted = Str::start('/this/string', '/');
// /this/string
Str::startsWith() Str::startsWith()
Str::startsWithメソッドは指定文字列が、２番めの引数の文字列で始まっているか判定します。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
可能な値の配列が渡された場合、startsWithメソッドは、文字列が与えられた値のいずれかで始まる場合に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() Str::studly()
Str::studlyメソッドは文字列をアッパーキャメルケース（StudlyCase）に変換します。The Str::studly method converts the given string to StudlyCase:
use Illuminate\Support\Str;
$converted = Str::studly('foo_bar');
// FooBar
Str::substr() Str::substr()
Str::substrメソッドは開始位置と文字列長の引数で指定した部分文字列を返します。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() Str::substrCount()
Str::substrCountメソッドは、指定する文字列内に指定値がいくつ存在しているか返します。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() Str::substrReplace()
Str::substrReplaceメソッドは、文字列の一部分のテキストを置き換えます。第３引数で指定した位置から始まり、第４引数で指定した文字数分を置き換えます。このメソッドの第４引数へ0を渡すと、文字列内の既存の文字を一切置き換えず、指定位置に文字列を挿入します。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() Str::swap()
Str::swapメソッドは、PHPのstrtr関数を使い、指定した文字列中の複数の値を置き換えます。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() Str::title()
Str::titleメソッドは、指定された文字列をタイトルケース（Title Case）へ変換します。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() Str::toHtmlString()
Str::toHtmlStringメソッドは、文字列インスタンスをIlluminate\Support\HtmlStringインスタンスに変換し、Blade テンプレートで表示できるようにします。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() Str::ucfirst()
Str::ucfirstメソッドは、指定文字列の最初の文字を大文字にして返します。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::ucsplit() Str::ucsplit()
Str::ucsplitメソッドは、指定した文字列を文字列を大文字で分割して配列にします。The Str::ucsplit method splits the given string into an array by uppercase characters:
use Illuminate\Support\Str;
$segments = Str::ucsplit('FooBar');
// [0 => 'Foo', 1 => 'Bar']
Str::upper() Str::upper()
Str::upperメソッドは、指定文字列を大文字に変換します。The Str::upper method converts the given string to uppercase:
use Illuminate\Support\Str;
$string = Str::upper('laravel');
// LARAVEL
Str::ulid() Str::ulid()
Str::ulidメソッドは、ULIDを生成します。The Str::ulid method generates a ULID:
use Illuminate\Support\Str;
return (string) Str::ulid();
// 01gd6r360bp37zj17nxb55yv40
Str::uuid() Str::uuid()
Str::uuidメソッドは、UUID（バージョン４）を生成します。The Str::uuid method generates a UUID (version 4):
use Illuminate\Support\Str;
return (string) Str::uuid();
Str::wordCount() Str::wordCount()
Str::wordCount関数は、文字列に含まれる単語の数を返します。The Str::wordCount method returns the number of words that a string contains:
use Illuminate\Support\Str;
Str::wordCount('Hello, world!'); // 2
Str::words() Str::words()
Str::wordsメソッドは、文字列内の単語数を制限します。3番目の引数で、切り捨てた文字列の末尾に追加する文字列を指定できます。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() str()
str関数は、指定した文字列の新しいIlluminate\Support\Stringableインスタンスを返します。この関数は Str::ofメソッドと等価です。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'
str関数に引数を与えなかった場合、Illuminate\Support\Strのインスタンスを返します。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() trans()
trans関数は、指定した翻訳キーをローカリゼーションファイルを使用し翻訳します。The trans function translates the given translation key using your localization files[/docs/{{version}}/localization]:
echo trans('messages.welcome');
指定した翻訳キーが存在しない場合、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() trans_choice()
trans_choice関数は、数値をもとにし、指定翻訳キーを翻訳します。The trans_choice function translates the given translation key with inflection:
echo trans_choice('messages.notifications', $unreadCount);
指定した翻訳キーが存在しない場合、trans_choice関数は指定値をそのまま返します。上記の場合に翻訳キーが存在しなければ、messages.welcomeが返ります。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文字列Fluent Strings
Fluent文字列は読み書きしやすい（fluent）、オブジェクト指向で、複数の文字列操作をチェーンできるインターフェイスを提供します。古典的な文字列操作に比較すると、複数の文字列操作を読みやすい文法で使用できます。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 after
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:
use Illuminate\Support\Str;
$slice = Str::of('This is my name')->after('This is');
// ' my name'
afterLast afterLast
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:
use Illuminate\Support\Str;
$slice = Str::of('App\Http\Controllers\Controller')->afterLast('\\');
// 'Controller'
append append
appendメソッドは、指定値を文字列へ追加します。The append method appends the given values to the string:
use Illuminate\Support\Str;
$string = Str::of('Taylor')->append(' Otwell');
// 'Taylor Otwell'
ascii ascii
asciiメソッドは、文字列をアスキー値への変換を試みます。The ascii method will attempt to transliterate the string into an ASCII value:
use Illuminate\Support\Str;
$string = Str::of('ü')->ascii();
// 'u'
basename basename
basenameメソッドは、文字列の最後の名前部分を返します。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 before
before関数は、文字列中の指定値より前の文字列を全部返します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 beforeLast
beforeLastメソッドは、文字列中で最初に指定値が現れる場所から、前の部分を返します。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 between
betweenメソッドは、２つの値の間にある文字列を返します。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 '
betweenFirst betweenFirst
betweenFirstメソッドは、2つの値の間にある文字列のうち、可能な限り小さい部分を返します。The betweenFirst method returns the smallest possible portion of a string between two values:
use Illuminate\Support\Str;
$converted = Str::of('[a] bc [d]')->betweenFirst('[', ']');
// 'a'
camel camel
camelメソッドは、文字列をキャメルケース（camelCase）へ変換しますThe camel method converts the given string to camelCase:
use Illuminate\Support\Str;
$converted = Str::of('foo_bar')->camel();
// fooBar
classBasename classBasename
classBasenameメソッドは、指定したクラスから名前空間を削除したクラス名を返す。The classBasename method returns the class name of the given class with the class's namespace removed:
use Illuminate\Support\Str;
$class = Str::of('Foo\Bar\Baz')->classBasename();
// Baz
contains contains
containsメソッドは、指定された文字列に指定された値が含まれているかどうかを判別します。このメソッドは大文字と小文字を区別します。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 containsAll
containsAllメソッドは、指定文字列に指定配列のすべての値が含まれているかどうかを判別します。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 dirname
dirnameメソッドは文字列の親ディレクトリ名部分を返します。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'
excerpt excerpt
excerptメソッドは文字列から、その文字列内のフレーズの最初のインスタンスにマッチする部分を抜粋して抜き出します。The excerpt method extracts an excerpt from the string that matches the first instance of a phrase within that string:
use Illuminate\Support\Str;
$excerpt = Str::of('This is my name')->excerpt('my', [
'radius' => 3
]);
// '...is my na...'
radiusオプションはデフォルトが100で、抜き出した文字列の両側に表示する文字数を定義します。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.
さらに、omissionオプションを使い、抜き出した文字列の前後に追加する文字列を定義できます。In addition, you may use the omission option to change the string that will be prepended and appended to the truncated string:
use Illuminate\Support\Str;
$excerpt = Str::of('This is my name')->excerpt('name', [
'radius' => 3,
'omission' => '(...) '
]);
// '(...) my name'
endsWith endsWith
endsWithメソッドは、文字列が指定値で終わっているか判定します。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 exactly
exactlyメソッドは、文字列と指定値が完全に一致することを判定します。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 explode
explodeメソッドは文字列を指定デリミッタで分割し、分割した文字列を含むコレクションを返します。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 finish
finishメソッドは、文字列が指定値で終わっていない場合、その値の単一のインスタンスを追加します。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/
headline headline
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:
use Illuminate\Support\Str;
$headline = Str::of('taylor_otwell')->headline();
// Taylor Otwell
$headline = Str::of('EmailNotificationSent')->headline();
// Email Notification Sent
inlineMarkdown inlineMarkdown
inlineMarkdownメソッドは、GitHub仕様のMarkdownをCommonMarkにより、インラインHTMLへ変換します。しかし、markdownメソッドとは異なり、生成したすべてのHTMLをブロックレベルの要素中へラップはできません。The inlineMarkdown method converts GitHub flavored Markdown into inline HTML using CommonMark[https://commonmark.thephpleague.com/]. However, unlike the markdown method, it does not wrap all generated HTML in a block-level element:
use Illuminate\Support\Str;
$html = Str::of('**Laravel**')->inlineMarkdown();
// <strong>Laravel</strong>
is is
isメソッドは、指定文字列が指定パターンに一致するかどうかを判別します。アスタリスクはワイルドカード値として使用できます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 isAscii
isAsciiメソッドは、文字列がASCII文字列であるか判定します。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
isEmpty isEmpty
isEmptyメソッドは、文字列が空であるか判定します。The isEmpty method determines if the given string is empty:
use Illuminate\Support\Str;
$result = Str::of(' ')->trim()->isEmpty();
// true
$result = Str::of('Laravel')->trim()->isEmpty();
// false
isNotEmpty isNotEmpty
isNotEmptyメソッドは、文字列が空でないかを判定します。The isNotEmpty method determines if the given string is not empty:
use Illuminate\Support\Str;
$result = Str::of(' ')->trim()->isNotEmpty();
// false
$result = Str::of('Laravel')->trim()->isNotEmpty();
// true
isJson isJson
isJsonメソッドは、指定文字列が有効なJSONであるかを判定します。The isJson method determines if a given string is valid JSON:
use Illuminate\Support\Str;
$result = Str::of('[1,2,3]')->isJson();
// true
$result = Str::of('{"first": "John", "last": "Doe"}')->isJson();
// true
$result = Str::of('{first: "John", last: "Doe"}')->isJson();
// false
isUlid isUlid
isUlidメソッドは、指定文字列が有効なULIDであることを判定します。The isUlid method determines if a given string is a ULID:
use Illuminate\Support\Str;
$result = Str::of('01gd6r360bp37zj17nxb55yv40')->isUlid();
// true
$result = Str::of('Taylor')->isUlid();
// false
isUuid isUuid
isUuidメソッドは、文字列がUUIDかを判定します。The isUuid method determines if a given string is a UUID:
use Illuminate\Support\Str;
$result = Str::of('5ace9ab9-e9cf-4ec6-a19d-5881212a452c')->isUuid();
// true
$result = Str::of('Taylor')->isUuid();
// false
kebab kebab
kebabメソッドは、文字列をケバブケース（kebab-case）へ変換します。The kebab method converts the given string to kebab-case:
use Illuminate\Support\Str;
$converted = Str::of('fooBar')->kebab();
// foo-bar
lcfirst lcfirst
lcfirstメソッドは、指定した文字列の最初の文字を小文字にしたものを返します。The lcfirst method returns the given string with the first character lowercased:
use Illuminate\Support\Str;
$string = Str::of('Foo Bar')->lcfirst();
// foo Bar
length length
lengthメソッドは、文字列の長さを返します。The length method returns the length of the given string:
use Illuminate\Support\Str;
$length = Str::of('Laravel')->length();
// 7
limit limit
limitメソッドは、指定文字列を指定した長さに切り捨てます。The limit method truncates the given string to the specified length:
use Illuminate\Support\Str;
$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20);
// 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:
use Illuminate\Support\Str;
$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20, ' (...)');
// The quick brown fox (...)
lower lower
lowerメソッドは、文字列を小文字に変換します。The lower method converts the given string to lowercase:
use Illuminate\Support\Str;
$result = Str::of('LARAVEL')->lower();
// 'laravel'
ltrim ltrim
ltrimメソッドは、文字列の左側をトリムします。The ltrim method trims the left side of the string:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->ltrim();
// 'Laravel '
$string = Str::of('/Laravel/')->ltrim('/');
// 'Laravel/'
markdown markdown
markdownメソッドはGitHub風マークダウンをHTMLに変換します。The markdown method converts GitHub flavored Markdown into HTML:
use Illuminate\Support\Str;
$html = Str::of('# Laravel')->markdown();
// <h1>Laravel</h1>
$html = Str::of('# Taylor <b>Otwell</b>')->markdown([
'html_input' => 'strip',
]);
// <h1>Taylor Otwell</h1>
mask mask
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:
use Illuminate\Support\Str;
$string = Str::of('taylor@example.com')->mask('*', 3);
// tay***************
必要であれば、maskメソッドの第３・４引数に負の数を指定し、文字列の最後から指定する文字数分戻った箇所からマスキングを開始するように指示できます。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:
$string = Str::of('taylor@example.com')->mask('*', -15, 3);
// tay***@example.com
$string = Str::of('taylor@example.com')->mask('*', 4, -4);
// tayl**********.com
match match
matchメソッドは、指定した正規表現パターンに一致する部分文字列を返します。The match method will return the portion of a string that matches a given regular expression pattern:
use Illuminate\Support\Str;
$result = Str::of('foo bar')->match('/bar/');
// 'bar'
$result = Str::of('foo bar')->match('/foo (.*)/');
// 'bar'
matchAll matchAll
matchAllメソッドは、指定した正規表現パターンに一致した部分文字列を含むコレクションを返します。The matchAll method will return a collection containing the portions of a string that match a given regular expression pattern:
use Illuminate\Support\Str;
$result = Str::of('bar foo bar')->matchAll('/bar/');
// collect(['bar', 'bar'])
正規表現にマッチンググループを指定した場合は、そのグループに一致するコレクションを返します。If you specify a matching group within the expression, Laravel will return a collection of that group's matches:
use Illuminate\Support\Str;
$result = Str::of('bar fun bar fly')->matchAll('/f(\w*)/');
// collect(['un', 'ly']);
一致しなかった場合は、空のコレクションを返します。If no matches are found, an empty collection will be returned.
newLine newLine
newLineメソッドは、文字列に「行末」コードを追加します。The newLine method appends an "end of line" character to a string:
use Illuminate\Support\Str;
$padded = Str::of('Laravel')->newLine()->append('Framework');
// 'Laravel
// Framework'
padBoth padBoth
padBothメソッドはPHPのstr_pad関数をラップし、最後の文字列が目的の長さに達するまで、文字列の両側を別の文字列でパディングします。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:
use Illuminate\Support\Str;
$padded = Str::of('James')->padBoth(10, '_');
// '__James___'
$padded = Str::of('James')->padBoth(10);
// ' James '
padLeft padLeft
padLeftメソッドはPHPのstr_pad関数をラップし、最後の文字列が目的の長さに達するまで、文字列の左側を別の文字列でパディングします。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:
use Illuminate\Support\Str;
$padded = Str::of('James')->padLeft(10, '-=');
// '-=-=-James'
$padded = Str::of('James')->padLeft(10);
// ' James'
padRight padRight
padRightメソッドはPHPのstr_pad関数をラップし、最後の文字列が目的の長さに達するまで、文字列の右側を別の文字列でパディングします。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:
use Illuminate\Support\Str;
$padded = Str::of('James')->padRight(10, '-');
// 'James-----'
$padded = Str::of('James')->padRight(10);
// 'James '
pipe pipe
pipeメソッドは、現在の値を指定Callableへ渡すことで、文字列を変換します。The pipe method allows you to transform the string by passing its current value to the given callable:
use Illuminate\Support\Str;
$hash = Str::of('Laravel')->pipe('md5')->prepend('Checksum: ');
// 'Checksum: a5c95b86291ea299fcbe64458ed12702'
$closure = Str::of('foo')->pipe(function ($str) {
return 'bar';
});
// 'bar'
plural plural
pluralメソッドは、単数形の単語文字列を複数形に変換します。この関数は、Laravelの複数形化機能により、どんな言語もサポートしています。The plural method converts a singular word string to its plural form. This function supports any of the languages support by Laravel's pluralizer[/docs/{{version}}/localization#pluralization-language]:
use Illuminate\Support\Str;
$plural = Str::of('car')->plural();
// cars
$plural = Str::of('child')->plural();
// 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::of('child')->plural(2);
// children
$plural = Str::of('child')->plural(1);
// child
prepend prepend
prependメソッドは、指定値を文字列の先頭へ追加します。The prepend method prepends the given values onto the string:
use Illuminate\Support\Str;
$string = Str::of('Framework')->prepend('Laravel ');
// Laravel Framework
remove remove
removeメソッドは、指定する値か文字列の配列を文字列から削除します。The remove method removes the given value or array of values from the string:
use Illuminate\Support\Str;
$string = Str::of('Arkansas is quite beautiful!')->remove('quite');
// Arkansas is beautiful!
文字列削除時にケースを無視するため２番目のパラメータへfalseを渡すこともできます。You may also pass false as a second parameter to ignore case when removing strings.
replace replace
replaceメソッドは、文字列中の指定値を置き換えます。The replace method replaces a given string within the string:
use Illuminate\Support\Str;
$replaced = Str::of('Laravel 6.x')->replace('6.x', '7.x');
// Laravel 7.x
replaceArray replaceArray
replaceArrayメソッドは、配列を使用して文字列中の指定値を置き換えます。The 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::of($string)->replaceArray('?', ['8:30', '9:00']);
// The event will take place between 8:30 and 9:00
replaceFirst replaceFirst
replaceFirstメソッドは、文字列中で最初に現れた指定値を置き換えます。The replaceFirst method replaces the first occurrence of a given value in a string:
use Illuminate\Support\Str;
$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceFirst('the', 'a');
// a quick brown fox jumps over the lazy dog
replaceLast replaceLast
replaceLastメソッドは文字列中で最後に現れた指定値を置き換えます。The replaceLast method replaces the last occurrence of a given value in a string:
use Illuminate\Support\Str;
$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceLast('the', 'a');
// the quick brown fox jumps over a lazy dog
replaceMatches replaceMatches
replaceMatchesメソッドは、パターンに一致する文字列のすべての部分を、指定した置換文字列で置き換えます。The replaceMatches method replaces all portions of a string matching a pattern with the given replacement string:
use Illuminate\Support\Str;
$replaced = Str::of('(+1) 501-555-1000')->replaceMatches('/[^A-Za-z0-9]++/', '')
// '15015551000'
replaceMatchesメソッドは、指定したパターンに一致する文字列の各部分で呼び出されるクロージャも受け入れます。これにより、クロージャ内で置換ロジックを実行し、置換した値を返せます。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:
use Illuminate\Support\Str;
$replaced = Str::of('123')->replaceMatches('/\d/', function ($match) {
return '['.$match[0].']';
});
// '[1][2][3]'
rtrim rtrim
rtrimメソッドは、指定した文字列の右側をトリムします。The rtrim method trims the right side of the given string:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->rtrim();
// ' Laravel'
$string = Str::of('/Laravel/')->rtrim('/');
// '/Laravel'
scan scan
scan メソッドは、sscanf PHP関数がサポートするフォーマットに従い、文字列からコレクションへの入力をパースします。The scan method parses input from a string into a collection according to a format supported by the sscanf PHP function[https://www.php.net/manual/en/function.sscanf.php]:
use Illuminate\Support\Str;
$collection = Str::of('filename.jpg')->scan('%[^.].%s');
// collect(['filename', 'jpg'])
singular singular
singularメソッドは、単語を単数形に変換します。この関数は、Laravelの複数形化機能により、どんな言語もサポートしています。The singular method converts a string to its singular form. This function supports any of the languages support by Laravel's pluralizer[/docs/{{version}}/localization#pluralization-language]:
use Illuminate\Support\Str;
$singular = Str::of('cars')->singular();
// car
$singular = Str::of('children')->singular();
// child
slug slug
slugメソッドは、文字列をURLフレンドリーな「スラグ」へ変換します。The slug method generates a URL friendly "slug" from the given string:
use Illuminate\Support\Str;
$slug = Str::of('Laravel Framework')->slug('-');
// laravel-framework
snake snake
The snake method converts the given string to snakeメソッドは、文字列をスネークケース（snake_case）へ変換します。The snake method converts the given string to snake_case:
use Illuminate\Support\Str;
$converted = Str::of('fooBar')->snake();
// foo_bar
split split
splitメソッドは正規表現を使い文字列をコレクションへ分割します。The split method splits a string into a collection using a regular expression:
use Illuminate\Support\Str;
$segments = Str::of('one, two, three')->split('/[\s,]+/');
// collect(["one", "two", "three"])
squish squish
squishメソッドは、単語間の余分な空白を含め、文字列から余分な空白をすべて削除します。The squish method removes all extraneous white space from a string, including extraneous white space between words:
use Illuminate\Support\Str;
$string = Str::of(' laravel framework ')->squish();
// laravel framework
start start
startメソッドは、文字列が指定値で開始されていない場合、その値の単一のインスタンスを追加します。The 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::of('this/string')->start('/');
// /this/string
$adjusted = Str::of('/this/string')->start('/');
// /this/string
startsWith startsWith
startsWithメソッドは、文字列が指定値から始まっているかを判定します。The startsWith method determines if the given string begins with the given value:
use Illuminate\Support\Str;
$result = Str::of('This is my name')->startsWith('This');
// true
studly studly
studlyメソッドは、文字列をアッパーキャメルケース（StudlyCase）へ変換します。The studly method converts the given string to StudlyCase:
use Illuminate\Support\Str;
$converted = Str::of('foo_bar')->studly();
// FooBar
substr substr
substrメソッドは、引数で指定された開始位置と長さの部分文字列を返します。The substr method returns the portion of the string specified by the given start and length parameters:
use Illuminate\Support\Str;
$string = Str::of('Laravel Framework')->substr(8);
// Framework
$string = Str::of('Laravel Framework')->substr(8, 5);
// Frame
substrReplace substrReplace
substrReplaceメソッドは、文字列の一部分のテキストを置き換えるもので、第２引数で指定した位置から始まり、第３引数で指定した文字数分を置き換えます。このメソッドの第3引数に0を渡すと、文字列内の既存の文字を一切置き換えることなく、指定された位置に文字列を挿入します。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:
use Illuminate\Support\Str;
$string = Str::of('1300')->substrReplace(':', 2);
// 13:
$string = Str::of('The Framework')->substrReplace(' Laravel', 3, 0);
// The Laravel Framework
swap swap
swapメソッドは、PHPのstrtr関数を用いて、文字列内の複数の値を置き換えます。The swap method replaces multiple values in the string using PHP's strtr function:
use Illuminate\Support\Str;
$string = Str::of('Tacos are great!')
->swap([
'Tacos' => 'Burritos',
'great' => 'fantastic',
]);
// Burritos are fantastic!
tap tap
tapメソッドは文字列を指定クロージャへ渡し、その文字列自体に影響を与えずに文字列を調べ操作することができます。クロージャが返す値に関係なく、tapメソッドはオリジナルの文字列を返します。The tap method passes the string to the given closure, allowing you to examine and interact with the string while not affecting the string itself. The original string is returned by the tap method regardless of what is returned by the closure:
use Illuminate\Support\Str;
$string = Str::of('Laravel')
->append(' Framework')
->tap(function ($string) {
dump('String after append: '.$string);
})
->upper();
// LARAVEL FRAMEWORK
test test
testメソッドは、文字列が指定する正規表現パターンと一致するか判定します。The test method determines if a string matches the given regular expression pattern:
use Illuminate\Support\Str;
$result = Str::of('Laravel Framework')->test('/Laravel/');
// true
title title
titleメソッドは、文字列をタイトルケース（Title Case）へ変換します。The title method converts the given string to Title Case:
use Illuminate\Support\Str;
$converted = Str::of('a nice title uses the correct case')->title();
// A Nice Title Uses The Correct Case
trim trim
trimメソッドは、文字列をトリムします。The trim method trims the given string:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->trim();
// 'Laravel'
$string = Str::of('/Laravel/')->trim('/');
// 'Laravel'
ucfirst ucfirst
ucfirstメソッドは、文字列の最初の１文字目を大文字にします。The ucfirst method returns the given string with the first character capitalized:
use Illuminate\Support\Str;
$string = Str::of('foo bar')->ucfirst();
// Foo bar
ucsplit ucsplit
ucsplitメソッドは、指定した文字列を文字列を大文字で分割して配列にします。The ucsplit method splits the given string into a collection by uppercase characters:
use Illuminate\Support\Str;
$string = Str::of('Foo Bar')->ucsplit();
// collect(['Foo', 'Bar'])
upper upper
upperメソッドは、文字列を大文字に変換します。The upper method converts the given string to uppercase:
use Illuminate\Support\Str;
$adjusted = Str::of('laravel')->upper();
// LARAVEL
when when
whenメソッドは指定条件がtrueの場合、指定したクロージャを呼び出します。クロージャは、fluent文字列インスタンスを受け取ります。The when method invokes the given closure if a given condition is true. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('Taylor')
->when(true, function ($string) {
return $string->append(' Otwell');
});
// 'Taylor Otwell'
必要であれば、３番目のパラメータとして別のクロージャをwhenメソッドに渡せます。このクロージャは、条件パラメータがfalseと評価された場合に実行します。If necessary, you may pass another closure as the third parameter to the when method. This closure will execute if the condition parameter evaluates to false.
whenContains whenContains
whenContainsメソッドは、文字列が指定値を含んでいる場合に、渡したクロージャを呼び出します。クロージャは、Fluent文字列のインスタンスを受け取ります。The whenContains method invokes the given closure if the string contains the given value. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('tony stark')
->whenContains('tony', function ($string) {
return $string->title();
});
// 'Tony Stark'
必要であれば、whenメソッドの第３パラメータへ、もう一つクロージャを渡せます。このクロージャは、文字列が指定値を含んでいない場合に実行されます。If necessary, you may pass another closure as the third parameter to the when method. This closure will execute if the string does not contain the given value.
値の配列を渡して、指定文字列に配列内の値が含まれているかどうかを判断することもできます。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;
$string = Str::of('tony stark')
->whenContains(['tony', 'hulk'], function ($string) {
return $string->title();
});
// Tony Stark
whenContainsAll whenContainsAll
whenContainsAllメソッドは、文字列が指定する部分文字列をすべて含んでいる場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列のインスタンスを受け取ります。The whenContainsAll method invokes the given closure if the string contains all of the given sub-strings. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('tony stark')
->whenContainsAll(['tony', 'stark'], function ($string) {
return $string->title();
});
// 'Tony Stark'
必要であれば、３番目のパラメータとして別のクロージャをwhenメソッドに渡せます。このクロージャは、条件パラメータがfalseと評価された場合に実行します。If necessary, you may pass another closure as the third parameter to the when method. This closure will execute if the condition parameter evaluates to false.
whenEmpty whenEmpty
文字列が空の場合、whenEmptyメソッドは指定されたクロージャを呼び出します。クロージャが値を返す場合、その値をwhenEmptyメソッドも返します。クロージャが値を返さない場合、fluent文字列インスタンスを返します。The whenEmpty method invokes the given closure if the string is empty. If the closure returns a value, that value will also be returned by the whenEmpty method. If the closure does not return a value, the fluent string instance will be returned:
use Illuminate\Support\Str;
$string = Str::of(' ')->whenEmpty(function ($string) {
return $string->trim()->prepend('Laravel');
});
// 'Laravel'
whenNotEmpty whenNotEmpty
whenNotEmptyメソッドは文字列が空でない場合、指定するクロージャを呼び出します。クロージャが値を返す場合は、whenNotEmptyメソッドもその値を返します 。クロージャが値を返さない場合は、Fluent文字列インスタンスを返します。The whenNotEmpty method invokes the given closure if the string is not empty. If the closure returns a value, that value will also be returned by the whenNotEmpty method. If the closure does not return a value, the fluent string instance will be returned:
use Illuminate\Support\Str;
$string = Str::of('Framework')->whenNotEmpty(function ($string) {
return $string->prepend('Laravel ');
});
// 'Laravel Framework'
whenStartsWith whenStartsWith
whenStartsWithメソッドは、文字列が指定する部分文字列から始まる場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。The whenStartsWith method invokes the given closure if the string starts with the given sub-string. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('disney world')->whenStartsWith('disney', function ($string) {
return $string->title();
});
// 'Disney World'
whenEndsWith whenEndsWith
whenEndsWithメソッドは、文字列が指定した部分文字列で終了する場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。The whenEndsWith method invokes the given closure if the string ends with the given sub-string. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('disney world')->whenEndsWith('world', function ($string) {
return $string->title();
});
// 'Disney World'
whenExactly whenExactly
whenExactlyメソッドは、文字列が指定文字列と厳密に一致する場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。The whenExactly method invokes the given closure if the string exactly matches the given string. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('laravel')->whenExactly('laravel', function ($string) {
return $string->title();
});
// 'Laravel'
whenNotExactly whenNotExactly
whenNotExactlyメソッドは、文字列が指定文字列と厳密に一致しない場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。The whenNotExactly method invokes the given closure if the string does not exactly match the given string. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('framework')->whenNotExactly('laravel', function ($string) {
return $string->title();
});
// 'Framework'
whenIs whenIs
whenIsメソッドは、文字列が与えられたパターンにマッチする場合、指定クロージャを呼び出します。アスタリスクはワイルドカードとして使用できます。クロージャはFluent文字列インスタンスを受け取ります。The whenIs method invokes the given closure if the string matches a given pattern. Asterisks may be used as wildcard values. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('foo/bar')->whenIs('foo/*', function ($string) {
return $string->append('/baz');
});
// 'foo/bar/baz'
whenIsAscii whenIsAscii
whenIsAsciiメソッドは、文字列が7bitのASCIIの場合、クロージャを呼び出します。クロージャはFluent文字列インスタンスを受け取ります。The whenIsAscii method invokes the given closure if the string is 7 bit ASCII. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('laravel')->whenIsAscii(function ($string) {
return $string->title();
});
// 'Laravel'
whenIsUlid whenIsUlid
whenIsUlidメソッドは、文字列が有効なULIDである場合、指定するクロージャを呼び出します。クロージャは、Fluent文字列のインスタンスを受け取ります。The whenIsUlid method invokes the given closure if the string is a valid ULID. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('01gd6r360bp37zj17nxb55yv40')->whenIsUlid(function ($string) {
return $string->substr(0, 8);
});
// '01gd6r36'
whenIsUuid whenIsUuid
whenIsUuidメソッドは、文字列が有効なUUIDである場合、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。The whenIsUuid method invokes the given closure if the string is a valid UUID. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('a0a2a2d2-0b87-4a18-83f2-2529882be2de')->whenIsUuid(function ($string) {
return $string->substr(0, 8);
});
// 'a0a2a2d2'
whenTest whenTest
whenTestメソッドは、文字列が正規表現にマッチする場合、指定クロージャを呼び出します。クロージャはFluent文字列インスタンスを受け取ります。The whenTest method invokes the given closure if the string matches the given regular expression. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('laravel framework')->whenTest('/laravel/', function ($string) {
return $string->title();
});
// 'Laravel Framework'
wordCount wordCount
wordcountメソッドは、文字列に含まれる単語の数を返します。The wordCount method returns the number of words that a string contains:
use Illuminate\Support\Str;
Str::of('Hello, world!')->wordCount(); // 2
words words
wordsメソッドは、文字列内の単語数を制限します。必要に応じ、切り捨てた文字列に追加する文字列を指定できます。The words method limits the number of words in a string. If necessary, you may specify an additional string that will be appended to the truncated string:
use Illuminate\Support\Str;
$string = Str::of('Perfectly balanced, as all things should be.')->words(3, ' >>>');
// Perfectly balanced, as >>>
URLURLs
action() action()
action関数は、指定されたコントローラアクションのURLを生成します。The action function generates a URL for the given controller action:
use App\Http\Controllers\HomeController;
$url = action([HomeController::class, 'index']);
メソッドがルートパラメーターを受け付ける場合は、第２引数で指定してください。If the method accepts route parameters, you may pass them as the second argument to the method:
$url = action([UserController::class, 'profile'], ['id' => 1]);
asset() asset()
asset関数は、現在のリクエストのスキーマ（HTTPかHTTPS）を使い、アセットへのURLを生成します。The asset function generates a URL for an asset using the current scheme of the request (HTTP or HTTPS):
$url = asset('img/photo.jpg');
.envファイルでASSET_URL変数を設定することにより、アセットURLホストを設定できます。これは、AmazonS3や別のCDNなどの外部サービスでアセットをホストする場合に役立ちます。You can configure the asset URL host by setting the ASSET_URL variable in your .env file. This can be useful if you host your assets on an external service like Amazon S3 or another CDN:
// ASSET_URL=http://example.com/assets
$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg
route() route()
route関数は、指定した名前付きルートのURLを生成します。The route function generates a URL for a given named route[/docs/{{version}}/routing#named-routes]:
$url = route('route.name');
ルートがパラメーターを受け入れる場合は、それらを関数の２番目の引数として渡すことができます。If the route accepts parameters, you may pass them as the second argument to the function:
$url = route('route.name', ['id' => 1]);
デフォルトでは、route関数は絶対URLを生成します。相対URLを生成する場合は、関数の３番目の引数としてfalseを渡してください。By default, the route function generates an absolute URL. If you wish to generate a relative URL, you may pass false as the third argument to the function:
$url = route('route.name', ['id' => 1], false);
secure_asset() secure_asset()
secure_asset関数はHTTPSを使い、アセットへのURLを生成します。The secure_asset function generates a URL for an asset using HTTPS:
$url = secure_asset('img/photo.jpg');
secure_url() secure_url()
secure_url関数は、指定されたパスへの完全修飾HTTPS URLを生成します。関数の２番目の引数で追加のURLセグメントを渡すことができます。The secure_url function generates a fully qualified HTTPS URL to the given path. Additional URL segments may be passed in the function's second argument:
$url = secure_url('user/profile');
$url = secure_url('user/profile', [1]);
to_route() to_route()
to_route関数は、指定した名前付きルートに対して、リダイレクトHTTPレスポンスを生成します。The to_route function generates a redirect HTTP response[/docs/{{version}}/responses#redirects] for a given named route[/docs/{{version}}/routing#named-routes]:
return to_route('users.show', ['user' => 1]);
必要であれば、to_routeメソッドの第３，第４引数へ、リダイレクトに割り当てるHTTPステータスコードと、追加のレスポンスヘッダを指定できます。If necessary, you may pass the HTTP status code that should be assigned to the redirect and any additional response headers as the third and fourth arguments to the to_route method:
return to_route('users.show', ['user' => 1], 302, ['X-Framework' => 'Laravel']);
url() url()
url関数は指定したパスへの完全なURLを生成します。The url function generates a fully qualified URL to the given path:
$url = url('user/profile');
$url = url('user/profile', [1]);
パスを指定しない場合は、Illuminate\Routing\UrlGeneratorインスタンスを返します。If no path is provided, an Illuminate\Routing\UrlGenerator instance is returned:
$current = url()->current();
$full = url()->full();
$previous = url()->previous();
その他Miscellaneous
abort() abort()
abort関数は、例外ハンドラによりレンダされるであろう、HTTP例外を投げます。The abort function throws an HTTP exception[/docs/{{version}}/errors#http-exceptions] which will be rendered by the exception handler[/docs/{{version}}/errors#the-exception-handler]:
abort(403);
ブラウザに送信する必要のある例外のメッセージとカスタムHTTP応答ヘッダを指定することもできます。You may also provide the exception's message and custom HTTP response headers that should be sent to the browser:
abort(403, 'Unauthorized.', $headers);
abort_if() abort_if()
abort_if関数は、指定された論理値がtrueと評価された場合に、HTTP例外を投げます。The abort_if function throws an HTTP exception if a given boolean expression evaluates to true:
abort_if(! Auth::user()->isAdmin(), 403);
abortメソッドと同様に、例外の応答テキストを３番目の引数として指定し、カスタム応答ヘッダの配列を４番目の引数として関数に指定することもできます。Like the abort method, you may also provide the exception's response text as the third argument and an array of custom response headers as the fourth argument to the function.
abort_unless() abort_unless()
abort_unless関数は、指定した論理値がfalseと評価された場合に、HTTP例外を投げます。The abort_unless function throws an HTTP exception if a given boolean expression evaluates to false:
abort_unless(Auth::user()->isAdmin(), 403);
abortメソッドと同様に、例外の応答テキストを３番目の引数として指定し、カスタム応答ヘッダの配列を４番目の引数として関数に指定することもできます。Like the abort method, you may also provide the exception's response text as the third argument and an array of custom response headers as the fourth argument to the function.
app() app()
app関数は、サービスコンテナのインスタンスを返します。The app function returns the service container[/docs/{{version}}/container] instance:
$container = app();
コンテナにより依存解決する、クラス名かインターフェイス名を渡すこともできます。You may pass a class or interface name to resolve it from the container:
$api = app('HelpSpot\API');
auth() auth()
auth関数は、Authenticatorインスタンスを返します。Authファサードの代わりに使用できます。The auth function returns an authenticator[/docs/{{version}}/authentication] instance. You may use it as an alternative to the Auth facade:
$user = auth()->user();
必要であれば、アクセスしたいガードインスタンスを指定することもできます。If needed, you may specify which guard instance you would like to access:
$user = auth('admin')->user();
back() back()
back関数はユーザーの直前のロケーションへのリダイレクトHTTPレスポンスを生成します。The back function generates a redirect HTTP response[/docs/{{version}}/responses#redirects] to the user's previous location:
return back($status = 302, $headers = [], $fallback = '/');
return back();
bcrypt() bcrypt()
bcrypt関数はBcryptを使用して指定された値をハッシュします。この関数は、Hashファサードの代わりに使用できます。The bcrypt function hashes[/docs/{{version}}/hashing] the given value using Bcrypt. You may use this function as an alternative to the Hash facade:
$password = bcrypt('my-secret-password');
blank() blank()
blank関数は、指定された値が「空白」であるかどうかを判別します。The blank function determines whether the given value is "blank":
blank('');
blank(' ');
blank(null);
blank(collect());
// true
blank(0);
blank(true);
blank(false);
// false
blankの逆の動作は、filledメソッドです。For the inverse of blank, see the filled[#method-filled] method.
broadcast() broadcast()
broadcast関数は、指定したイベントをリスナへブロードキャストします。The broadcast function broadcasts[/docs/{{version}}/broadcasting] the given event[/docs/{{version}}/events] to its listeners:
broadcast(new UserRegistered($user));
broadcast(new UserRegistered($user))->toOthers();
cache() cache()
cache関数はキャッシュから値を取得するために使用します。キャッシュに指定したキーが存在しない場合、オプション値が返されます。The cache function may be used to get values from the cache[/docs/{{version}}/cache]. If the given key does not exist in the cache, an optional default value will be returned:
$value = cache('key');
$value = cache('key', 'default');
関数にキー／値ペアの配列を渡すと、アイテムをキャッシュへ追加します。さらに秒数、もしくはキャッシュ値が有効であると推定される期限を渡すこともできます。You may add items to the cache by passing an array of key / value pairs to the function. You should also pass the number of seconds or duration the cached value should be considered valid:
cache(['key' => 'value'], 300);
cache(['key' => 'value'], now()->addSeconds(10));
class_uses_recursive() class_uses_recursive()
class_uses_recursive関数は、すべての親で使われているものも含め、クラス中で使用されているトレイトをすべて返します。The class_uses_recursive function returns all traits used by a class, including traits used by all of its parent classes:
$traits = class_uses_recursive(App\Models\User::class);
collect() collect()
collect関数は、指定値からコレクションインスタンスを生成します。The collect function creates a collection[/docs/{{version}}/collections] instance from the given value:
$collection = collect(['taylor', 'abigail']);
config() config()
config関数は設定変数の値を取得します。設定値はファイル名とアクセスしたいオプションを「ドット」記法で指定します。デフォルト値が指定でき、設定オプションが存在しない時に返されます。The config function gets the value of a configuration[/docs/{{version}}/configuration] variable. The configuration values may be accessed using "dot" syntax, which includes the name of the file and the option you wish to access. A default value may be specified and is returned if the configuration option does not exist:
$value = config('app.timezone');
$value = config('app.timezone', $default);
キー／値ペアの配列を渡すことにより、実行時に設定変数を設定できます。ただし、この関数は現在のリクエストの設定値にのみ影響し、実際の設定値は更新しないことに注意してください。You may set configuration variables at runtime by passing an array of key / value pairs. However, note that this function only affects the configuration value for the current request and does not update your actual configuration values:
config(['app.debug' => true]);
cookie() cookie()
cookie関数は新しいクッキーインスタンスを生成します。The cookie function creates a new cookie[/docs/{{version}}/requests#cookies] instance:
$cookie = cookie('name', 'value', $minutes);
csrf_field() csrf_field()
csrf_field関数は、CSRFトークン値を持つHTML「隠し」入力フィールドを生成します。ブレード記法を使用した例です。The csrf_field function generates an HTML hidden input field containing the value of the CSRF token. For example, using Blade syntax[/docs/{{version}}/blade]:
{{ csrf_field() }}
csrf_token() csrf_token()
csrf_token関数は、現在のCSRFトークン値を取得します。The csrf_token function retrieves the value of the current CSRF token:
$token = csrf_token();
decrypt() decrypt()
decrypt関数は、指定した値を 復号化 します。この関数は、Cryptファサードの代わりとして使用できます。The decrypt function decrypts[/docs/{{version}}/encryption] the given value. You may use this function as an alternative to the Crypt facade:
$password = decrypt($value);
dd() dd()
dd関数は指定された変数の内容を表示し、スクリプトの実行を停止します。The dd function dumps the given variables and ends execution of the script:
dd($value);
dd($value1, $value2, $value3, ...);
スクリプトの実行を停止したくない場合は、代わりにdump関数を使ってください。If you do not want to halt the execution of your script, use the dump[#method-dump] function instead.
dispatch() dispatch()
dispatch関数は、指定したジョブをLaravelのジョブキューへ投入します。The dispatch function pushes the given job[/docs/{{version}}/queues#creating-jobs] onto the Laravel job queue[/docs/{{version}}/queues]:
dispatch(new App\Jobs\SendEmails);
dump() dump()
dump関数は指定した変数をダンプします。The dump function dumps the given variables:
dump($value);
dump($value1, $value2, $value3, ...);
変数の値をダンプした後に実行を停止したい場合は、代わりにdd関数を使用してください。If you want to stop executing the script after dumping the variables, use the dd[#method-dd] function instead.
encrypt() encrypt()
encrypt関数は、指定した値を暗号化します。この関数は、Cryptファサードの代わりに使用できます。The encrypt function encrypts[/docs/{{version}}/encryption] the given value. You may use this function as an alternative to the Crypt facade:
$secret = encrypt('my-secret-value');
env() env()
env関数は環境変数の値を取得します。取得できない場合はデフォルト値を返します。The env function retrieves the value of an environment variable[/docs/{{version}}/configuration#environment-configuration] or returns a default value:
$env = env('APP_ENV');
$env = env('APP_ENV', 'production');
Warning! 開発期間中に
config:cacheコマンドを実行する場合は、設定ファイルの中で必ずenv関数だけを使用してください。設定ファイルがキャッシュされると、.envファイルはロードされなくなり、env関数の呼び出しはすべてnullを返します。Warning
If you execute theconfig:cachecommand during your deployment process, you should be sure that you are only calling theenvfunction from within your configuration files. Once the configuration has been cached, the.envfile will not be loaded and all calls to theenvfunction will returnnull.
event() event()
event関数は、指定したイベントをリスナにディスパッチします。The event function dispatches the given event[/docs/{{version}}/events] to its listeners:
event(new UserRegistered($user));
fake() fake()
fake関数は、コンテナからFakerシングルトンを依存解決します。これは、モデルファクトリ、データベース初期値設定、テスト、プロトタイピングビューでフェイクデータを作成する場合に便利です。The fake function resolves a Faker[https://github.com/FakerPHP/Faker] singleton from the container, which can be useful when creating fake data in model factories, database seeding, tests, and prototyping views:
@for($i = 0; $i < 10; $i++)
<dl>
<dt>Name</dt>
<dd>{{ fake()->name() }}</dd>
<dt>Email</dt>
<dd>{{ fake()->unique()->safeEmail() }}</dd>
</dl>
@endfor
fake関数はデフォルトで、config/app.php設定ファイルのapp.faker_locale設定オプションを利用しますが、fake関数でロケールを直接指定することもできます。各ロケールは個々のシングルトンを解決します:By default, the fake function will utilize the app.faker_locale configuration option in your config/app.php configuration file; however, you may also specify the locale by passing it to the fake function. Each locale will resolve an individual singleton:
fake('nl_NL')->name()
filled() filled()
filled関数は、指定された値が「空白」でないかどうかを判別します。The filled function determines whether the given value is not "blank":
filled(0);
filled(true);
filled(false);
// true
filled('');
filled(' ');
filled(null);
filled(collect());
// false
filledの逆の動作は、blankメソッドです。For the inverse of filled, see the blank[#method-blank] method.
info() info()
info関数は、アプリケーションのログへ情報を書き込みます。The info function will write information to your application's log[/docs/{{version}}/logging]:
info('Some helpful information!');
関連情報の配列を関数へ渡すこともできます。An array of contextual data may also be passed to the function:
info('User login attempt failed.', ['id' => $user->id]);
logger() logger()
logger関数は、debugレベルのメッセージをログへ書き出します。The logger function can be used to write a debug level message to the log[/docs/{{version}}/logging]:
logger('Debug message');
関連情報の配列を関数へ渡すこともできます。An array of contextual data may also be passed to the function:
logger('User has logged in.', ['id' => $user->id]);
関数に値を渡さない場合は、ロガーインスタンスが返されます。A logger[/docs/{{version}}/errors#logging] instance will be returned if no value is passed to the function:
logger()->error('You are not allowed here.');
method_field() method_field()
method_field関数はフォームのHTTP動詞の見せかけの値を保持する「隠し」HTTP入力フィールドを生成します。Blade記法を使う例です。The method_field function generates an HTML hidden input field containing the spoofed value of the form's HTTP verb. For example, using Blade syntax[/docs/{{version}}/blade]:
<form method="POST">
{{ method_field('DELETE') }}
</form>
now() now()
now関数は、現時点を表す新しいIlluminate\Support\Carbonインスタンスを生成します。The now function creates a new Illuminate\Support\Carbon instance for the current time:
$now = now();
old() old()
old関数はセッションに一時保持データーとして保存されている直前の入力値を取得します。The old function retrieves[/docs/{{version}}/requests#retrieving-input] an old input[/docs/{{version}}/requests#old-input] value flashed into the session:
$value = old('value');
$value = old('value', 'default');
old関数の第２引数として指定される「デフォルト値」は、Eloquentモデルの属性であることが多いため、LaravelではEloquentモデル全体をold関数の第２引数として渡せるようになっています。この場合、Laravelはold関数に渡された最初の引数を「デフォルト値」とみなすべきEloquent属性の名前として扱います。Since the "default value" provided as the second argument to the old function is often an attribute of an Eloquent model, Laravel allows you to simply pass the entire Eloquent model as the second argument to the old function. When doing so, Laravel will assume the first argument provided to the old function is the name of the Eloquent attribute that should be considered the "default value":
{{ old('name', $user->name) }}
// 上記は下記と同じ
{{ old('name', $user) }}
optional() optional()
optional関数はどんな引数も指定でき、そのオブジェクトのプロパティへアクセスするか、メソッドを呼び出せます。指定したオブジェクトがnullだった場合、エラーを発生させる代わりに、プロパティとメソッドはnullを返します。The optional function accepts any argument and allows you to access properties or call methods on that object. If the given object is null, properties and methods will return null instead of causing an error:
return optional($user->address)->street;
{!! old('name', optional($user)->name) !!}
optional関数は、２番目の引数としてクロージャも受け入れます。最初の引数として指定された値がnullでない場合、クロージャが呼び出されます。The optional function also accepts a closure as its second argument. The closure will be invoked if the value provided as the first argument is not null:
return optional(User::find($id), function ($user) {
return $user->name;
});
policy() policy()
policy関数は、指定クラスのポリシーインスタンスを取得します。The policy method retrieves a policy[/docs/{{version}}/authorization#creating-policies] instance for a given class:
$policy = policy(App\Models\User::class);
redirect() redirect()
redirect関数は、リダイレクトHTTPレスポンスを返します。引数無しで呼び出した場合は、リダイレクタインスタンスを返します。The redirect function returns a redirect HTTP response[/docs/{{version}}/responses#redirects], or returns the redirector instance if called with no arguments:
return redirect($to = null, $status = 302, $headers = [], $https = null);
return redirect('/home');
return redirect()->route('route.name');
report() report()
report関数は例外ハンドラを使用して例外をレポートします。The report function will report an exception using your exception handler[/docs/{{version}}/errors#the-exception-handler]:
report($e);
report関数は文字列を引数に取ります。関数に文字列が与えられると、関数は指定する文字列をメッセージとする例外を作成します。The report function also accepts a string as an argument. When a string is given to the function, the function will create an exception with the given string as its message:
report('Something went wrong.');
report_if() report_if()
report_if関数は、指定条件がtrueであれば、あなたの例外ハンドラを使って例外を報告します。The report_if function will report an exception using your exception handler[/docs/{{version}}/errors#the-exception-handler] if the given condition is true:
report_if($shouldReport, $e);
report_if($shouldReport, 'Something went wrong.');
report_unless() report_unless()
report_unless関数は、指定条件がfalseであれば、あなたの例外ハンドラを使って例外を報告します。The report_unless function will report an exception using your exception handler[/docs/{{version}}/errors#the-exception-handler] if the given condition is false:
report_unless($reportingDisabled, $e);
report_unless($reportingDisabled, 'Something went wrong.');
request() request()
request関数は、現在のrequestインスタンスを返すか、現在のリクエストから入力フィールドの値を取得します。The request function returns the current request[/docs/{{version}}/requests] instance or obtains an input field's value from the current request:
$request = request();
$value = request('key', $default);
rescue() rescue()
rescue関数は指定されたクロージャを実行し、その実行中に発生した例外をすべてキャッチします。キャッチした例外はすべて例外ハンドラへ送られますが、リクエストの処理は続行されます。The rescue function executes the given closure and catches any exceptions that occur during its execution. All exceptions that are caught will be sent to your exception handler[/docs/{{version}}/errors#the-exception-handler]; however, the request will continue processing:
return rescue(function () {
return $this->method();
});
rescue関数に２番目の引数を渡すこともできます。この引数は、クロージャの実行で例外が発生した場合に返す「デフォルト」値です。You may also pass a second argument to the rescue function. This argument will be the "default" value that should be returned if an exception occurs while executing the closure:
return rescue(function () {
return $this->method();
}, false);
return rescue(function () {
return $this->method();
}, function () {
return $this->failure();
});
resolve() resolve()
resolve関数は、サービスコンテナを使用して、指定したクラスまたはインターフェイス名をインスタンスへ依存解決します。The resolve function resolves a given class or interface name to an instance using the service container[/docs/{{version}}/container]:
$api = resolve('HelpSpot\API');
response() response()
response関数はresponseインスタンスを返すか、レスポンスファクトリのインスタンスを取得します。The response function creates a response[/docs/{{version}}/responses] instance or obtains an instance of the response factory:
return response('Hello World', 200, $headers);
return response()->json(['foo' => 'bar'], 200, $headers);
retry() retry()
retry関数は指定された最大試行回数を過ぎるまで、指定されたコールバックを実行します。コールバックが例外を投げなければ、返却値を返します。コールバックが例外を投げた場合は、自動的にリトライします。最大試行回数を超えると、例外を投げます。The retry function attempts to execute the given callback until the given maximum attempt threshold is met. If the callback does not throw an exception, its return value will be returned. If the callback throws an exception, it will automatically be retried. If the maximum attempt count is exceeded, the exception will be thrown:
return retry(5, function () {
// 試行間に100ms待ち、5回試みる
}, 100);
もし、試行間隔を何ミリ秒にするかを手作業で計算したい場合は、retry関数の第３引数へクロージャを渡します。If you would like to manually calculate the number of milliseconds to sleep between attempts, you may pass a closure as the third argument to the retry function:
return retry(5, function () {
// ...
}, function ($attempt, $exception) {
return $attempt * 100;
});
便利なように、retry関数の最初の引数には配列を指定することもできます。この配列は、次の再試行の間に何ミリ秒スリープさせるかを決定するために使用されます。For convenience, you may provide an array as the first argument to the retry function. This array will be used to determine how many milliseconds to sleep between subsequent attempts:
return retry([100, 200], function () {
// 最初に100ms、２回目に200msスリープする
});
特定条件下でのみ再試行するには、retry関数への4番目の引数としてクロージャを渡せます。To only retry under specific conditions, you may pass a closure as the fourth argument to the retry function:
return retry(5, function () {
// ...
}, 100, function ($exception) {
return $exception instanceof RetryException;
});
session() session()
session関数はセッションへ値を設定、もしくは取得するために使用します。The session function may be used to get or set session[/docs/{{version}}/session] values:
$value = session('key');
キー／値ペアの配列を渡し、値を設定できます。You may set values by passing an array of key / value pairs to the function:
session(['chairs' => 7, 'instruments' => 3]);
関数に引数を渡さない場合は、セッション保存域が返されます。The session store will be returned if no value is passed to the function:
$value = session()->get('key');
session()->put('key', $value);
tap() tap()
tap関数は、任意の$valueとクロージャの２つの引数を受け入れます。$valueはクロージャに渡され、tap関数によって返されます。クロージャの戻り値は関係ありません。The tap function accepts two arguments: an arbitrary $value and a closure. The $value will be passed to the closure and then be returned by the tap function. The return value of the closure is irrelevant:
$user = tap(User::first(), function ($user) {
$user->name = 'taylor';
$user->save();
});
tap関数にクロージャが渡されない場合は、指定した$valueで任意のメソッドを呼び出せます。呼び出すメソッドの戻り値は、メソッドがその定義で実際に何を返すかに関係なく、常に$valueになります。たとえば、Eloquentのupdateメソッドは通常、整数を返します。しかし、tap関数を介してupdateメソッド呼び出しをチェーンすることで、メソッドへモデル自体を返すように強制できます。If no closure is passed to the tap function, you may call any method on the given $value. The return value of the method you call will always be $value, regardless of what the method actually returns in its definition. For example, the Eloquent update method typically returns an integer. However, we can force the method to return the model itself by chaining the update method call through the tap function:
$user = tap($user)->update([
'name' => $name,
'email' => $email,
]);
クラスへtapメソッドを追加するには、Illuminate\Support\Traits\Tappableトレイトをそのクラスへ追加してください。このトレイトのtapメソッドはクロージャだけを引数に受け取ります。オブジェクトインスタンス自身がクロージャに渡され、tapメソッドによりリターンされます。To add a tap method to a class, you may add the Illuminate\Support\Traits\Tappable trait to the class. The tap method of this trait accepts a Closure as its only argument. The object instance itself will be passed to the Closure and then be returned by the tap method:
return $user->tap(function ($user) {
//
});
throw_if() throw_if()
throw_if関数は、指定した論理式がtrueと評価された場合に、指定した例外を投げます。The throw_if function throws the given exception if a given boolean expression evaluates to true:
throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);
throw_if(
! Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page.'
);
throw_unless() throw_unless()
throw_unless関数は、指定した論理式がfalseと評価された場合に、指定した例外を投げます。The throw_unless function throws the given exception if a given boolean expression evaluates to false:
throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);
throw_unless(
Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page.'
);
today() today()
today関数は、現在の日付を表す新しいIlluminate\Support\Carbonインスタンスを生成します。The today function creates a new Illuminate\Support\Carbon instance for the current date:
$today = today();
trait_uses_recursive() trait_uses_recursive()
trait_uses_recursive関数は、そのトレイトで使用されている全トレイトを返します。The trait_uses_recursive function returns all traits used by a trait:
$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);
transform() transform()
transform関数は、値が空白でない場合、指定値に対してクロージャを実行し、クロージャの戻り値を返します。The transform function executes a closure on a given value if the value is not blank[#method-blank] and then returns the return value of the closure:
$callback = function ($value) {
return $value * 2;
};
$result = transform(5, $callback);
// 10
デフォルト値またはクロージャは、関数の３番目の引数として渡せます。指定値が空白の場合、この値をが返します。A default value or closure may be passed as the third argument to the function. This value will be returned if the given value is blank:
$result = transform(null, $callback, 'The value is blank');
// 値は空白
validator() validator()
validator関数は、引数を使用して新しいバリデータインスタンスを作成します。Validatorファサードの代わりに使用できます。The validator function creates a new validator[/docs/{{version}}/validation] instance with the given arguments. You may use it as an alternative to the Validator facade:
$validator = validator($data, $rules, $messages);
value() value()
value関数は、指定値を返します。ただし、関数へクロージャを渡すと、そのクロージャを実行し、その戻り値を返します。The value function returns the value it is given. However, if you pass a closure to the function, the closure will be executed and its returned value will be returned:
$result = value(true);
// true
$result = value(function () {
return false;
});
// false
value関数に追加の引数を渡すこともできます。最初の引数がクロージャであれば、追加した引数はクロージャの引数として渡されます。クロージャでなければ、無視します。Additional arguments may be passed to the value function. If the first argument is a closure then the additional parameters will be passed to the closure as arguments, otherwise they will be ignored:
$result = value(function ($name) {
return $parameter;
}, 'Taylor');
// 'Taylor'
view() view()
view関数はviewインスタンスを返します。The view function retrieves a view[/docs/{{version}}/views] instance:
return view('auth.login');
with() with()
with関数は、指定値を返します。関数の２番目の引数としてクロージャを渡たすと、クロージャが実行され、その戻り値を返します。The with function returns the value it is given. If a closure is passed as the second argument to the function, the closure will be executed and its returned value will be returned:
$callback = function ($value) {
return is_numeric($value) ? $value * 2 : 0;
};
$result = with(5, $callback);
// 10
$result = with(null, $callback);
// 0
$result = with(5, null);
// 5
その他のユーティリティOther Utilities
ベンチマークBenchmarking
時には、アプリケーションの特定の部分のパフォーマンスを素早くテストしたいと思うこともあるでしょう。そのような場合は、Benchmarkサポートクラスを利用して、指定するコールバックが完了するまでにかかるミリ秒を測定できます。Sometimes you may wish to quickly test the performance of certain parts of your application. On those occasions, you may utilize the Benchmark support class to measure the number of milliseconds it takes for the given callbacks to complete:
<?php
use App\Models\User;
use Illuminate\Support\Benchmark;
Benchmark::dd(fn () => User::find(1)); // 0.1 ms
Benchmark::dd([
'Scenario 1' => fn () => User::count(), // 0.5 ms
'Scenario 2' => fn () => User::all()->count(), // 20.0 ms
]);
デフォルトでは、指定したコールバックは、１回（１繰り返し）実行され、その期間はブラウザ／コンソールに表示されます。By default, the given callbacks will be executed once (one iteration), and their duration will be displayed in the browser / console.
コールバックを複数回呼び出すには、メソッドの第２引数でコールバックを呼び出す反復回数を指定してください。コールバックを複数回実行する場合、Benchmarkクラスはコールバックの実行にかかった平均ミリ秒を返します。To invoke a callback more than once, you may specify the number of iterations that the callback should be invoked as the second argument to the method. When executing a callback more than once, the Benchmark class will return the average amount of milliseconds it took to execute the callback across all iterations:
Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms
抽選Lottery
Laravelの抽選クラスは、指定する一組のオッズに基づいて、コールバックを実行するために使用します。これは、受信リクエストの数パーセントに対してのみコードを実行したい場合、特に便利です。Laravel's lottery class may be used to execute callbacks based on a set of given odds. This can be particularly useful when you only want to execute code for a percentage of your incoming requests:
use Illuminate\Support\Lottery;
Lottery::odds(1, 20)
->winner(fn () => $user->won())
->loser(fn () => $user->lost())
->choose();
Laravelの抽選クラスと他のLaravelの機能を組み合わせることも可能です。例えば、スロークエリの一部だけを例外ハンドラへ報告するようにしたい場合です。また、抽選クラスはCallableなため、Callableのメソッドを引数に取るクラスへインスタンスを渡せます。You may combine Laravel's lottery class with other Laravel features. For example, you may wish to only report a small percentage of slow queries to your exception handler. And, since the lottery class is callable, we may pass an instance of the class into any method that accepts callables:
use Carbon\CarbonInterval;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Lottery;
DB::whenQueryingForLongerThan(
CarbonInterval::seconds(2),
Lottery::odds(1, 100)->winner(fn () => report('Querying > 2 seconds.')),
);
抽選のテストTesting Lotteries
Laravelは、アプリケーションの抽選呼び出しを簡単にテストするために、シンプルなメソッドを用意しています。Laravel provides some simple methods to allow you to easily test your application's lottery invocations:
// 常に当選する
Lottery::alwaysWin();
// 常に外れる
Lottery::alwaysLose();
// 当選し、次に外れたあとは、通常の振る舞いをする
Lottery::fix([true, false]);
// 通常の振る舞いで抽選する
Lottery::determineResultsNormally();