flush_rewrite_rules( bool $hard = true )

Remove rewrite rules and then recreate rewrite rules.

Parameters

$hard

(bool) (Optional) Whether to update .htaccess (hard flush) or just update rewrite_rules option (soft flush). Default is true (hard).

Default value: true

More Information

This function is useful when used with custom post types as it allows for automatic flushing of the WordPress rewrite rules (usually needs to be done manually for new custom post types). However, this is an expensive operation so it should only be used when necessary.

Source

File: wp-includes/rewrite.php

function flush_rewrite_rules( $hard = true ) {
	global $wp_rewrite;

	if ( is_callable( array( $wp_rewrite, 'flush_rules' ) ) ) {
		$wp_rewrite->flush_rules( $hard );
	}
}

Uses

Uses	Description
wp-includes/class-wp-rewrite.php: WP_Rewrite::flush_rules()	Removes rewrite rules and then recreate rewrite rules.

Used By

Used By	Description
wp-admin/includes/misc.php: update_home_siteurl()	Flushes rewrite rules if siteurl, home or page_on_front changed.
wp-admin/includes/schema.php: populate_network()	Populate network settings.
wp-admin/includes/upgrade.php: wp_install()	Installs the site.
wp-includes/theme.php: check_theme_switched()	Checks if a theme has been changed and runs ‘after_switch_theme’ hook on the next WP load.

Changelog

Version	Description
3.0.0	Introduced.

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