add_action( string $tag, callable $function_to_add, int $priority = 10, int $accepted_args = 1 )

Hooks a function on to a specific action.


Description

Actions are the hooks that the ClassicPress core launches at specific points during execution, or when specific events occur. Plugins can specify that one or more of its PHP functions are executed at these points, using the Action API.


Parameters

$tag

(string) (Required) The name of the action to which the $function_to_add is hooked.

$function_to_add

(callable) (Required) The name of the function you wish to be called.

$priority

(int) (Optional) Used to specify the order in which the functions associated with a particular action are executed. Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action.

Default value: 10

$accepted_args

(int) (Optional) The number of arguments the function accepts.

Default value: 1


Return

(true) Will always return true.


Source

File: wp-includes/plugin.php

function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
	return add_filter($tag, $function_to_add, $priority, $accepted_args);
}


Changelog

Changelog
Version Description
WP-1.2.0 Introduced.