WP_Rewrite::flush_rules( bool $hard = true )

Description

Parameters

$hardbooloptional

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

Hooks fired · 1

One hook fires while WP_Rewrite::flush_rules() runs, in this order:

1. 1
   apply_filters( flush_rewrite_rules_hard )filterline 1899 (+26 into the body)

   Filters whether a "hard" rewrite rule flush should be performed when requested.

Uses · 6

• did_action()Retrieves the number of times an action has been fired during the current request.
• add_action()Adds a callback function to an action hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• save_mod_rewrite_rules()Updates the htaccess file with the current rules if it is writable.
• iis7_save_url_rewrite_rules()Updates the IIS web.config file with the current rules if it is writable.
• WP_Rewrite::refresh_rewrite_rules()Refreshes the rewrite rules, saving the fresh value to the database.

Source

View on Trac ↗View on GitHub ↗

1873	public function flush_rules( $hard = true ) {1874		static $do_hard_later = null;1875 1876		// Prevent this action from running before everyone has registered their rewrites.1877		if ( ! did_action( 'wp_loaded' ) ) {1878			add_action( 'wp_loaded', array( $this, 'flush_rules' ) );1879			$do_hard_later = ( isset( $do_hard_later ) ) ? $do_hard_later || $hard : $hard;1880			return;1881		}1882 1883		if ( isset( $do_hard_later ) ) {1884			$hard = $do_hard_later;1885			unset( $do_hard_later );1886		}1887 1888		$this->refresh_rewrite_rules();1889 1890		/**1891		 * Filters whether a "hard" rewrite rule flush should be performed when requested.1892		 *1893		 * A "hard" flush updates .htaccess (Apache) or web.config (IIS).1894		 *1895		 * @since 3.7.01896		 *1897		 * @param bool $hard Whether to flush rewrite rules "hard". Default true.1898		 */1899		if ( ! $hard || ! apply_filters( 'flush_rewrite_rules_hard', true ) ) {1900			return;1901		}1902		if ( function_exists( 'save_mod_rewrite_rules' ) ) {1903			save_mod_rewrite_rules();1904		}1905		if ( function_exists( 'iis7_save_url_rewrite_rules' ) ) {1906			iis7_save_url_rewrite_rules();1907		}1908	}

History

Introduced in 2.0.1. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-rewrite.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.