diff --git a/README.md b/README.md index 5fe358a..2700759 100644 --- a/README.md +++ b/README.md @@ -648,14 +648,15 @@ S::shuffle('fòô bàř', 'UTF-8'); // 'àôřb òf' #### slugify -$stringy->slugify() +$stringy->slugify([ string $replacement = '-' ]) -S::slugify(string $str) +S::slugify(string $str [, string $replacement = '-' ]) Converts the string into an URL slug. This includes replacing non-ASCII characters with their closest ASCII equivalents, removing non-alphanumeric -and non-ASCII characters, and replacing whitespace with dashes. The string -is also converted to lowercase. +and non-ASCII characters, and replacing whitespace with $replacement. +The replacement defaults to a single dash, and the string is also +converted to lowercase. ```php S::create('Using strings like fòô bàř')->slugify(); diff --git a/src/Stringy/StaticStringy.php b/src/Stringy/StaticStringy.php index ba09b23..e73fb08 100644 --- a/src/Stringy/StaticStringy.php +++ b/src/Stringy/StaticStringy.php @@ -325,12 +325,12 @@ class StaticStringy /** * Converts the string into an URL slug. This includes replacing non-ASCII * characters with their closest ASCII equivalents, removing non-alphanumeric - * and non-ASCII characters, and replacing whitespace with dashes. The string - * is also converted to lowercase. If defined, whitespace is replaced with - * $replacement instead of dashes. + * and non-ASCII characters, and replacing whitespace with $replacement. + * The replacement defaults to a single dash, and the string is also + * converted to lowercase. * * @param string $str Text to transform into an URL slug - * @param string $replacement The string to replace whitespace with + * @param string $replacement The string used to replace whitespace * @return string The corresponding URL slug */ public static function slugify($str, $replacement = '-') diff --git a/src/Stringy/Stringy.php b/src/Stringy/Stringy.php index 5ec7ee4..c152154 100644 --- a/src/Stringy/Stringy.php +++ b/src/Stringy/Stringy.php @@ -577,11 +577,11 @@ class Stringy /** * Converts the string into an URL slug. This includes replacing non-ASCII * characters with their closest ASCII equivalents, removing non-alphanumeric - * and non-ASCII characters, and replacing whitespace with dashes. The string - * is also converted to lowercase. If defined, whitespace is replaced with - * $replacement instead of dashes. + * and non-ASCII characters, and replacing whitespace with $replacement. + * The replacement defaults to a single dash, and the string is also + * converted to lowercase. * - * @param string $replacement The string to replace whitespace with + * @param string $replacement The string used to replace whitespace * @return Stringy Object whose $str has been converted to an URL slug */ public function slugify($replacement = '-')