unregister_block_template() │ WP 6.7.0

Отменяет регистрацию блочного шаблона страницы добавленного через register_block_template().

Удаляет шаблон из реестра. Не удаляет шаблоны, добавленные темой или созданные пользователем.

Если шаблон не зарегистрирован, функция вызовет предупреждение о неправильном использовании и вернёт ошибку template_not_registered.

Используйте register_block_template(), когда нужно зарегистрировать блочный шаблон из плагина.

Работает на основе: WP_Block_Templates_Registry::unregister()

Хуков нет.

Возвращает

WP_Block_Template|WP_Error.

  • WP_Block_Template — объект удалённого из реестра шаблона.
  • WP_Error — если шаблон не зарегистрирован.

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

unregister_block_template( $template_name );
$template_name(string) (обязательный)

Имя шаблона в формате слаг-плагина//имя-шаблона.

Должно точно совпадать с именем, переданным в register_block_template().

Примеры

#1 Отмена регистрации шаблона другого плагина

Приоритет 20 позволяет выполнить код после обычной регистрации шаблонов на событии init с приоритетом 10.

add_action( 'init', 'my_plugin_unregister_book_template', 20 );

function my_plugin_unregister_book_template() {
	unregister_block_template( 'book-plugin//single-book' );
}

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

С версии 6.7.0 Введена.

Код unregister_block_template() WP 7.1

wp-includes/block-template.php 
function unregister_block_template( $template_name ) {
	return WP_Block_Templates_Registry::get_instance()->unregister( $template_name );
}

Редактор блоков (Gutenberg Гутенберг blocks)

FSE (block theme)