slugify
Version 4.6.0 (10 September 2024)
Converts a string into a slug.
Developed by Florian Eckerstorfer in Vienna, Europe with the help of many great contributors.
ae replaces ä).You can install Slugify through Composer:
composer require cocur/slugifySlugify requires the Multibyte String extension from PHP. Typically you can use the configure option --enable-mbstring while compiling PHP. More information can be found in the PHP documentation.
Further steps may be needed for integrations.
Generate a slug:
use CocurSlugifySlugify;
$slugify = new Slugify();
echo $slugify->slugify("Hello World!"); // hello-worldYou can also change the separator used by Slugify:
echo $slugify->slugify("Hello World!", "_"); // hello_worldThe library also contains CocurSlugifySlugifyInterface. Use this interface whenever you need to type hint an
instance of Slugify.
To add additional transliteration rules you can use the addRule() method.
$slugify->addRule("i", "ey");
echo $slugify->slugify("Hi"); // heyMany of the transliterations rules used in Slugify are specific to a language. These rules are therefore categorized
using rulesets. Rules for the most popular are activated by default in a specific order. You can change which rulesets
are activated and the order in which they are activated. The order is important when there are conflicting rules in
different languages. For example, in German ä is transliterated with ae, in Turkish the correct transliteration is
a. By default the German transliteration is used since German is used more often on the internet. If you want to use
prefer the Turkish transliteration you have to possibilities. You can activate it after creating the constructor:
$slugify = new Slugify();
$slugify->slugify("ä"); // -> "ae"
$slugify->activateRuleSet("turkish");
$slugify->slugify("ä"); // -> "a"An alternative way would be to pass the rulesets and their order to the constructor.
$slugify = new Slugify(["rulesets" => ["default", "turkish"]]);
$slugify->slugify("ä"); // -> "a"You can find a list of the available rulesets in Resources/rules.
The constructor takes an options array, you have already seen the rulesets options above. You can also change the
regular expression that is used to replace characters with the separator.
$slugify = new Slugify(["regexp" => "/([^A-Za-z0-9]|-)+/"]);(The regular expression used in the example above is the default one.)
By default Slugify will convert the slug to lowercase. If you want to preserve the case of the string you can set the
lowercase option to false.
$slugify = new Slugify(["lowercase" => false]);
$slugify->slugify("Hello World"); // -> "Hello-World"Lowercasing is done before using the regular expression. If you want to keep the lowercasing behavior but your regular
expression needs to match uppercase letters, you can set the lowercase_after_regexp option to true.
$slugify = new Slugify([
"regexp" => "/(?<=[[:^upper:]])(?=[[:upper:]])/",
"lowercase_after_regexp" => false,
]);
$slugify->slugify("FooBar"); // -> "foo-bar"By default Slugify will use dashes as separators. If you want to use a different default separator, you can set the
separator option.
$slugify = new Slugify(["separator" => "_"]);
$slugify->slugify("Hello World"); // -> "hello_world"By default Slugify will remove leading and trailing separators before returning the slug. If you do not want the slug to
be trimmed you can set the trim option to false.
$slugify = new Slugify(["trim" => false]);
$slugify->slugify("Hello World "); // -> "hello-world-"You can overwrite any of the above options on the fly by passing an options array as second argument to the slugify()
method. For example:
$slugify = new Slugify();
$slugify->slugify("Hello World", ["lowercase" => false]); // -> "Hello-World"You can also modify the separator this way:
$slugify = new Slugify();
$slugify->slugify("Hello World", ["separator" => "_"]); // -> "hello_world"You can even activate a custom ruleset without touching the default rules:
$slugify = new Slugify();
$slugify->slugify("für", ["ruleset" => "turkish"]); // -> "fur"
$slugify->slugify("für"); // -> "fuer"We really appreciate if you report bugs and errors in the transliteration, especially if you are a native speaker of the language and question. Feel free to ask for additional languages in the issues, but please note that the maintainer of this repository does not speak all languages. If you can provide a Pull Request with rules for a new language or extend the rules for an existing language that would be amazing.
To add a new language you need to:
[language].json in Resources/rulesCocurSlugifySlugify::$options. If you add the language there all existing tests still have to passphp bin/generate-default.phptests/SlugifyTest.php. If the language is in the default ruleset add your
test cases to defaultRuleProvider(), otherwise to customRulesProvider().Submit PR. Thank you very much.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
The full Code of Conduct can be found here.
This project is no place for hate. If you have any problems please contact Florian: [email protected]
Slugify contains a Symfony bundle and service definition that allow you to use it as a service in your Symfony application. The code resides in CocurSlugifyBridgeSymfonyCocurSlugifyBundle and you only need to activate it:
Support for Symfony 2 has been dropped in Slugify 4.0.0, use cocur/slugify@3.
// app/AppKernel.php
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = [
// ...
new CocurSlugifyBridgeSymfonyCocurSlugifyBundle(),
];
}
}// config/bundles.php
return [
// ...
CocurSlugifyBridgeSymfonyCocurSlugifyBundle::class => ["all" => true],
];You can now use the cocur_slugify service everywhere in your application, for example, in your controller:
$slug = $this->get("cocur_slugify")->slugify("Hello World!");The bundle also provides an alias slugify for the cocur_slugify service:
$slug = $this->get("slugify")->slugify("Hello World!");If you use autowire (Symfony >=3.3), you can inject it into your services like this:
public function __construct(CocurSlugifySlugifyInterface $slugify)You can set the following configuration settings in config.yml (Symfony 2-3) or
config/packages/cocur_slugify.yaml (Symfony 4) to adjust the slugify service:
cocur_slugify:
lowercase: false # or true
separator: "-" # any string
# regexp: If you use the Symfony framework with Twig you can use the Twig filter slugify in your templates after you have setup
Symfony integrations (see above).
{{ 'Hällo Wörld'|slugify }}If you use Twig outside of the Symfony framework you first need to add the extension to your environment:
use CocurSlugifyBridgeTwigSlugifyExtension;
use CocurSlugifySlugify;
$twig = new Twig_Environment($loader);
$twig->addExtension(new SlugifyExtension(Slugify::create()));To use the Twig filter with TwigBridge for Laravel, you'll need to add the Slugify extension using a closure:
// laravel/app/config/packages/rcrowe/twigbridge/config.php
'extensions' => array(
//...
function () {
return new CocurSlugifyBridgeTwigSlugifyExtension(CocurSlugifySlugify::create());
},
),You can find more information about registering extensions in the Twig documentation.
We don't need an additional integration to use Slugify in Mustache.php. If you want to use Slugify in Mustache, just add a helper:
use CocurSlugifySlugify;
$mustache = new Mustache_Engine([
// ...
"helpers" => [
"slugify" => function ($string, $separator = null) {
return Slugify::create()->slugify($string, $separator);
},
],
]);Slugify also provides a service provider to integrate into Laravel (versions 4.1 and later).
In your Laravel project's app/config/app.php file, add the service provider into the "providers" array:
'providers' => array(
"CocurSlugifyBridgeLaravelSlugifyServiceProvider",
)And add the facade into the "aliases" array:
'aliases' => array(
"Slugify" => "CocurSlugifyBridgeLaravelSlugifyFacade",
)You can then use the Slugify::slugify() method in your controllers:
$url = Slugify::slugify("welcome to the homepage");Slugify can be easely used in Zend Framework 2 applications. Included bridge provides a service and a view helper already registered for you.
Just enable the module in your configuration like this.
return [
//...
"modules" => [
"Application",
"ZfcBase",
"CocurSlugifyBridgeZF2", // <- Add this line
//...
],
//...
];After that you can retrieve the CocurSlugifySlugify service (or the slugify alias) and generate a slug.
/** @var ZendServiceManagerServiceManager $sm */
$slugify = $sm->get("CocurSlugifySlugify");
$slug = $slugify->slugify("Hällo Wörld");
$anotherSlug = $slugify->slugify("Hällo Wörld", "_");In your view templates use the slugify helper to generate slugs.
echo $this->slugify("Hällo Wörld"); ?>
echo $this->slugify("Hällo Wörld", "_"); ?>The service (which is also used in the view helper) can be customized by defining this configuration key.
return [
"cocur_slugify" => [
"reg_exp" => "/([^a-zA-Z0-9]|-)+/",
],
];Slugify contains a Nette extension that allows you to use it as a service in your Nette application. You only need to
register it in your config.neon:
# app/config/config.neon
extensions:
slugify: CocurSlugifyBridgeNetteSlugifyExtensionYou can now use the CocurSlugifySlugifyInterface service everywhere in your application, for example in your
presenter:
class MyPresenter extends NetteApplicationUIPresenter
{
/** @var CocurSlugifySlugifyInterface @inject */
public $slugify;
public function renderDefault()
{
$this->template->hello = $this->slugify->slugify("Hällo Wörld");
}
}If you use the Nette Framework with it's native Latte templating engine, you can use the Latte filter slugify in your
templates after you have setup Nette extension (see above).
{$hello|slugify}If you use Latte outside of the Nette Framework you first need to add the filter to your engine:
use CocurSlugifyBridgeLatteSlugifyHelper;
use CocurSlugifySlugify;
use Latte;
$latte = new LatteEngine();
$latte->addFilter("slugify", [new SlugifyHelper(Slugify::create()), "slugify"]);Slugify does not need a specific bridge to work with Slim 3, just add the following configuration:
$container["view"] = function ($c) {
$settings = $c->get("settings");
$view = new SlimViewsTwig(
$settings["view"]["template_path"],
$settings["view"]["twig"]
);
$view->addExtension(
new SlimViewsTwigExtension(
$c->get("router"),
$c->get("request")->getUri()
)
);
$view->addExtension(
new CocurSlugifyBridgeTwigSlugifyExtension(
CocurSlugifySlugify::create()
)
);
return $view;
};In a template you can use it like this:
<a href="/blog/{{ post.title|slugify }}">{{ post.title|raw }}a>h5>Slugify provides a service provider for use with league/container:
use CocurSlugify;
use LeagueContainer;
/* @var ContainerContainerInterface $container */
$container->addServiceProvider(
new SlugifyBridgeLeagueSlugifyServiceProvider()
);
/* @var SlugifySlugify $slugify */
$slugify = $container->get(SlugifySlugifyInterface::class);You can configure it by sharing the required options:
use CocurSlugify;
use LeagueContainer;
/* @var ContainerContainerInterface $container */
$container->share("config.slugify.options", [
"lowercase" => false,
"rulesets" => ["default", "german"],
]);
$container->addServiceProvider(
new SlugifyBridgeLeagueSlugifyServiceProvider()
);
/* @var SlugifySlugify $slugify */
$slugify = $container->get(SlugifySlugifyInterface::class);You can configure which rule provider to use by sharing it:
use CocurSlugify;
use LeagueContainer;
/* @var ContainerContainerInterface $container */
$container->share(SlugifyRuleProviderRuleProviderInterface::class, function () {
return new SlugifyRuleProviderFileRuleProvider(__DIR__ . '/../../rules');
]);
$container->addServiceProvider(new SlugifyBridgeLeagueSlugifyServiceProvider());
/* @var SlugifySlugify $slugify */
$slugify = $container->get(SlugifySlugifyInterface::class);Support for Symfony 6.
Version 4 does not introduce new major features, but adds support for Symfony 4 and 5, Twig 3 and, most importantly, PHP 7.3 and 7.4.
Support for PHP 5, Twig 1 and Silex is dropped.
composer.json (by wandersonwhcr)DefaultRuleProvider (by gsouf)getName() to CocurSlugifyBridgeTwigSlugifyExtension (by TomCan)DefaultRuleProvider alphabetically (by tbmatuka)bindShared with singleton in Laravel bridge (by sunspikes)bindShared with singleton in Laravel bridge (by sunspikes)No new features or bugfixes, but it's about time to pump Slugify to v1.0.
protected (by acelaya)Ď (by michalskop)Slugify classThis version introduces optional integrations into Symfony2, Silex and Twig. You can still use the library in any other framework. I decided to include these bridges because there exist integrations from other developers, but they use outdated versions of cocur/slugify. Including these small bridge classes in the library makes maintaining them a lot easier for me.
$separator parameter to SlugifyInterfaceNearly completely rewritten code, removes iconv support because the underlying library is broken. The code is now better and faster. Many thanks to Marchenko Alexandr.
Support for Chinese is adapted from jifei/Pinyin with permission.
Slugify is a project of Cocur. You can contact us on Twitter: @cocurco
If you need support you can ask on Twitter (well, only if your question is short) or you can join our chat on Gitter.
In case you want to support the development of Slugify you can help us with providing additional transliterations or inform us if a transliteration is wrong. We would highly appreciate it if you can send us directly a Pull Request on Github. If you have never contributed to a project on Github we are happy to help you. Just ask on Twitter or directly join our Gitter.
You always can help me (Florian, the original developer and maintainer) out by sending me an Euro or two.
The MIT License (MIT)
Copyright (c) 2012-2017 Florian Eckerstorfer
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
