remove_filter()

💡 云策文档标注

概述

remove_filter() 函数用于从指定的过滤器钩子中移除一个回调函数，常用于替换默认功能或动态调整钩子行为。移除时需确保回调函数和优先级与添加时匹配，否则可能失败且无警告。

关键要点

核心功能：从过滤器钩子中移除回调函数，支持无条件调用以尝试移除可能不存在的回调。
参数要求：$hook_name（钩子名称）和$callback（回调函数）为必需，$priority（优先级）可选，默认值为10，必须与添加时一致才能成功移除。
返回值：返回布尔值，表示函数在移除前是否存在。
应用场景：适用于移除默认过滤器（如wpautop）、批量移除多个钩子中的回调，或处理类中的过滤器移除。

代码示例

remove_filter( 'the_content', 'wpautop' );
foreach ( array( 'the_content', 'the_title', 'comment_text' ) as $hook )
    remove_filter( $hook, 'capital_P_dangit' );
global $my_class;
remove_filter( 'the_content', array($my_class, 'class_filter_function') );

注意事项

移除过滤器必须在添加之后进行，否则无法成功；优先级需精确匹配添加时的值。
对于类中的过滤器，需通过全局变量或实例访问类方法作为回调。
函数失败时不会产生警告，开发者需自行处理返回值以确认移除状态。

📄 原文内容

Removes a callback function from a filter hook.

Description

This can be used to remove default functions attached to a specific filter hook and possibly replace them with a substitute.

To remove a hook, the $callback and $priority arguments must match when the hook was added. This goes for both filters and actions. No warning will be given on removal failure.

Parameters

$hook_namestringrequired: The filter hook to which the function to be removed is hooked.
$callbackcallable|string|arrayrequired: The callback to be removed from running when the filter is applied.
This function can be called unconditionally to speculatively remove a callback that may or may not exist.
$priorityintoptional: The exact priority used when adding the original filter callback.

Default:10

Return

bool Whether the function existed before it was removed.

Source

function remove_filter( $hook_name, $callback, $priority = 10 ) {
	global $wp_filter;

	$r = false;

	if ( isset( $wp_filter[ $hook_name ] ) ) {
		$r = $wp_filter[ $hook_name ]->remove_filter( $hook_name, $callback, $priority );

		if ( ! $wp_filter[ $hook_name ]->callbacks ) {
			unset( $wp_filter[ $hook_name ] );
		}
	}

	return $r;
}

View all references View on Trac View on GitHub

Used by	Description
apply_block_hooks_to_content_from_post_object()`wp-includes/blocks.php`	Run the Block Hooks algorithm on a post object’s content.
insert_hooked_blocks_into_rest_response()`wp-includes/blocks.php`	Hooks into the REST API response for the Posts endpoint and adds the first and last inner blocks.
apply_block_hooks_to_content()`wp-includes/blocks.php`	Runs the hooked blocks algorithm on the given content.
wp_font_dir()`wp-includes/fonts.php`	Returns an array containing the current fonts upload directory’s path and URL.
WP_REST_Font_Faces_Controller::handle_font_file_upload()`wp-includes/rest-api/endpoints/class-wp-rest-font-faces-controller.php`	Handles the upload of a font file using wp_handle_upload() .
_wp_footnotes_remove_filters()`wp-includes/blocks.php`	Removes the filters for footnotes meta field.
_wp_get_iframed_editor_assets()`wp-includes/block-editor.php`	Collect the block editor assets that need to be loaded into the editor’s iframe.
WP_REST_Menu_Items_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php`	Prepares a single nav menu item output for response.
WP_REST_Global_Styles_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php`	Prepare a global styles config output for response.
_resolve_template_for_new_post()`wp-includes/block-template.php`	Sets the current WP_Query to return auto-draft posts.
wp_pre_kses_block_attributes()`wp-includes/formatting.php`	Removes non-allowable HTML from parsed block attribute values when filtering in the post context.
WP_REST_Post_Search_Handler::prepare_item()`wp-includes/rest-api/search/class-wp-rest-post-search-handler.php`	Prepares the search result for a given post ID.
do_blocks()`wp-includes/blocks.php`	Parses dynamic blocks out of `post_content` and re-renders them.
_restore_wpautop_hook()`wp-includes/blocks.php`	If do_blocks() needs to remove wpautop() from the `the_content` filter, this re-adds it afterwards, for subsequent `the_content` usage.
WP_Widget_Custom_HTML::widget()`wp-includes/widgets/class-wp-widget-custom-html.php`	Outputs the content for the current Custom HTML widget instance.
WP_Widget_Media_Video::render_media()`wp-includes/widgets/class-wp-widget-media-video.php`	Render the media on the frontend.
WP_Customize_Manager::save_changeset_post()`wp-includes/class-wp-customize-manager.php`	Saves the post for the loaded changeset.
WP_REST_Posts_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php`	Prepares a single post output for response.
WP_REST_Posts_Controller::get_items()`wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php`	Retrieves a collection of posts.
WP_REST_Comments_Controller::check_read_post_permission()`wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php`	Checks if the post can be read.
WP_Taxonomy::remove_hooks()`wp-includes/class-wp-taxonomy.php`	Removes the ajax callback for the meta box.
WP_Customize_Nav_Menus::insert_auto_draft_post()`wp-includes/class-wp-customize-nav-menus.php`	Adds a new `auto-draft` post.
_filter_query_attachment_filenames()`wp-includes/deprecated.php`	Filter the SQL clauses of an attachment query to include filenames.
unregister_meta_key()`wp-includes/meta.php`	Unregisters a meta key from the list of registered keys.
WP_Metadata_Lazyloader::reset_queue()`wp-includes/class-wp-metadata-lazyloader.php`	Resets lazy-load queue for a given object type.
WP_Customize_Widgets::render_widget_partial()`wp-includes/class-wp-customize-widgets.php`	Renders a specific widget using the supplied sidebar arguments.
wp_handle_comment_submission()`wp-includes/comment.php`	Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
WP_Customize_Nav_Menus::customize_register()`wp-includes/class-wp-customize-nav-menus.php`	Adds the customizer settings and controls.
wp_ajax_crop_image()`wp-admin/includes/ajax-actions.php`	Handles cropping an image via AJAX.
Language_Pack_Upgrader::bulk_upgrade()`wp-admin/includes/class-language-pack-upgrader.php`	Upgrades several language packs at once.
Plugin_Upgrader::bulk_upgrade()`wp-admin/includes/class-plugin-upgrader.php`	Upgrades several plugins at once.
Theme_Upgrader::check_parent_theme_filter()`wp-admin/includes/class-theme-upgrader.php`	Checks if a child theme is being installed and its parent also needs to be installed.
Theme_Upgrader::install()`wp-admin/includes/class-theme-upgrader.php`	Install a theme package.
Theme_Upgrader::upgrade()`wp-admin/includes/class-theme-upgrader.php`	Upgrades a theme.
Theme_Upgrader::bulk_upgrade()`wp-admin/includes/class-theme-upgrader.php`	Upgrades several themes at once.
Plugin_Upgrader::install()`wp-admin/includes/class-plugin-upgrader.php`	Install a plugin package.
Plugin_Upgrader::upgrade()`wp-admin/includes/class-plugin-upgrader.php`	Upgrades a plugin.
unregister_setting()`wp-includes/option.php`	Unregisters a setting.
wp_ajax_send_attachment_to_editor()`wp-admin/includes/ajax-actions.php`	Handles sending an attachment to the editor via AJAX.
wp_ajax_replyto_comment()`wp-admin/includes/ajax-actions.php`	Handles replying to a comment via AJAX.
wp_link_manager_disabled_message()`wp-admin/includes/bookmark.php`	Outputs the ‘disabled’ message for the WordPress Link Manager.
WP_Customize_Manager::stop_previewing_theme()`wp-includes/class-wp-customize-manager.php`	Stops previewing the selected theme.
wp_trim_excerpt()`wp-includes/formatting.php`	Generates an excerpt from the content, if needed.
kses_remove_filters()`wp-includes/kses.php`	Removes all KSES input form content filters.
_default_wp_die_handler()`wp-includes/functions.php`	Kills WordPress execution and displays HTML page with an error message.
WP_Widget_Text::widget()`wp-includes/widgets/class-wp-widget-text.php`	Outputs the content for the current Text widget instance.
WP_Widget_Text::form()`wp-includes/widgets/class-wp-widget-text.php`	Outputs the Text widget settings form.
do_shortcode()`wp-includes/shortcodes.php`	Searches content for shortcodes and filter shortcodes through their hooks.
remove_action()`wp-includes/plugin.php`	Removes a callback function from an action hook.
welcome_user_msg_filter()`wp-includes/ms-functions.php`	Ensures that the welcome message is not empty. Currently unused.
Walker_Comment::start_el()`wp-includes/class-walker-comment.php`	Starts the element output.
WP_Customize_Widgets::stop_capturing_option_updates()`wp-includes/class-wp-customize-widgets.php`	Undoes any changes to the options since options capture began.
wp_update_comment()`wp-includes/comment.php`	Updates an existing comment in the database.
_WP_Editors::editor()`wp-includes/class-wp-editor.php`	Outputs the HTML for a single instance of the editor.

Show 49 more Show less

Changelog

Version	Description
1.2.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex

11 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
Example
```
remove_filter( 'the_content', 'wpautop' );
```
```
foreach ( array( 'the_content', 'the_title', 'comment_text' ) as $hook )
    remove_filter( $hook, 'capital_P_dangit' );
```
If a filter has been added from within a class, for example by a plugin, removing it will require accessing the class variable.
```
global $my_class;
remove_filter( 'the_content', array($my_class, 'class_filter_function') );
```
It is also worth noting that you may need to prioritise the removal of the filter to a hook that occurs after the filter is added. You cannot successfully remove the filter before it has been added.
Log in to add feedback

云策 WordPress 开发者社区

函数文档

remove_filter()

概述

关键要点

代码示例

注意事项

Description

Parameters

Return

Source

Changelog

User Contributed Notes

函数文档

概述

关键要点

代码示例

注意事项

Description

Parameters

Return

Source

Related

Changelog

User Contributed Notes