WP_Rewrite::flush_rules() WP 2.0.1

Обновляет правила перезаписи ссылок (ЧПУ) в базе данных и кэше.

Нужно использовать после добавления новых правил перезаписи УРЛов, чтобы новые правила вступили в силу, иначе новые правила перезаписи работать не будут. Новые правила добавляются функцией add_rewrite_rule().

Не надо использовать функцию каждый раз при загрузке страницы. Не вешайте функцию на хуки, который вызывается при загрузке страницы, типа: init. flush_rules() достаточно требовательна к ресурсам, поэтому, её нужно использовать одноразово, например, во время активации/деактивации плагина/темы.

Возвращает

Функция ничего не возвращает.

Использование

$wp_rewrite->flush_rules();

Шаблон использования

$GLOBALS['wp_rewrite']->flush_rules();

Примеры

#1. Пример обновления правил перезаписи УРЛов:

// Убедимся, что переменная $wp_rewrite определена глобально
global $wp_rewrite;
$wp_rewrite->flush_rules();

#2. Пример обновления правил перезаписи с использованием функции flush_rewrite_rules(), во время активации плагина:

register_activation_hook( __FILE__, 'author_base_rewrite' );
function author_base_rewrite(){
	flush_rewrite_rules( false );
}

flush_rewrite_rules( false ) - false указывает, что не нужно обновлять файл .htaccess, если не указать false, то файл .htaccess будет обновлен в соответствии с правилами.

Заметки

WordPress сохраняет все правила перезаписи в кэше. Иногда плагины, темы или функции могут добавить свои, новые правила перезаписи и WordPress ничего не будет знать об этих новых правилах, до тех пор, пока все правила не будут перезаписаны (обновлены).

Это не обычная функция, а метод класса WP_Rewrite, поэтому при вызове этого метода, нужно убедится что переменная $wp_rewrite, содержащая в себе экземпляр класса WP_Rewrite, определена глобально. Вызывать метод нужно по правилам классов: $wp_rewrite->flush_rules();.

Заметки

• Static. true/false. $do_hard_later

Список изменений

Код WP Rewrite::flush rules: wp-includes/class-wp-rewrite.php ^{WP 5.4.2}

<?php
public function flush_rules( $hard = true ) {
	static $do_hard_later = null;

	// Prevent this action from running before everyone has registered their rewrites.
	if ( ! did_action( 'wp_loaded' ) ) {
		add_action( 'wp_loaded', array( $this, 'flush_rules' ) );
		$do_hard_later = ( isset( $do_hard_later ) ) ? $do_hard_later || $hard : $hard;
		return;
	}

	if ( isset( $do_hard_later ) ) {
		$hard = $do_hard_later;
		unset( $do_hard_later );
	}

	update_option( 'rewrite_rules', '' );
	$this->wp_rewrite_rules();

	/**
	 * Filters whether a "hard" rewrite rule flush should be performed when requested.
	 *
	 * A "hard" flush updates .htaccess (Apache) or web.config (IIS).
	 *
	 * @since 3.7.0
	 *
	 * @param bool $hard Whether to flush rewrite rules "hard". Default true.
	 */
	if ( ! $hard || ! apply_filters( 'flush_rewrite_rules_hard', true ) ) {
		return;
	}
	if ( function_exists( 'save_mod_rewrite_rules' ) ) {
		save_mod_rewrite_rules();
	}
	if ( function_exists( 'iis7_save_url_rewrite_rules' ) ) {
		iis7_save_url_rewrite_rules();
	}
}

Cвязанные функции

Из метки: Rewrite (ЧПУ перезапись)