W3cubDocs

/WordPress

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

(string) (Required) The string to be sanitized.

$fallback_title

(string) (Optional) A title to use if $title is empty.

Default value: ''

$context

(string) (Optional) The operation for which the string is sanitized.

Default value: 'save'

Return

(string) The sanitized string.

More Information

The ‘save’ context is used most often when saving a value in the database, but is used for other purposes as well. The ‘query’ context is used by sanitize_title_for_query() when the value is going to be used in the WHERE clause of a query.

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 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;
}

Uses

Uses Description
wp-includes/formatting.php: sanitize_title

Filters a sanitized title string.
wp-includes/formatting.php: remove_accents()

Converts all accent characters to ASCII characters.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Used By

Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php: WP_REST_Attachments_Controller::insert_attachment()

Inserts the attachment post in the database. Does not update the attachment meta.
wp-admin/includes/class-wp-privacy-policy-content.php: WP_Privacy_Policy_Content::privacy_policy_guide()

Output the privacy policy guide together with content from the theme and plugins.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::import_theme_starter_content()

Import theme starter content into the customized state.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::prepare_starter_content_attachments()

Prepare starter content attachments.
wp-includes/theme.php: wp_update_custom_css_post()

Updates the custom_css post for a given theme.
wp-includes/theme.php: wp_get_custom_css_post()

Fetches the custom_css post for a given theme.
wp-includes/rest-api/endpoints/class-wp-rest-controller.php: WP_REST_Controller::sanitize_slug()

Sanitizes the slug value.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::insert_auto_draft_post()

Add a new auto-draft post.
wp-includes/class-wp-term-query.php: WP_Term_Query::get_terms()

Get terms, based on query_vars.
wp-includes/customize/class-wp-customize-nav-menu-setting.php: WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menus()

Filters the wp_get_nav_menus() result to ensure the inserted menu object is included, and the deleted one is removed.
wp-includes/customize/class-wp-customize-nav-menu-setting.php: WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menu_object()

Filters the wp_get_nav_menu_object() result to supply the previewed menu object.
wp-admin/includes/upgrade.php: wp_install_maybe_enable_pretty_permalinks()

Maybe enable pretty permalinks on installation.
wp-admin/includes/class-wp-plugins-list-table.php: WP_Plugins_List_Table::single_row()
wp-admin/includes/ms.php: sync_category_tag_slugs()

Synchronizes category and post tag slugs when global terms are enabled.
wp-admin/includes/update.php: update_nag()
wp-admin/includes/upgrade.php: make_site_theme()

Creates a site theme.
wp-admin/includes/upgrade.php: wp_install_defaults()

Creates the initial content for a newly-installed site.
wp-admin/includes/plugin.php: add_menu_page()

Add a top-level menu page.
wp-admin/includes/media.php: media_handle_upload()

Saves a file submitted from a POST request and create an attachment post for it.
wp-admin/includes/media.php: media_handle_sideload()

Handles a side-loaded file in the same way as an uploaded file is handled by media_handle_upload().
wp-admin/includes/post.php: get_sample_permalink()

Get a sample permalink based off of the post name.
wp-admin/includes/ajax-actions.php: _wp_ajax_add_hierarchical_term()

Ajax handler for adding a hierarchical term.
wp-admin/includes/ajax-actions.php: wp_ajax_add_link_category()

Ajax handler for adding a link category.
wp-admin/update-core.php: list_core_update()

Lists available core updates.
wp-includes/formatting.php: sanitize_title_for_query()

Sanitizes a title with the ‘query’ context.
wp-includes/deprecated.php: register_widget_control()

Registers widget control callback for customizing options.
wp-includes/deprecated.php: register_sidebar_widget()

Register widget for sidebar with backward compatibility.
wp-includes/category.php: get_category_by_path()

Retrieves a category based on URL containing the category slug.
wp-includes/taxonomy.php: wp_update_term()

Update term based on arguments provided.
wp-includes/taxonomy.php: wp_insert_term()

Add a new term to the database.
wp-includes/taxonomy.php: term_exists()

Determines whether a taxonomy term exists.
wp-includes/taxonomy.php: register_taxonomy()

Creates or modifies a taxonomy object.
wp-includes/link-template.php: permalink_anchor()

Displays the permalink anchor for the current post.
wp-includes/class-wp-admin-bar.php: WP_Admin_Bar::add_node()

Adds a node to the menu.
wp-includes/user.php: wp_insert_user()

Insert a user into the database.
wp-includes/post.php: wp_insert_post()

Insert or update a post.
wp-includes/widgets.php: dynamic_sidebar()

Display dynamic sidebar.
wp-includes/widgets.php: is_active_sidebar()

Determines whether a sidebar contains widgets.

Changelog

Version Description
1.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/sanitize_title