Action Hooks
Actions Hooks are intended for use when WordPress core or
some plugin or theme is giving you the opportunity to insert your code
at a certain point and do one or more of the following:
- Use
echo
to inject some HTML or other content into the response buffer, - Modify global variable state for one or more variables, and/or
- Modify the parameters passed to your hook function (assuming the hook was called by
do_action_ref_array()
instead ofdo_action()
since the latter does not support passing variables by-reference.)
Filter Hooks
Filter Hooks behave very similar to Action Hooks
but their intended use is to receive a value and potentially return a
modified version of the value. A filter hook could also be used just
like an Action Hook i.e. to modify a global variable or generate some
HTML, assuming that's what you need to do when the hook is called. One
thing that is very important about Filter Hooks that you don't need to
worry about with Action Hooks is that the person using a Filter Hook must return (a modified version of) the first parameter it was passed. A common newbie mistake is to forget to return that value!
Using Additional Parameters to Provide Context in Filter Hooks
As an aside I felt that Filter Hooks were hobbled in earlier
versions of WordPress because they would receive only one parameter;
i.e they would get a value to modify but no 2nd or 3rd parameters to
provide any context. Lately, and positively however, it seems the
WordPress core team has joyously (for me) been adding extra parameters
to Filter Hooks so that you can discover more context. A good example is
the
posts_where
hook; I believe a few versions back it only accepted one parameter being the current query's "where" class SQL but now it accepts both the where clause and a reference to current instance of the WP_Query
class that is invoking the hook.So what's the Real Difference?
In reality Filter Hooks are pretty much a superset of Action Hooks.
The former can do anything the latter can do and a bit more albeit the
developer doesn't have the responsibility to return a value with the
Action Hook that he or she does with the Filter Hook.
Giving Guidance and Telegraphing Intent
But that's probably not what is important. I think what is important
is that by a developer choosing to use an Action Hook vs. a Filter Hook
or vice versa they are telegraphing their intent and thus giving guidance to the themer or plugin developer who might be using the hook. In essence they are saying either "I'm going to call you, do whatever you need to do" OR "I've going to pass you this value to modify but be sure that you pass it back."
In Short, if you look at the
do_action()
core function, it's very similar to the apply_filters()
core function, with one very key difference: it does not return a value.
So what does this mean? actions are like filters, except an action
does not return a value, so you cannot modify data. It shows that it was
simple to create the WordPress' action mechanism by simply copying the
filter mechanism, and not returning a value. Basically, all you can do
with an action is simply execute a function without modifying some
value.
0 comments:
Post a Comment
Thanks for commenting. I will Reply you soon