remove_action() WordPress Function

The remove_action() function is used to remove an action that has been added with the add_action() function. This function can be used to remove both built-in WordPress actions and actions that have been added by a plugin or theme.

remove_action( string $hook_name, callable|string|array $callback, int $priority = 10 ) #

Removes a callback function from an action hook.


Description

This can be used to remove default functions attached to a specific action 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.


Top ↑

Parameters

$hook_name

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

$callback

(callable|string|array)(Required)The name of the function which should be removed. This function can be called unconditionally to speculatively remove a callback that may or may not exist.

$priority

(int)(Optional) The exact priority used when adding the original action callback.

Default value: 10


Top ↑

Return

(bool) Whether the function is removed.


Top ↑

More Information

  • This function is an alias to remove_filter().
  • See also add_action() and add_filter().
  • 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.

Top ↑

Source

File: wp-includes/plugin.php

function remove_action( $hook_name, $callback, $priority = 10 ) {
	return remove_filter( $hook_name, $callback, $priority );
}


Top ↑

Changelog

Changelog
VersionDescription
1.2.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.