sanitize_title( string $title, string $fallback_title = '', string $context = 'save' )
Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
Description
By default, converts accent characters to ASCII characters and further limits the output to alphanumeric characters, underscore (_) and dash (-) through the ‘sanitize_title’ filter.
If $title is empty and $fallback_title is set, the latter will be used.
Parameters
- $title
-
(Required) The string to be sanitized.
- $fallback_title
-
(Optional) A title to use if $title is empty.
Default value: ''
- $context
-
(Optional) The operation for which the string is sanitized.<br> When set to 'save', the string runs through remove_accents().<br> Default 'save'.
Default value: 'save'
Return
(string) The sanitized string.
Source
File: wp-includes/formatting.php
function sanitize_title( $title, $fallback_title = '', $context = 'save' ) {
$raw_title = $title;
if ( 'save' == $context )
$title = remove_accents($title);
/**
* Filters a sanitized title string.
*
* @since WP-1.2.0
*
* @param string $title Sanitized title.
* @param string $raw_title The title prior to sanitization.
* @param string $context The context for which the title is being sanitized.
*/
$title = apply_filters( 'sanitize_title', $title, $raw_title, $context );
if ( '' === $title || false === $title )
$title = $fallback_title;
return $title;
}
Changelog
| Version | Description |
|---|---|
| 1.0.0 | Introduced. |