跳到內容
Laravel

字串

簡介

Laravel 包含許多用於操作字串值的功能。這些功能中有許多是由框架本身使用；但是，如果您覺得方便，也可以在自己的應用程式中使用它們。

可用的方法

字串

__ class_basename e preg_replace_array Str::after Str::afterLast Str::apa Str::ascii Str::before Str::beforeLast Str::between Str::betweenFirst Str::camel Str::charAt Str::chopStart Str::chopEnd Str::contains Str::containsAll Str::doesntContain Str::deduplicate Str::endsWith Str::excerpt Str::finish Str::headline Str::inlineMarkdown Str::is Str::isAscii Str::isJson Str::isUlid Str::isUrl 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::password Str::plural Str::pluralStudly Str::position Str::random Str::remove Str::repeat Str::replace Str::replaceArray Str::replaceFirst Str::replaceLast Str::replaceMatches Str::replaceStart Str::replaceEnd 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::take Str::title Str::toBase64 Str::toHtmlString Str::transliterate Str::trim Str::ltrim Str::rtrim Str::ucfirst Str::ucsplit Str::upper Str::ulid Str::unwrap Str::uuid Str::wordCount Str::wordWrap Str::words Str::wrap str trans trans_choice

流暢字串

after afterLast apa append ascii basename before beforeLast between betweenFirst camel charAt classBasename chopStart chopEnd contains containsAll deduplicate dirname endsWith exactly excerpt explode finish headline inlineMarkdown is isAscii isEmpty isNotEmpty isJson isUlid isUrl isUuid kebab lcfirst length limit lower markdown mask match matchAll isMatch newLine padBoth padLeft padRight pipe plural position prepend remove repeat replace replaceArray replaceFirst replaceLast replaceMatches replaceStart replaceEnd scan singular slug snake split squish start startsWith stripTags studly substr substrReplace swap take tap test title toBase64 transliterate trim ltrim rtrim ucfirst ucsplit unwrap upper when whenContains whenContainsAll whenEmpty whenNotEmpty whenStartsWith whenEndsWith whenExactly whenNotExactly whenIs whenIsAscii whenIsUlid whenIsUuid whenTest wordCount words wrap

字串

__()

__ 函數使用您的語言檔案翻譯給定的翻譯字串或翻譯鍵。

echo __('Welcome to our application');
 
echo __('messages.welcome');

如果指定的翻譯字串或鍵不存在，__ 函數將返回給定的值。因此，使用上面的範例，如果該翻譯鍵不存在，則 __ 函數將返回 messages.welcome。

class_basename()

class_basename 函數返回給定類別的類別名稱，並移除類別的命名空間。

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

e()

e 函數預設執行 PHP 的 htmlspecialchars 函數，並將 double_encode 選項設定為 true。

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

preg_replace_array()

preg_replace_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 方法返回字串中給定值之後的所有內容。如果該值不存在於字串中，則會返回整個字串。

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

Str::afterLast()

Str::afterLast 方法會回傳字串中最後一次出現指定值之後的所有內容。如果該值不存在於字串中，則會回傳整個字串。

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

Str::apa()

Str::apa 方法會根據 APA 指南，將給定的字串轉換為首字大寫的標題格式。

use Illuminate\Support\Str;
 
$title = Str::apa('Creating A Project');
 
// 'Creating a Project'

Str::ascii()

Str::ascii 方法會嘗試將字串音譯為 ASCII 值。

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

Str::before()

Str::before 方法會回傳字串中指定值之前的所有內容。

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

Str::beforeLast()

Str::beforeLast 方法會回傳字串中最後一次出現指定值之前的所有內容。

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

Str::between()

Str::between 方法會回傳字串中兩個值之間的部分。

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

Str::betweenFirst()

Str::betweenFirst 方法會回傳字串中兩個值之間最小的部分。

use Illuminate\Support\Str;
 
$slice = Str::betweenFirst('[a] bc [d]', '[', ']');
 
// 'a'

Str::camel()

Str::camel 方法會將給定的字串轉換為 camelCase 格式。

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

Str::charAt()

Str::charAt 方法會回傳指定索引位置的字元。如果索引超出範圍，則會回傳 false。

use Illuminate\Support\Str;
 
$character = Str::charAt('This is my name.', 6);
 
// 's'

Str::chopStart()

Str::chopStart 方法只會在給定的值出現在字串開頭時，移除該值的第一次出現。

use Illuminate\Support\Str;
 
$url = Str::chopStart('https://laravel.dev.org.tw', 'https://');
 
// 'laravel.com'

您也可以將陣列作為第二個參數傳遞。如果字串以陣列中的任何值開頭，則該值將會從字串中移除。

use Illuminate\Support\Str;
 
$url = Str::chopStart('https://laravel.dev.org.tw', ['https://', 'http://']);
 
// 'laravel.com'

Str::chopEnd()

Str::chopEnd 方法只會在給定的值出現在字串結尾時，移除該值的最後一次出現。

use Illuminate\Support\Str;
 
$url = Str::chopEnd('app/Models/Photograph.php', '.php');
 
// 'app/Models/Photograph'

您也可以將陣列作為第二個參數傳遞。如果字串以陣列中的任何值結尾，則該值將會從字串中移除。

use Illuminate\Support\Str;
 
$url = Str::chopEnd('laravel.com/index.php', ['/index.html', '/index.php']);
 
// 'laravel.com'

Str::contains()

Str::contains 方法會判斷給定的字串是否包含給定的值。預設情況下，此方法會區分大小寫。

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

您也可以傳遞一個值陣列，以判斷給定的字串是否包含陣列中的任何值。

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

您可以將 ignoreCase 參數設定為 true 來停用大小寫區分。

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

Str::containsAll()

Str::containsAll 方法會判斷給定的字串是否包含給定陣列中的所有值。

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

您可以將 ignoreCase 參數設定為 true 來停用大小寫區分。

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

Str::doesntContain()

Str::doesntContain 方法會判斷給定的字串是否不包含給定的值。預設情況下，此方法會區分大小寫。

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

您也可以傳遞一個值陣列，以判斷給定的字串是否不包含陣列中的任何值。

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

您可以將 ignoreCase 參數設定為 true 來停用大小寫區分。

use Illuminate\Support\Str;
 
$doesntContain = Str::doesntContain('This is name', 'MY', ignoreCase: true);
 
// true

Str::deduplicate()

Str::deduplicate 方法會將給定字串中連續重複出現的字元替換為該字元的單個實例。預設情況下，此方法會去除重複的空格。

use Illuminate\Support\Str;
 
$result = Str::deduplicate('The   Laravel   Framework');
 
// The Laravel Framework

您可以將要去除重複的字元作為第二個參數傳遞給方法，以指定不同的字元。

use Illuminate\Support\Str;
 
$result = Str::deduplicate('The---Laravel---Framework', '-');
 
// The-Laravel-Framework

Str::endsWith()

Str::endsWith 方法會判斷給定的字串是否以給定的值結尾。

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

您也可以傳遞一個值陣列，以判斷給定的字串是否以陣列中的任何值結尾。

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 方法會從給定的字串中提取與該字串中第一個符合的短語匹配的摘錄。

use Illuminate\Support\Str;
 
$excerpt = Str::excerpt('This is my name', 'my', [
    'radius' => 3
]);
 
// '...is my na...'

radius 選項，預設為 100，可讓您定義應出現在截斷字串每一側的字元數。

此外，您可以使用 omission 選項來定義將會附加到截斷字串開頭和結尾的字串。

use Illuminate\Support\Str;
 
$excerpt = Str::excerpt('This is my name', 'name', [
    'radius' => 3,
    'omission' => '(...) '
]);
 
// '(...) my name'

Str::finish()

如果給定的字串尚未以給定的值結尾，則 Str::finish 方法會將該值的單個實例添加到字串中。

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

Str::headline()

Str::headline 方法會將由大小寫、連字號或底線分隔的字串轉換為以空格分隔的字串，並將每個單字的首字母大寫。

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

Str::inlineMarkdown()

Str::inlineMarkdown 方法會使用 CommonMark 將 GitHub 風格的 Markdown 轉換為內嵌 HTML。但是，與 markdown 方法不同，它不會將所有生成的 HTML 包裹在區塊級元素中。

use Illuminate\Support\Str;
 
$html = Str::inlineMarkdown('**Laravel**');
 
// <strong>Laravel</strong>

Markdown 安全性

預設情況下，Markdown 支援原始 HTML，當與原始使用者輸入一起使用時，會暴露跨網站腳本 (XSS) 漏洞。根據 CommonMark 安全性文件，您可以使用 html_input 選項來轉義或刪除原始 HTML，並使用 allow_unsafe_links 選項來指定是否允許不安全的連結。如果您需要允許某些原始 HTML，則應將編譯後的 Markdown 透過 HTML Purifier 傳遞。

use Illuminate\Support\Str;
 
Str::inlineMarkdown('Inject: <script>alert("Hello XSS!");</script>', [
    'html_input' => 'strip',
    'allow_unsafe_links' => false,
]);
 
// Inject: alert(&quot;Hello XSS!&quot;);

Str::is()

Str::is 方法會判斷給定的字串是否與給定的模式匹配。星號可用作萬用字元值。

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

Str::isAscii()

Str::isAscii 方法會判斷給定的字串是否為 7 位元的 ASCII 字元。

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

Str::isJson()

Str::isJson 方法會判斷給定的字串是否為有效的 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::isUrl()

Str::isUrl 方法會判斷給定的字串是否為有效的 URL。

use Illuminate\Support\Str;
 
$isUrl = Str::isUrl('http://example.com');
 
// true
 
$isUrl = Str::isUrl('laravel');
 
// false

isUrl 方法會將多種協定視為有效。但是，您可以透過將協定提供給 isUrl 方法，來指定應被視為有效的協定。

$isUrl = Str::isUrl('http://example.com', ['http', 'https']);

Str::isUlid()

Str::isUlid 方法會判斷給定的字串是否為有效的 ULID。

use Illuminate\Support\Str;
 
$isUlid = Str::isUlid('01gd6r360bp37zj17nxb55yv40');
 
// true
 
$isUlid = Str::isUlid('laravel');
 
// false

Str::isUuid()

Str::isUuid 方法會判斷給定的字串是否為有效的 UUID。

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

Str::kebab()

Str::kebab 方法會將給定的字串轉換為 kebab-case 格式。

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

Str::lcfirst()

Str::lcfirst 方法會回傳給定的字串，並將第一個字元轉換為小寫。

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

Str::length()

Str::length 方法會回傳給定字串的長度。

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

Str::limit()

Str::limit 方法會將給定的字串截斷為指定的長度。

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

您可以將第三個參數傳遞給方法，以變更將附加到截斷字串結尾的字串。

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

如果您希望在截斷字串時保留完整的單字，可以使用 preserveWords 參數。當此參數為 true 時，字串將會截斷到最接近的完整單字邊界。

$truncated = Str::limit('The quick brown fox', 12, preserveWords: true);
 
// The quick...

Str::lower()

Str::lower 方法會將給定的字串轉換為小寫。

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

Str::markdown()

Str::markdown 方法會使用 CommonMark 將 GitHub 風格的 Markdown 轉換為 HTML。

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

Markdown 安全性

預設情況下，Markdown 支援原始 HTML，當與原始使用者輸入一起使用時，會暴露跨網站腳本 (XSS) 漏洞。根據 CommonMark 安全性文件，您可以使用 html_input 選項來轉義或刪除原始 HTML，並使用 allow_unsafe_links 選項來指定是否允許不安全的連結。如果您需要允許某些原始 HTML，則應將編譯後的 Markdown 透過 HTML Purifier 傳遞。

use Illuminate\Support\Str;
 
Str::markdown('Inject: <script>alert("Hello XSS!");</script>', [
    'html_input' => 'strip',
    'allow_unsafe_links' => false,
]);
 
// <p>Inject: alert(&quot;Hello XSS!&quot;);</p>

Str::mask()

Str::mask 方法會使用重複的字元遮罩字串的一部分，可用於模糊處理電子郵件地址和電話號碼等字串片段。

use Illuminate\Support\Str;
 
$string = Str::mask('[email protected]', '*', 3);
 
// tay***************

如果需要，您可以提供負數作為 mask 方法的第三個參數，這會指示該方法從字串結尾的給定距離處開始遮罩。

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

Str::orderedUuid()

Str::orderedUuid 方法會產生「時間戳記優先」的 UUID，可以有效地儲存在索引資料庫欄位中。使用此方法產生的每個 UUID 將會在先前使用該方法產生的 UUID 之後進行排序。

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

Str::padBoth()

Str::padBoth 方法會包裝 PHP 的 str_pad 函式，使用另一個字串填充字串的兩側，直到最終字串達到所需的長度。

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

Str::padLeft()

Str::padLeft 方法會包裝 PHP 的 str_pad 函式，使用另一個字串填充字串的左側，直到最終字串達到所需的長度。

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

Str::padRight()

Str::padRight 方法會包裝 PHP 的 str_pad 函式，使用另一個字串填充字串的右側，直到最終字串達到所需的長度。

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

Str::password()

Str::password 方法可用於產生指定長度的安全隨機密碼。密碼將由字母、數字、符號和空格的組合組成。預設情況下，密碼長度為 32 個字元。

use Illuminate\Support\Str;
 
$password = Str::password();
 
// 'EbJo2vE-AS:U,$%_gkrV4n,q~1xy/-_4'
 
$password = Str::password(12);
 
// 'qwuar>#V|i]N'

Str::plural()

Str::plural 方法會將單數單字字串轉換為複數形式。此函式支援 Laravel 的複數化工具支援的任何語言。

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

您可以將整數作為函式的第二個參數提供，以檢索字串的單數或複數形式。

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

Str::pluralStudly()

Str::pluralStudly 方法會將以首字大寫格式化的單數單字字串轉換為複數形式。此函式支援 Laravel 的複數化工具支援的任何語言。

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

您可以將整數作為函式的第二個參數提供，以檢索字串的單數或複數形式。

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

Str::position()

Str::position 方法會回傳子字串在字串中第一次出現的位置。如果子字串不存在於給定的字串中，則會回傳 false。

use Illuminate\Support\Str;
 
$position = Str::position('Hello, World!', 'Hello');
 
// 0
 
$position = Str::position('Hello, World!', 'W');
 
// 7

Str::random()

Str::random 方法會產生指定長度的隨機字串。此函式使用 PHP 的 random_bytes 函式。

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

在測試期間，可能需要「偽造」Str::random 方法回傳的值。為此，您可以使用 createRandomStringsUsing 方法。

Str::createRandomStringsUsing(function () {
    return 'fake-random-string';
});

若要指示 random 方法恢復正常產生隨機字串，您可以呼叫 createRandomStringsNormally 方法。

Str::createRandomStringsNormally();

Str::remove()

Str::remove 方法會從字串中移除給定的值或值陣列。

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.

您也可以將 false 作為 remove 方法的第三個參數傳遞，以在移除字串時忽略大小寫。

Str::repeat()

Str::repeat 方法會重複給定的字串。

use Illuminate\Support\Str;
 
$string = 'a';
 
$repeat = Str::repeat($string, 5);
 
// aaaaa

Str::replace()

Str::replace 方法會替換字串中的給定字串。

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

replace 方法也接受 caseSensitive 參數。預設情況下，replace 方法會區分大小寫。

Str::replace('Framework', 'Laravel', caseSensitive: false);

Str::replaceArray()

Str::replaceArray 方法會使用陣列依序替換字串中的給定值。

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 方法會替換字串中第一次出現的給定值。

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 方法會替換字串中最後一次出現的給定值。

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::replaceMatches()

Str::replaceMatches 方法會使用給定的替換字串，替換字串中所有符合模式的部分。

use Illuminate\Support\Str;
 
$replaced = Str::replaceMatches(
    pattern: '/[^A-Za-z0-9]++/',
    replace: '',
    subject: '(+1) 501-555-1000'
)
 
// '15015551000'

replaceMatches 方法也接受一個閉包，該閉包會針對字串中每個符合給定模式的部分進行呼叫，允許您在閉包中執行替換邏輯並回傳替換的值。

use Illuminate\Support\Str;
 
$replaced = Str::replaceMatches('/\d/', function (array $matches) {
    return '['.$matches[0].']';
}, '123');
 
// '[1][2][3]'

Str::replaceStart()

Str::replaceStart 方法只會在給定的值出現在字串開頭時，替換該值的第一次出現。

use Illuminate\Support\Str;
 
$replaced = Str::replaceStart('Hello', 'Laravel', 'Hello World');
 
// Laravel World
 
$replaced = Str::replaceStart('World', 'Laravel', 'Hello World');
 
// Hello World

Str::replaceEnd()

Str::replaceEnd 方法只會在給定的值出現在字串結尾時，替換該值的最後一次出現。

use Illuminate\Support\Str;
 
$replaced = Str::replaceEnd('World', 'Laravel', 'Hello World');
 
// Hello Laravel
 
$replaced = Str::replaceEnd('Hello', 'Laravel', 'Hello World');
 
// Hello World

Str::reverse()

Str::reverse 方法會反轉給定的字串。

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

Str::singular()

Str::singular 方法會將字串轉換為單數形式。此函式支援任何 Laravel 的複數化工具支援的語言。

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

Str::slug()

Str::slug 方法會從給定的字串產生 URL 友善的「slug」。

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

Str::snake()

Str::snake 方法會將給定的字串轉換為 snake_case。

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

Str::squish()

Str::squish 方法會移除字串中所有多餘的空白，包括單字之間多餘的空白。

use Illuminate\Support\Str;
 
$string = Str::squish('    laravel    framework    ');
 
// laravel framework

Str::start()

如果字串開頭尚未包含給定的值，Str::start 方法會將該值單次加入字串開頭。

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

Str::startsWith()

Str::startsWith 方法會判斷給定的字串是否以給定的值開頭。

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

如果傳入可能的數值陣列，若字串以陣列中任一數值開頭，則 startsWith 方法會回傳 true。

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

Str::studly()

Str::studly 方法會將給定的字串轉換為 StudlyCase。

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

Str::substr()

Str::substr 方法會回傳由 start 和 length 參數指定的字串部分。

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

Str::substrCount()

Str::substrCount 方法會回傳給定字串中給定數值出現的次數。

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

Str::substrReplace()

Str::substrReplace 方法會替換字串中一部分的文字，從第三個參數指定的位置開始，並替換第四個參數指定的字元數。將 0 傳遞給方法的第四個參數，會在指定的位置插入字串，而不會替換字串中任何現有的字元。

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

Str::swap()

Str::swap 方法會使用 PHP 的 strtr 函式來替換給定字串中的多個值。

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

Str::take()

Str::take 方法會從字串的開頭回傳指定數量的字元。

use Illuminate\Support\Str;
 
$taken = Str::take('Build something amazing!', 5);
 
// Build

Str::title()

Str::title 方法會將給定的字串轉換為 Title Case。

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

Str::toBase64()

Str::toBase64 方法會將給定的字串轉換為 Base64。

use Illuminate\Support\Str;
 
$base64 = Str::toBase64('Laravel');
 
// TGFyYXZlbA==

Str::toHtmlString()

Str::toHtmlString 方法會將字串實例轉換為 Illuminate\Support\HtmlString 的實例，此實例可以在 Blade 模板中顯示。

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

Str::transliterate()

Str::transliterate 方法會嘗試將給定的字串轉換為最接近的 ASCII 表示法。

use Illuminate\Support\Str;
 
$email = Str::transliterate('ⓣⓔⓢⓣ@ⓛⓐⓡⓐⓥⓔⓛ.ⓒⓞⓜ');
 
// '[email protected]'

Str::trim()

Str::trim 方法會從給定字串的開頭和結尾移除空白（或其他字元）。與 PHP 原生的 trim 函式不同，Str::trim 方法也會移除 Unicode 空白字元。

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

Str::ltrim()

Str::ltrim 方法會從給定字串的開頭移除空白（或其他字元）。與 PHP 原生的 ltrim 函式不同，Str::ltrim 方法也會移除 Unicode 空白字元。

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

Str::rtrim()

Str::rtrim 方法會從給定字串的結尾移除空白（或其他字元）。與 PHP 原生的 rtrim 函式不同，Str::rtrim 方法也會移除 Unicode 空白字元。

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

Str::ucfirst()

Str::ucfirst 方法會回傳將第一個字元大寫的給定字串。

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

Str::ucsplit()

Str::ucsplit 方法會依據大寫字元將給定的字串分割為陣列。

use Illuminate\Support\Str;
 
$segments = Str::ucsplit('FooBar');
 
// [0 => 'Foo', 1 => 'Bar']

Str::upper()

Str::upper 方法會將給定的字串轉換為大寫。

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

Str::ulid()

Str::ulid 方法會產生一個 ULID，這是一個緊湊、按時間排序的唯一識別碼。

use Illuminate\Support\Str;
 
return (string) Str::ulid();
 
// 01gd6r360bp37zj17nxb55yv40

如果您想擷取一個 Illuminate\Support\Carbon 日期實例，表示給定 ULID 建立的日期和時間，可以使用 Laravel 的 Carbon 整合提供的 createFromId 方法。

use Illuminate\Support\Carbon;
use Illuminate\Support\Str;
 
$date = Carbon::createFromId((string) Str::ulid());

在測試期間，偽造 Str::ulid 方法回傳的值可能很有用。為此，您可以使用 createUlidsUsing 方法。

use Symfony\Component\Uid\Ulid;
 
Str::createUlidsUsing(function () {
    return new Ulid('01HRDBNHHCKNW2AK4Z29SN82T9');
});

若要指示 ulid 方法恢復正常產生 ULID，您可以呼叫 createUlidsNormally 方法。

Str::createUlidsNormally();

Str::unwrap()

Str::unwrap 方法會從給定字串的開頭和結尾移除指定的字串。

use Illuminate\Support\Str;
 
Str::unwrap('-Laravel-', '-');
 
// Laravel
 
Str::unwrap('{framework: "Laravel"}', '{', '}');
 
// framework: "Laravel"

Str::uuid()

Str::uuid 方法會產生一個 UUID（版本 4）。

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

在測試期間，偽造 Str::uuid 方法回傳的值可能很有用。為此，您可以使用 createUuidsUsing 方法。

use Ramsey\Uuid\Uuid;
 
Str::createUuidsUsing(function () {
    return Uuid::fromString('eadbfeac-5258-45c2-bab7-ccb9b5ef74f9');
});

若要指示 uuid 方法恢復正常產生 UUID，您可以呼叫 createUuidsNormally 方法。

Str::createUuidsNormally();

Str::wordCount()

Str::wordCount 方法會回傳字串包含的單字數。

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

Str::wordWrap()

Str::wordWrap 方法會將字串換行到給定的字元數。

use Illuminate\Support\Str;
 
$text = "The quick brown fox jumped over the lazy dog."
 
Str::wordWrap($text, characters: 20, break: "<br />\n");
 
/*
The quick brown fox<br />
jumped over the lazy<br />
dog.
*/

Str::words()

Str::words 方法會限制字串中的單字數。可以透過第三個參數將額外的字串傳遞給這個方法，以指定應該附加到截斷字串末端的字串。

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

Str::wrap()

Str::wrap 方法會使用額外的字串或一對字串來包裝給定的字串。

use Illuminate\Support\Str;
 
Str::wrap('Laravel', '"');
 
// "Laravel"
 
Str::wrap('is', before: 'This ', after: ' Laravel!');
 
// This is Laravel!

str()

str 函式會回傳給定字串的新的 Illuminate\Support\Stringable 實例。此函式等同於 Str::of 方法。

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

如果沒有提供任何參數給 str 函式，此函式會回傳 Illuminate\Support\Str 的實例。

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

trans()

trans 函式會使用您的語言檔案來翻譯給定的翻譯鍵。

echo trans('messages.welcome');

如果指定的翻譯鍵不存在，trans 函式會回傳給定的鍵。因此，以上面的範例來說，如果翻譯鍵不存在，trans 函式會回傳 messages.welcome。

trans_choice()

trans_choice 函式會翻譯給定帶有詞形變化的翻譯鍵。

echo trans_choice('messages.notifications', $unreadCount);

如果指定的翻譯鍵不存在，trans_choice 函式會回傳給定的鍵。因此，以上面的範例來說，如果翻譯鍵不存在，trans_choice 函式會回傳 messages.notifications。

流暢字串

流暢字串提供一個更流暢、物件導向的介面來處理字串值，允許您使用更易讀的語法將多個字串操作連結在一起，而非傳統的字串操作。

after

after 方法會回傳字串中給定值之後的所有內容。如果字串中不存在此值，將會回傳整個字串。

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

afterLast

afterLast 方法會回傳字串中給定值最後一次出現之後的所有內容。如果字串中不存在此值，將會回傳整個字串。

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

apa

apa 方法會依照APA 指南將給定的字串轉換為標題大小寫。

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

append

append 方法會將給定的值附加到字串。

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

ascii

ascii 方法會嘗試將字串音譯為 ASCII 值。

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

basename

basename 方法會回傳給定字串的尾端名稱元件。

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

如果需要，您可以提供一個「擴充功能」，將會從尾端元件移除。

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

before

before 方法會回傳字串中給定值之前的所有內容。

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

beforeLast

beforeLast 方法會回傳字串中給定值最後一次出現之前的所有內容。

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

between

between 方法會回傳兩個值之間的字串部分。

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

betweenFirst

betweenFirst 方法會回傳兩個值之間字串中最小的部分。

use Illuminate\Support\Str;
 
$converted = Str::of('[a] bc [d]')->betweenFirst('[', ']');
 
// 'a'

camel

camel 方法會將給定的字串轉換為 camelCase。

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

charAt

charAt 方法會回傳指定索引的字元。如果索引超出範圍，則會回傳 false。

use Illuminate\Support\Str;
 
$character = Str::of('This is my name.')->charAt(6);
 
// 's'

classBasename

classBasename 方法會回傳給定類別的類別名稱，並移除該類別的命名空間。

use Illuminate\Support\Str;
 
$class = Str::of('Foo\Bar\Baz')->classBasename();
 
// 'Baz'

chopStart

只有在值出現在字串的開頭時，chopStart 方法才會移除給定值的第一次出現。

use Illuminate\Support\Str;
 
$url = Str::of('https://laravel.dev.org.tw')->chopStart('https://');
 
// 'laravel.com'

您也可以傳遞陣列。如果字串以陣列中的任何值開頭，則該值會從字串中移除。

use Illuminate\Support\Str;
 
$url = Str::of('https://laravel.dev.org.tw')->chopStart(['https://', 'http://']);
 
// 'laravel.com'

chopEnd

只有在值出現在字串的結尾時，chopEnd 方法才會移除給定值的最後一次出現。

use Illuminate\Support\Str;
 
$url = Str::of('https://laravel.dev.org.tw')->chopEnd('.com');
 
// 'https://laravel'

您也可以傳遞陣列。如果字串以陣列中的任何值結尾，則該值會從字串中移除。

use Illuminate\Support\Str;
 
$url = Str::of('https://laravel.dev.org.tw')->chopEnd(['.com', '.io']);
 
// 'http://laravel'

contains

contains 方法會判斷給定的字串是否包含給定的值。預設情況下，此方法會區分大小寫。

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

您也可以傳遞一個值陣列，以判斷給定的字串是否包含陣列中的任何值。

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

您可以將 ignoreCase 參數設定為 true 來停用區分大小寫。

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

containsAll

containsAll 方法會判斷給定的字串是否包含給定陣列中的所有值。

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

您可以將 ignoreCase 參數設定為 true 來停用區分大小寫。

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

deduplicate

deduplicate 方法會將給定字串中連續出現的字元替換為該字元的單次出現。預設情況下，此方法會移除重複的空格。

use Illuminate\Support\Str;
 
$result = Str::of('The   Laravel   Framework')->deduplicate();
 
// The Laravel Framework

您可以將要去除重複的字元作為第二個參數傳遞給方法，以指定不同的字元。

use Illuminate\Support\Str;
 
$result = Str::of('The---Laravel---Framework')->deduplicate('-');
 
// The-Laravel-Framework

dirname

dirname 方法會回傳給定字串的父目錄部分。

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

如有必要，您可以指定要從字串中修剪多少個目錄層級。

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

endsWith

endsWith 方法會判斷給定的字串是否以給定的值結尾。

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

您也可以傳遞一個值陣列，以判斷給定的字串是否以陣列中的任何值結尾。

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 方法會判斷給定的字串是否與另一個字串完全匹配。

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

excerpt

excerpt 方法會從字串中擷取與該字串中第一個片語實例匹配的摘錄。

use Illuminate\Support\Str;
 
$excerpt = Str::of('This is my name')->excerpt('my', [
    'radius' => 3
]);
 
// '...is my na...'

radius 選項，預設為 100，可讓您定義應出現在截斷字串每一側的字元數。

此外，您可以使用 omission 選項來變更將附加到截斷字串開頭和結尾的字串。

use Illuminate\Support\Str;
 
$excerpt = Str::of('This is my name')->excerpt('name', [
    'radius' => 3,
    'omission' => '(...) '
]);
 
// '(...) my name'

explode

explode 方法會依據給定的分隔符號分割字串，並回傳一個包含已分割字串每個區段的集合。

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

finish

如果字串結尾尚未包含給定的值，finish 方法會將該值單次加入字串結尾。

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

headline

headline 方法會將以大小寫、連字號或底線分隔的字串轉換為以空格分隔的字串，並將每個單字的首字母大寫。

use Illuminate\Support\Str;
 
$headline = Str::of('taylor_otwell')->headline();
 
// Taylor Otwell
 
$headline = Str::of('EmailNotificationSent')->headline();
 
// Email Notification Sent

inlineMarkdown

inlineMarkdown 方法會使用 CommonMark 將 GitHub 風格的 Markdown 轉換為行內 HTML。但是，與 markdown 方法不同，它不會將所有產生的 HTML 包裝在區塊層級元素中。

use Illuminate\Support\Str;
 
$html = Str::of('**Laravel**')->inlineMarkdown();
 
// <strong>Laravel</strong>

Markdown 安全性

預設情況下，Markdown 支援原始 HTML，當與原始使用者輸入一起使用時，會暴露跨網站腳本 (XSS) 漏洞。根據 CommonMark 安全性文件，您可以使用 html_input 選項來轉義或刪除原始 HTML，並使用 allow_unsafe_links 選項來指定是否允許不安全的連結。如果您需要允許某些原始 HTML，則應將編譯後的 Markdown 透過 HTML Purifier 傳遞。

use Illuminate\Support\Str;
 
Str::of('Inject: <script>alert("Hello XSS!");</script>')->inlineMarkdown([
    'html_input' => 'strip',
    'allow_unsafe_links' => false,
]);
 
// Inject: alert(&quot;Hello XSS!&quot;);

is

is 方法會判斷給定的字串是否符合給定的模式。星號可作為萬用字元。

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

isAscii

isAscii 方法會判斷給定的字串是否為 ASCII 字串。

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

isEmpty

isEmpty 方法會判斷給定的字串是否為空。

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

isNotEmpty

isNotEmpty 方法會判斷給定的字串是否不為空。

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

isJson

isJson 方法會判斷給定的字串是否為有效的 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 方法會判斷給定的字串是否為 ULID。

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

isUrl

isUrl 方法會判斷給定的字串是否為 URL。

use Illuminate\Support\Str;
 
$result = Str::of('http://example.com')->isUrl();
 
// true
 
$result = Str::of('Taylor')->isUrl();
 
// false

isUrl 方法會將多種協定視為有效。但是，您可以透過將協定提供給 isUrl 方法，來指定應被視為有效的協定。

$result = Str::of('http://example.com')->isUrl(['http', 'https']);

isUuid

isUuid 方法會判斷給定的字串是否為 UUID。

use Illuminate\Support\Str;
 
$result = Str::of('5ace9ab9-e9cf-4ec6-a19d-5881212a452c')->isUuid();
 
// true
 
$result = Str::of('Taylor')->isUuid();
 
// false

kebab

kebab 方法會將給定的字串轉換為 kebab-case。

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

lcfirst

lcfirst 方法會傳回給定字串，並將第一個字元轉換為小寫。

use Illuminate\Support\Str;
 
$string = Str::of('Foo Bar')->lcfirst();
 
// foo Bar

length

length 方法會傳回給定字串的長度。

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

limit

limit 方法會將給定的字串截斷至指定的長度。

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

您也可以傳遞第二個參數來變更將附加到截斷字串末尾的字串。

$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20, ' (...)');
 
// The quick brown fox (...)

如果您希望在截斷字串時保留完整的單字，可以使用 preserveWords 參數。當此參數為 true 時，字串將會截斷到最接近的完整單字邊界。

$truncated = Str::of('The quick brown fox')->limit(12, preserveWords: true);
 
// The quick...

lower

lower 方法會將給定的字串轉換為小寫。

use Illuminate\Support\Str;
 
$result = Str::of('LARAVEL')->lower();
 
// 'laravel'

markdown

markdown 方法會將 GitHub 風格的 Markdown 轉換為 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>

Markdown 安全性

預設情況下，Markdown 支援原始 HTML，當與原始使用者輸入一起使用時，會暴露跨網站腳本 (XSS) 漏洞。根據 CommonMark 安全性文件，您可以使用 html_input 選項來轉義或刪除原始 HTML，並使用 allow_unsafe_links 選項來指定是否允許不安全的連結。如果您需要允許某些原始 HTML，則應將編譯後的 Markdown 透過 HTML Purifier 傳遞。

use Illuminate\Support\Str;
 
Str::of('Inject: <script>alert("Hello XSS!");</script>')->markdown([
    'html_input' => 'strip',
    'allow_unsafe_links' => false,
]);
 
// <p>Inject: alert(&quot;Hello XSS!&quot;);</p>

mask

mask 方法會使用重複的字元遮蔽字串的一部分，可用於模糊處理電子郵件地址和電話號碼等字串片段。

use Illuminate\Support\Str;
 
$string = Str::of('[email protected]')->mask('*', 3);
 
// tay***************

如果需要，您可以將負數作為 mask 方法的第三個或第四個參數提供，這會指示方法從字串的末尾開始遮蔽指定距離。

$string = Str::of('[email protected]')->mask('*', -15, 3);
 
// tay***@example.com
 
$string = Str::of('[email protected]')->mask('*', 4, -4);
 
// tayl**********.com

match

match 方法會傳回字串中符合給定正規表示式模式的部分。

use Illuminate\Support\Str;
 
$result = Str::of('foo bar')->match('/bar/');
 
// 'bar'
 
$result = Str::of('foo bar')->match('/foo (.*)/');
 
// 'bar'

matchAll

matchAll 方法會傳回一個集合，其中包含字串中符合給定正規表示式模式的部分。

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

如果您在表示式中指定一個符合群組，Laravel 將會傳回符合第一個群組的集合。

use Illuminate\Support\Str;
 
$result = Str::of('bar fun bar fly')->matchAll('/f(\w*)/');
 
// collect(['un', 'ly']);

如果找不到任何符合項，則會傳回一個空的集合。

isMatch

如果字串符合給定的正規表示式，isMatch 方法會傳回 true。

use Illuminate\Support\Str;
 
$result = Str::of('foo bar')->isMatch('/foo (.*)/');
 
// true
 
$result = Str::of('laravel')->isMatch('/foo (.*)/');
 
// false

newLine

newLine 方法會將「行尾」字元附加到字串。

use Illuminate\Support\Str;
 
$padded = Str::of('Laravel')->newLine()->append('Framework');
 
// 'Laravel
//  Framework'

padBoth

padBoth 方法包裝了 PHP 的 str_pad 函式，使用另一個字串填充字串的兩側，直到最終字串達到所需的長度。

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

padLeft

padLeft 方法包裝了 PHP 的 str_pad 函式，使用另一個字串填充字串的左側，直到最終字串達到所需的長度。

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

padRight

padRight 方法包裝了 PHP 的 str_pad 函式，使用另一個字串填充字串的右側，直到最終字串達到所需的長度。

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

pipe

pipe 方法允許您將字串的目前值傳遞給給定的可呼叫物件來轉換字串。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$hash = Str::of('Laravel')->pipe('md5')->prepend('Checksum: ');
 
// 'Checksum: a5c95b86291ea299fcbe64458ed12702'
 
$closure = Str::of('foo')->pipe(function (Stringable $str) {
    return 'bar';
});
 
// 'bar'

plural

plural 方法會將單數單字字串轉換為複數形式。此函式支援 Laravel 的複數化器支援的任何語言。

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

您可以將整數作為函式的第二個參數提供，以檢索字串的單數或複數形式。

use Illuminate\Support\Str;
 
$plural = Str::of('child')->plural(2);
 
// children
 
$plural = Str::of('child')->plural(1);
 
// child

position

position 方法會傳回子字串在字串中第一次出現的位置。如果子字串不存在於字串中，則會傳回 false。

use Illuminate\Support\Str;
 
$position = Str::of('Hello, World!')->position('Hello');
 
// 0
 
$position = Str::of('Hello, World!')->position('W');
 
// 7

prepend

prepend 方法會在字串前面加上給定的值。

use Illuminate\Support\Str;
 
$string = Str::of('Framework')->prepend('Laravel ');
 
// Laravel Framework

remove

remove 方法會從字串中移除給定的值或值陣列。

use Illuminate\Support\Str;
 
$string = Str::of('Arkansas is quite beautiful!')->remove('quite');
 
// Arkansas is beautiful!

您也可以傳遞 false 作為第二個參數，以便在移除字串時忽略大小寫。

repeat

repeat 方法會重複給定的字串。

use Illuminate\Support\Str;
 
$repeated = Str::of('a')->repeat(5);
 
// aaaaa

replace

replace 方法會取代字串中的給定字串。

use Illuminate\Support\Str;
 
$replaced = Str::of('Laravel 6.x')->replace('6.x', '7.x');
 
// Laravel 7.x

replace 方法也接受 caseSensitive 參數。預設情況下，replace 方法會區分大小寫。

$replaced = Str::of('macOS 13.x')->replace(
    'macOS', 'iOS', caseSensitive: false
);

replaceArray

replaceArray 方法會使用陣列循序取代字串中的給定值。

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 方法會取代字串中第一次出現的給定值。

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 方法會取代字串中最後一次出現的給定值。

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 方法會使用給定的取代字串取代字串中所有符合模式的部分。

use Illuminate\Support\Str;
 
$replaced = Str::of('(+1) 501-555-1000')->replaceMatches('/[^A-Za-z0-9]++/', '')
 
// '15015551000'

replaceMatches 方法也接受一個閉包，該閉包會針對字串中每個符合給定模式的部分進行呼叫，允許您在閉包中執行替換邏輯並回傳替換的值。

use Illuminate\Support\Str;
 
$replaced = Str::of('123')->replaceMatches('/\d/', function (array $matches) {
    return '['.$matches[0].']';
});
 
// '[1][2][3]'

replaceStart

replaceStart 方法僅在值出現在字串開頭時才取代第一次出現的給定值。

use Illuminate\Support\Str;
 
$replaced = Str::of('Hello World')->replaceStart('Hello', 'Laravel');
 
// Laravel World
 
$replaced = Str::of('Hello World')->replaceStart('World', 'Laravel');
 
// Hello World

replaceEnd

replaceEnd 方法僅在值出現在字串結尾時才取代最後一次出現的給定值。

use Illuminate\Support\Str;
 
$replaced = Str::of('Hello World')->replaceEnd('World', 'Laravel');
 
// Hello Laravel
 
$replaced = Str::of('Hello World')->replaceEnd('Hello', 'Laravel');
 
// Hello World

scan

scan 方法會根據 sscanf PHP 函式支援的格式，將字串中的輸入剖析為集合。

use Illuminate\Support\Str;
 
$collection = Str::of('filename.jpg')->scan('%[^.].%s');
 
// collect(['filename', 'jpg'])

singular

singular 方法會將字串轉換為單數形式。此函式支援 Laravel 的複數化器支援的任何語言。

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

slug

slug 方法會從給定的字串產生一個 URL 友善的「slug」。

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

snake

snake 方法會將給定的字串轉換為 snake_case。

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

split

split 方法會使用正規表示式將字串分割為集合。

use Illuminate\Support\Str;
 
$segments = Str::of('one, two, three')->split('/[\s,]+/');
 
// collect(["one", "two", "three"])

squish

squish 方法會移除字串中所有多餘的空白，包括單字之間多餘的空白。

use Illuminate\Support\Str;
 
$string = Str::of('    laravel    framework    ')->squish();
 
// laravel framework

start

如果字串開頭尚未包含該值，start 方法會將給定值的單個實例新增至字串。

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

startsWith

startsWith 方法會判斷給定的字串是否以給定的值開頭。

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

stripTags

stripTags 方法會移除字串中所有 HTML 和 PHP 標籤。

use Illuminate\Support\Str;
 
$result = Str::of('<a href="https://laravel.dev.org.tw">Taylor <b>Otwell</b></a>')->stripTags();
 
// Taylor Otwell
 
$result = Str::of('<a href="https://laravel.dev.org.tw">Taylor <b>Otwell</b></a>')->stripTags('<b>');
 
// Taylor <b>Otwell</b>

studly

studly 方法會將給定的字串轉換為 StudlyCase。

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

substr

substr 方法會傳回由給定的起始和長度參數指定的字串部分。

use Illuminate\Support\Str;
 
$string = Str::of('Laravel Framework')->substr(8);
 
// Framework
 
$string = Str::of('Laravel Framework')->substr(8, 5);
 
// Frame

substrReplace

substrReplace 方法會取代字串一部分中的文字，從第二個參數指定的位置開始，並取代由第三個參數指定的字元數。將 0 傳遞給方法的第三個參數，將會在指定的位置插入字串，而不會取代字串中的任何現有字元。

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 方法會使用 PHP 的 strtr 函式取代字串中的多個值。

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

take

take 方法會傳回字串開頭指定數量的字元。

use Illuminate\Support\Str;
 
$taken = Str::of('Build something amazing!')->take(5);
 
// Build

tap

tap 方法會將字串傳遞給給定的閉包，讓您在不影響字串本身的情況下檢查和與字串互動。無論閉包傳回什麼，tap 方法都會傳回原始字串。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('Laravel')
    ->append(' Framework')
    ->tap(function (Stringable $string) {
        dump('String after append: '.$string);
    })
    ->upper();
 
// LARAVEL FRAMEWORK

test

test 方法會判斷字串是否符合給定的正規表示式模式。

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

title

title 方法會將給定的字串轉換為 Title Case。

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

toBase64()

toBase64 方法會將給定的字串轉換為 Base64。

use Illuminate\Support\Str;
 
$base64 = Str::of('Laravel')->toBase64();
 
// TGFyYXZlbA==

transliterate

transliterate 方法會嘗試將給定的字串轉換為最接近的 ASCII 表示法。

use Illuminate\Support\Str;
 
$email = Str::of('ⓣⓔⓢⓣ@ⓛⓐⓡⓐⓥⓔⓛ.ⓒⓞⓜ')->transliterate()
 
// '[email protected]'

trim

trim 方法會修剪給定的字串。與 PHP 的原生 trim 函式不同，Laravel 的 trim 方法也會移除 Unicode 空白字元。

use Illuminate\Support\Str;
 
$string = Str::of('  Laravel  ')->trim();
 
// 'Laravel'
 
$string = Str::of('/Laravel/')->trim('/');
 
// 'Laravel'

ltrim

ltrim 方法會修剪字串的左側。與 PHP 的原生 ltrim 函式不同，Laravel 的 ltrim 方法也會移除 Unicode 空白字元。

use Illuminate\Support\Str;
 
$string = Str::of('  Laravel  ')->ltrim();
 
// 'Laravel  '
 
$string = Str::of('/Laravel/')->ltrim('/');
 
// 'Laravel/'

rtrim

rtrim 方法會修剪給定字串的右側。與 PHP 的原生 rtrim 函式不同，Laravel 的 rtrim 方法也會移除 Unicode 空白字元。

use Illuminate\Support\Str;
 
$string = Str::of('  Laravel  ')->rtrim();
 
// '  Laravel'
 
$string = Str::of('/Laravel/')->rtrim('/');
 
// '/Laravel'

ucfirst

ucfirst 方法會傳回給定的字串，並將第一個字元轉換為大寫。

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

ucsplit

ucsplit 方法會根據大寫字元將給定的字串分割為集合。

use Illuminate\Support\Str;
 
$string = Str::of('Foo Bar')->ucsplit();
 
// collect(['Foo', 'Bar'])

unwrap

unwrap 方法會從給定字串的開頭和結尾移除指定的字串。

use Illuminate\Support\Str;
 
Str::of('-Laravel-')->unwrap('-');
 
// Laravel
 
Str::of('{framework: "Laravel"}')->unwrap('{', '}');
 
// framework: "Laravel"

upper

upper 方法會將給定的字串轉換為大寫。

use Illuminate\Support\Str;
 
$adjusted = Str::of('laravel')->upper();
 
// LARAVEL

when

如果給定的條件為 true，when 方法會調用給定的閉包。閉包將會接收流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('Taylor')
                ->when(true, function (Stringable $string) {
                    return $string->append(' Otwell');
                });
 
// 'Taylor Otwell'

如有必要，您可以將另一個閉包作為 when 方法的第三個參數傳遞。如果條件參數的評估結果為 false，則會執行此閉包。

whenContains

如果字串包含給定的值，whenContains 方法會調用給定的閉包。閉包將會接收流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('tony stark')
            ->whenContains('tony', function (Stringable $string) {
                return $string->title();
            });
 
// 'Tony Stark'

如有必要，您可以將另一個閉包作為 when 方法的第三個參數傳遞。如果字串不包含給定的值，則會執行此閉包。

您也可以傳遞一個值陣列，以判斷給定的字串是否包含陣列中的任何值。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('tony stark')
            ->whenContains(['tony', 'hulk'], function (Stringable $string) {
                return $string->title();
            });
 
// Tony Stark

whenContainsAll

如果字串包含所有給定的子字串，whenContainsAll 方法會調用給定的閉包。閉包將會接收流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('tony stark')
                ->whenContainsAll(['tony', 'stark'], function (Stringable $string) {
                    return $string->title();
                });
 
// 'Tony Stark'

如有必要，您可以將另一個閉包作為 when 方法的第三個參數傳遞。如果條件參數的評估結果為 false，則會執行此閉包。

whenEmpty

如果字串為空，whenEmpty 方法會調用給定的閉包。如果閉包傳回值，則該值也會由 whenEmpty 方法傳回。如果閉包未傳回值，則會傳回流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('  ')->whenEmpty(function (Stringable $string) {
    return $string->trim()->prepend('Laravel');
});
 
// 'Laravel'

whenNotEmpty

如果字串不為空，whenNotEmpty 方法會調用給定的閉包。如果閉包傳回值，則該值也會由 whenNotEmpty 方法傳回。如果閉包未傳回值，則會傳回流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('Framework')->whenNotEmpty(function (Stringable $string) {
    return $string->prepend('Laravel ');
});
 
// 'Laravel Framework'

whenStartsWith

如果字串以給定的子字串開頭，whenStartsWith 方法會調用給定的閉包。閉包將接收流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('disney world')->whenStartsWith('disney', function (Stringable $string) {
    return $string->title();
});
 
// 'Disney World'

whenEndsWith

如果字串以給定的子字串結尾，whenEndsWith 方法會調用給定的閉包。閉包將接收流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('disney world')->whenEndsWith('world', function (Stringable $string) {
    return $string->title();
});
 
// 'Disney World'

whenExactly

如果字串與給定的字串完全匹配，whenExactly 方法會調用給定的閉包。閉包將接收流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('laravel')->whenExactly('laravel', function (Stringable $string) {
    return $string->title();
});
 
// 'Laravel'

whenNotExactly

如果字串與給定的字串不完全匹配，whenNotExactly 方法會調用給定的閉包。閉包將接收流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('framework')->whenNotExactly('laravel', function (Stringable $string) {
    return $string->title();
});
 
// 'Framework'

whenIs

如果字串符合給定的模式，whenIs 方法會調用給定的閉包。星號可以用作萬用字元。閉包將接收流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('foo/bar')->whenIs('foo/*', function (Stringable $string) {
    return $string->append('/baz');
});
 
// 'foo/bar/baz'

whenIsAscii

如果字串是 7 位元 ASCII 字元，whenIsAscii 方法會調用給定的閉包。閉包將接收流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('laravel')->whenIsAscii(function (Stringable $string) {
    return $string->title();
});
 
// 'Laravel'

whenIsUlid

如果字串是有效的 ULID，whenIsUlid 方法會調用給定的閉包。閉包將接收流暢字串實例。

use Illuminate\Support\Str;
 
$string = Str::of('01gd6r360bp37zj17nxb55yv40')->whenIsUlid(function (Stringable $string) {
    return $string->substr(0, 8);
});
 
// '01gd6r36'

whenIsUuid

如果字串是有效的 UUID，whenIsUuid 方法會調用給定的閉包。閉包將接收流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('a0a2a2d2-0b87-4a18-83f2-2529882be2de')->whenIsUuid(function (Stringable $string) {
    return $string->substr(0, 8);
});
 
// 'a0a2a2d2'

whenTest

如果字串符合給定的正規表示式，whenTest 方法會調用給定的閉包。閉包將接收流暢字串實例。

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
 
$string = Str::of('laravel framework')->whenTest('/laravel/', function (Stringable $string) {
    return $string->title();
});
 
// 'Laravel Framework'

wordCount

wordCount 方法會回傳字串包含的單字數量。

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

words

words 方法會限制字串中的單字數量。如有必要，您可以指定一個額外的字串，將附加到截斷的字串。

use Illuminate\Support\Str;
 
$string = Str::of('Perfectly balanced, as all things should be.')->words(3, ' >>>');
 
// Perfectly balanced, as >>>

wrap

wrap 方法會用一個額外的字串或一對字串包裝給定的字串。

use Illuminate\Support\Str;
 
Str::of('Laravel')->wrap('"');
 
// "Laravel"
 
Str::is('is')->wrap(before: 'This ', after: ' Laravel!');
 
// This is Laravel!