Demystifying Hooks, Actions & Filters - WordCamp Belfast 2018

Demystifying Hooks,
Actions & Filters
A quick run through by Damien Carbery

Actions and filters are the means to extend WordPress. Without them
WordPress could not be extended and there would not be any plugins.
Look for do_action() and apply_filters() function calls.
They are everywhere

Did you know that WordPress uses actions and filters
internally?
In WordPress 4.9.5 I found 867 do_action() calls and
1743 apply_filters() calls.
Dogfooding

What are they?
They are everywhere but what are they?
➔ Actions - do_action()
Run your code at a certain point. Don't
return any data.
➔ Filters - apply_filters()
Modify data at a certain point. Return
some data.

Actions are like a music festival
The available actions are like the acts at a music festival. If you want to see an act you
must put your name down for it. You may also say what position in the queue you'd
like to be.
When an act is coming on you'll be called. You will be called in the queue position you
specified.
You can use this time to get ready e.g. put on a t-shirt with the band on it. When
you're ready you say so.
add_action( 'band_name', 'my_name', $position );

Core actions - a summary
The Codex Action Reference page list 50 actions that are
run during a typical page request - you might recognise
names like 'plugins_loaded', 'after_setup_theme', 'init',
'pre_get_posts' or 'wp_head'
Tip
"WordPress Action
Reference" is at:
https://codex.wordpres
s.org/Plugin_API/Action
_Reference

Everything in its own time
Actions are all times where code (internal or in a plugin or a
theme) can be run. Plugins and themes can add their own
actions.
For example: Plugins are loaded alphabetically so plugin
"AAA" will have to wait until the 'plugins_loaded' action to
use functions in plugin 'ZZZ'.

do_action( 'action_name' );
WordPress calls functions that have added themselves to
this action with code like:
add_action('action_name','my_function',10);
function my_function() {
echo '';
}
Tip
The third parameter is
the priority. The default
is 10. You can omit it or
set it to any positive
number.

The 'wp_head' action is used internally and by themes and plugins.
wp_head() is most frequently seen in a theme's header.php. It simply calls:
do_action( 'wp_head' );
In wp-includes/default-filters.php 23 functions are set to run at this point e.g.
add_action( 'wp_head', 'wp_generator' );
This produces the meta tag with the WordPress version:
<meta name="generator" content="WordPress 4.9.5" />
do_action() example

do_action() to add content
You can use a do_action() to run code to inject content, or set up more
add_action() calls or remove some code that is due to run later.
Let's add a meta tag with our name:
add_action('wp_head','my_meta_name');
function my_meta_name() { ?>
<meta name="author" content="Damien Carbery" />
<?php }

do_action() to remove code
Let's remove the "generator" meta tag that was added with:
add_action( 'wp_head', 'wp_generator' );
Note the priority that it is set to run before the code is run.
add_action('wp_head','remove_generator', 9);
function remove_generator() {
remove_action( 'wp_head', 'wp_generator' );
}

do_action() for more add_action()
Maybe move stuff around - we must make the change after it is added but before
it is executed. In WooCommerce lets move the price to be above the product
title.
In the WooCommerce template file that displays a single product it has a number
of do_action() calls. The file includes comments listing the internal
WooCommerce functions attached each action. It also lists the position number
that was used in the add_action() call - you need this for a remove_action() call.

do_action( 'woocommerce_before_single_product' );
do_action( 'woocommerce_before_single_product_summary' );
// @hooked woocommerce_template_single_title - 5
// @hooked woocommerce_template_single_price - 10
do_action( 'woocommerce_single_product_summary' );
To move the price above the title I need to run my code before the price and title
functions are run. I am going to run during the
'woocommerce_before_single_product' action.

add_action('woocommerce_before_single_product', 'mover' );
function mover() {
remove_action( 'woocommerce_single_product_summary',
'woocommerce_template_single_price', 10 );
add_action( 'woocommerce_single_product_summary',
'woocommerce_template_single_price', 4 );
}
The price position was 10. Title was 5 so we used 4 to display before it.

Filters are like "Pass The Parcel"
When a filter is run it's like passing the parcel (data) around and then back to the start
position.
You can change the parcel (data) if you want - e.g. tear off a layer, or add another
layer or put in a totally new parcel. Whatever you do you must pass a parcel (data)
back.
You can also do other things like get ready for that forthcoming music act.
You may be given extra relevant info when you get the parcel e.g. a boy wrapped it.
add_filter('place_in_game','my_name',$position,$num_args );

add_filter() to add content
'the_content' is a filter that runs when the_content() function is called.
Let's use it to append some copyright info to the page.
add_filter('the_content','append_copyright');
function append_copyright( $content ) {
return $content . '<p>Copyright Me 2018</p>';
}

add_filter() to change content
In WooCommerce let's not show whether a product is in stock. The called
function receives 2 parameters - the html that will be shown and a copy of the
product object - maybe you'll only show info for some products.
add_filter('woocommerce_get_stock_html','noinfo',10,2);
function noinfo( $html, $product ) {
if ( $product->is_on_sale() ) return '';
return $html;
}

add_filter() while debugging
You don't have to change the passed data. You may use the opportunity to look
at other data while debugging.
add_filter('the_content','content_debug');
function content_debug( $content ) {
error_log( 'Content: ' . $content );
error_log( 'URL: ' . $_SERVER['REQUEST_URI'] );
return $content;
}

Where does this code go?
New users are often told to put snippets of code in the theme's functions.php file.
Make sure you are using a child theme otherwise you'll lose the code when the
(parent) theme is updated.

Functional plugin
You could put snippets into a plugin and activate it. Create a file in
wp-content/plugins and give it a header comment like:
<?php
/*
Plugin Name: My Functional Plugin
Plugin URI: https://www.damiencarbery.com
Description: A place for my code snippets.
Author: Damien Carbery
Version: 0.1
*/

Be Fearless!
Don't be intimidated by actions or filters.
➔ Actions
Get in line for the gig
➔ Filters
Pass the parcel
➔ Functional plugin
A safe way to add code.
Damien Carbery
https://www.damiencarbery.com
@DaymoBrew

Demystifying Hooks, Actions & Filters - WordCamp Belfast 2018

More Related Content

What's hot (20)

Similar to Demystifying Hooks, Actions & Filters - WordCamp Belfast 2018 (20)

Recently uploaded (20)

Demystifying Hooks, Actions & Filters - WordCamp Belfast 2018