[8.x] Adds Str::remove and Str::of('foobar')->remove methods

src/Illuminate/Support/Str.php

@@ -558,6 +558,29 @@ public static function replaceLast($search, $replace, $subject)
         return $subject;
     }
 
+    /**
+     * Remove any occurrence of the given string in the subject.
+     *
+     * @param string|array<string> $search
+     * @param string $subject
+     * @param bool $caseSensitive
+     * @return string
+     */
+    public static function remove($search, $subject, $caseSensitive = true)
+    {
+        $regexSafeSearches = array_map(function ($search) {
+            return preg_quote($search);
+        }, is_array($search) ? $search : [$search]);
+
+        $regex = "/".implode("|", $regexSafeSearches)."/";
+
+        if (! $caseSensitive) {
+            $regex .= "i";
+        }
+
+        return preg_replace($regex, "", $subject);
+    }
+
     /**
      * Begin a string with a single instance of a given value.
      *

src/Illuminate/Support/Stringable.php

@@ -467,6 +467,18 @@ public function prepend(...$values)
         return new static(implode('', $values).$this->value);
     }
 
+    /**
+     * Remove any occurrence of the given string in the subject.
+     *
+     * @param string|array<string> $search
+     * @param bool $caseSensitive
+     * @return static
+     */
+    public function remove($search, $caseSensitive = true)
+    {
+        return new static(Str::remove($search, $this->value, $caseSensitive));
+    }
+
     /**
      * Replace the given value in the given string.
      *

tests/Support/SupportStrTest.php

@@ -365,6 +365,20 @@ public function testReplaceLast()
         $this->assertSame('Malmö Jönköping', Str::replaceLast('', 'yyy', 'Malmö Jönköping'));
     }
 
+    public function testRemove()
+    {
+        $this->assertSame("Fbar", Str::remove('o', 'Foobar'));
+        $this->assertSame("Foo", Str::remove('bar', 'Foobar'));
+        $this->assertSame("oobar", Str::remove('F', 'Foobar'));
+        $this->assertSame("Foobar", Str::remove('f', 'Foobar'));
+        $this->assertSame("oobar", Str::remove('f', 'Foobar', false));
+
+        $this->assertSame("Fbr", Str::remove(["o", "a"], 'Foobar'));
+        $this->assertSame("Fooar", Str::remove(["f", "b"], 'Foobar'));
+        $this->assertSame("ooar", Str::remove(["f", "b"], 'Foobar', false));
+        $this->assertSame("Foobar", Str::remove(["f", "|"], 'Foo|bar'));
+    }
+
     public function testSnake()
     {
         $this->assertSame('laravel_p_h_p_framework', Str::snake('LaravelPHPFramework'));

tests/Support/SupportStringableTest.php

@@ -3,6 +3,7 @@
 namespace Illuminate\Tests\Support;
 
 use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
 use Illuminate\Support\Stringable;
 use PHPUnit\Framework\TestCase;
 
@@ -452,6 +453,20 @@ public function testReplaceLast()
         $this->assertSame('Malmö Jönköping', (string) $this->stringable('Malmö Jönköping')->replaceLast('', 'yyy'));
     }
 
+    public function testRemove()
+    {
+        $this->assertSame("Fbar", (string) $this->stringable('Foobar')->remove('o'));
+        $this->assertSame("Foo", (string) $this->stringable('Foobar')->remove('bar'));
+        $this->assertSame("oobar", (string) $this->stringable('Foobar')->remove('F'));
+        $this->assertSame("Foobar", (string) $this->stringable('Foobar')->remove('f'));
+        $this->assertSame("oobar", (string) $this->stringable('Foobar')->remove('f', false));
+
+        $this->assertSame("Fbr", (string) $this->stringable('Foobar')->remove(["o", "a"]));
+        $this->assertSame("Fooar", (string) $this->stringable('Foobar')->remove(["f", "b"]));
+        $this->assertSame("ooar", (string) $this->stringable('Foobar')->remove(["f", "b"], false));
+        $this->assertSame("Foobar", (string) $this->stringable('Foo|bar')->remove(["f", "|"]));
+    }
+
     public function testSnake()
     {
         $this->assertSame('laravel_p_h_p_framework', (string) $this->stringable('LaravelPHPFramework')->snake());