remove_filter( string $tag, callable $function_to_remove, int $priority = 10 )

Removes a function from a specified filter hook.

Contents

Description Description

This function removes a function attached to a specified filter hook. This method 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 $function_to_remove 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 Parameters

$tag

(string) (Required) The filter hook to which the function to be removed is hooked.

$function_to_remove

(callable) (Required) The name of the function which should be removed.

$priority

(int) (Optional) The priority of the function.

Default value: 10

Top ↑

Return Return

(bool) Whether the function existed before it was removed.

Top ↑

Source Source

File: wp-includes/plugin.php 

function remove_filter( $tag, $function_to_remove, $priority = 10 ) {
	global $wp_filter;

	$r = false;
	if ( isset( $wp_filter[ $tag ] ) ) {
		$r = $wp_filter[ $tag ]->remove_filter( $tag, $function_to_remove, $priority );
		if ( ! $wp_filter[ $tag ]->callbacks ) {
			unset( $wp_filter[ $tag ] );
		}
	}

	return $r;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
1.2.0 Introduced.

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/formatting.php: wp_remove_targeted_link_rel_filters()

Removes all filters modifying the rel attribute of targeted links.
wp-includes/rest-api/search/class-wp-rest-post-search-handler.php: WP_REST_Post_Search_Handler::prepare_item()

Prepares the search result for a given ID.
wp-includes/blocks.php: do_blocks()

Parses dynamic blocks out of post_content and re-renders them.
wp-includes/blocks.php: _restore_wpautop_hook()

If do_blocks() needs to remove wpautop() from the the_content filter, this re-adds it afterwards, for subsequent the_content usage.
wp-includes/widgets/class-wp-widget-custom-html.php: WP_Widget_Custom_HTML::widget()

Outputs the content for the current Custom HTML widget instance.
wp-includes/widgets/class-wp-widget-media-video.php: WP_Widget_Media_Video::render_media()

Render the media on the frontend.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::save_changeset_post()

Save the post for the loaded changeset.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_response()

Prepares a single post output for response.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::get_items()

Retrieves a collection of posts.
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php: WP_REST_Comments_Controller::check_read_post_permission()

Checks if the post can be read.
wp-includes/class-wp-taxonomy.php: WP_Taxonomy::remove_hooks()

Removes the ajax callback for the meta box.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::insert_auto_draft_post()

Add a new auto-draft post.
wp-includes/post.php: _filter_query_attachment_filenames()

Filter the SQL clauses of an attachment query to include filenames.
wp-includes/meta.php: unregister_meta_key()

Unregisters a meta key from the list of registered keys.
wp-includes/class-wp-metadata-lazyloader.php: WP_Metadata_Lazyloader::reset_queue()

Resets lazy-load queue for a given object type.
wp-includes/class-wp-customize-widgets.php: WP_Customize_Widgets::render_widget_partial()

Renders a specific widget using the supplied sidebar arguments.
wp-includes/comment.php: wp_handle_comment_submission()

Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::customize_register()

Add the customizer settings and controls.
wp-admin/includes/ajax-actions.php: wp_ajax_crop_image()

Ajax handler for cropping an image.
wp-admin/includes/class-language-pack-upgrader.php: Language_Pack_Upgrader::bulk_upgrade()

Bulk upgrade language packs.
wp-admin/includes/class-theme-upgrader.php: Theme_Upgrader::check_parent_theme_filter()

Check if a child theme is being installed and we need to install its parent.
wp-admin/includes/class-theme-upgrader.php: Theme_Upgrader::install()

Install a theme package.
wp-admin/includes/class-theme-upgrader.php: Theme_Upgrader::upgrade()

Upgrade a theme.
wp-admin/includes/class-theme-upgrader.php: Theme_Upgrader::bulk_upgrade()

Upgrade several themes at once.
wp-admin/includes/class-plugin-upgrader.php: Plugin_Upgrader::bulk_upgrade()

Bulk upgrade several plugins at once.
wp-admin/includes/class-plugin-upgrader.php: Plugin_Upgrader::install()

Install a plugin package.
wp-admin/includes/class-plugin-upgrader.php: Plugin_Upgrader::upgrade()

Upgrade a plugin.
wp-includes/option.php: unregister_setting()

Unregister a setting.
wp-admin/includes/ajax-actions.php: wp_ajax_send_attachment_to_editor()

Ajax handler for sending an attachment to the editor.
wp-admin/includes/ajax-actions.php: wp_ajax_replyto_comment()

Ajax handler for replying to a comment.
wp-admin/includes/bookmark.php: wp_link_manager_disabled_message()

Outputs the ‘disabled’ message for the WordPress Link Manager.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::stop_previewing_theme()

Stop previewing the selected theme.
wp-includes/kses.php: kses_remove_filters()

Removes all KSES input form content filters.
wp-includes/widgets/class-wp-widget-text.php: WP_Widget_Text::widget()

Outputs the content for the current Text widget instance.
wp-includes/widgets/class-wp-widget-text.php: WP_Widget_Text::form()

Outputs the Text widget settings form.
wp-includes/plugin.php: remove_action()

Removes a function from a specified action hook.
wp-includes/ms-functions.php: welcome_user_msg_filter()

Ensure that the welcome message is not empty. Currently unused.
wp-includes/class-wp-customize-widgets.php: WP_Customize_Widgets::stop_capturing_option_updates()

Undoes any changes to the options since options capture began.
wp-includes/class-wp-editor.php: _WP_Editors::editor()

Outputs the HTML for a single instance of the editor.
Show 34 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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.

You must log in before being able to contribute a note or feedback.