Introdução a Hooks - Aprenda a customizar o WordPress com filtros e ações

Introdução a Hooks
Aprenda a customizar o WordPress
com filtros e ações
Thiago Censi

thiago censi • introdução a hooks wordcamp sp 2016
Thiago Censi
• facebook.com/tacensi
• github.com/tacensi
• br.wordpress.org/support/users/frq/
• tacensi@gmail.com

O que são Hooks?
Tradução: Gancho
Hook: a piece of metal or other material, curved or bent
back at an angle, for catching hold of or hanging
things on.
To hook: attach or fasten with a hook or hooks.

Hooks no WordPress
Servem para pendurar, prender, anexar ações individuais para
alterar ou acrescentar conteúdo ou funcionalidades ao WP
Dois tipos: Actions e Filters
Tl;dr: Actions fazem alguma coisa. Filters modificam
alguma coisa.

Exemplos no core: action
// wp_includes/general_template.php:2200
function wp_head() {
/**
* Prints scripts or data in the head tag on the front end.
*
* @since 1.5.0
*/
do_action( 'wp_head' );
}

Exemplos no core: filter
// wp_includes/post_template.php:220
function the_content( $more_link_text = null, $strip_teaser =
false) {
$content = get_the_content( $more_link_text, $strip_teaser
);
/**
* Filters the post content.
* @since 0.71
* @param string $content Content of the current post.
*/
$content = apply_filters( 'the_content', $content );
$content = str_replace( ']]>', ']]>', $content );
echo $content;
}

Por quê!?
• API usada por plugins e temas para interação com WP (plugin API);
• Mude o comportamento do WP sem mexer em arquivos do core;
• Altere temas filho sem alterar os arquivos do tema. Ex: temas
que usam frameworks;
• Altere o comportamento de plugins sem mexer em seus arquivos;
• Separe os hooks em plugins para modulação e fácil
ativação/desativação;
• Mantenha WP/tema/plugins funcionando com updates;
• O jeito WordPress (the WP way)

Adicionando hooks
// action
add_action( 'tag', 'function', 'priority', 'parameters' );
// filter
add_filter( ‘tag’, ‘function’, ‘priority’, ‘parameters’ );

Partes de um hooks: tag
// action
// filter
add_filter( 'tag', 'function', 'priority', 'parameters' );
Nome do hook, onde/quando a função de callback será chamada.

Partes de um hook: tag (filter)
// wp_includes/post_template.php:220
function the_content( $more_link_text = null, $strip_teaser =
false) {
$content = get_the_content( $more_link_text, $strip_teaser
);
/**
* Filters the post content.
* @since 0.71
* @param string $content Content of the current post.
*/
$content = apply_filters( 'the_content', $content );
$content = str_replace( ']]>', ']]>', $content );
echo $content;
}

Partes de um hook: tag (filter)
// Não devemos nomear o lorde das trevas
add_filter( 'the_content', function( $content ) {
return str_replace( 'Voldemort', 'Aquele-Que-Não-Deve-Ser-
Nomeado',
$content );
}, 30 );

Partes de um hook: tag (action)
function wp_head() {
/**
* Prints scripts or data in the head tag on the front end.
*
* @since 1.5.0
*/
do_action( 'wp_head' );
}

Partes de um hook: tag (action)
add_action( 'wp_head', function(){
echo 'OpenGraph Tags...';
}, 10 );

Partes de um hooks: função de callback
// action
// filter
Nome da sua função

Partes de um hook: function (action)
add_action( 'wp_head', 'tacensi_add_og_meta', 10 );
function tacensi_add_og_meta(){
echo 'OpenGraph Tags...';
}

Partes de um hook: function (filter)
// Não devemos nomear o lorde das trevas
add_filter( 'the_content', 'tacensi_never_say_his_name', 30 );
function tacensi_never_say_his_name( $content ) {
return str_replace(
'Voldemort',
'Aquele-Que-Não-Deve-Ser-Nomeado',
$content
);
}

Partes de um hooks: prioridade de execução
// action
// filter
Ordem de execução de todas as funções penduradas naquele
hook. São executadas em ordem crescente (10, 20, 30, etc...).

Partes de um hook: priority (action)
// wp_includes/default_filters.php:205
add_action( 'wp_head', '_wp_render_title_tag', 1 );
add_action( 'wp_head', 'wp_enqueue_scripts', 1 );
add_action( 'wp_head', 'feed_links', 2 );
add_action( 'wp_head', 'feed_links_extra', 3 );
add_action( 'wp_head', 'rsd_link' );
add_action( 'wp_head', 'wlwmanifest_link' );

Partes de um hook: priority (filter)
add_filter( 'comment_text', 'wptexturize' );
add_filter( 'comment_text', 'convert_chars' );
add_filter( 'comment_text', 'make_clickable', 9 );
add_filter( 'comment_text', 'force_balance_tags', 25 );
add_filter( 'comment_text', 'convert_smilies', 20 );
add_filter( 'comment_text', 'wpautop', 30 );
/**
Deve-se tomar mais cuidado com a prioridade nos filtros, já que
um alteração pode interferir em outra.
**/

Partes de um hooks: Número de parâmetros
// action
// filter
Quantos parâmetros a função aceita. Se não há uma
documentação devemos cavar no fonte.

Partes de um hook: parameters (action)
add_action( 'post_updated',
'wp_check_for_changed_slugs', 12, 3 );
// wp-includes/post.php:5286
/**
* @param int $post_id Post ID.
* @param WP_Post $post The Post Object
* @param WP_Post $post_before The Previous Post Object
* @return int Same as $post_id
*/
function wp_check_for_changed_slugs(
$post_id, $post, $post_before ) {
// (...)
}

Partes de um hook: parameters (filter)
// wp_includes/formatting.php:1311
add_action( 'sanitize_title',
'sanitize_title_with_dashes', 10, 3 );
// wp-includes/post.php:5286
/**
* @param string $title The title to be sanitized.
* @param string $raw_title Optional. Not used.
* @param string $context Optional. The operation for which the
string is sanitized.
* @return string The sanitized title.
*/
function sanitize_title_with_dashes(
$title, $raw_title = '', $post_before ) {
// (...)
}

Removendo actions ou filters
// action
remove_action( $tag, $function_to_remove, $priority );
remove_all_actions( $tag, $priority );
// filter
remove_filter( $tag, $function_to_remove, $priority );
remove_all_filters( $tag, $priority );
Podemos remover um ou todos os hooks de determinado
filtro ou ação

Removendo actions
// remove update warning
function tacensi_remove_update_warning() {
if ( ! current_user_can( 'activate_plugins' ) )
remove_action( 'admin_notices', 'update_nag', 3 );
}
add_action(
'admin_notices',
'tacensi_remove_update_warning',
1
);

Exemplos: remove_action
// remove header info
function tacensi_remove_header_info() {
remove_action( 'wp_head', 'rsd_link' );
remove_action( 'wp_head', 'wlwmanifest_link' );
remove_action( 'wp_head', 'wp_generator' );
remove_action( 'wp_head', 'start_post_rel_link' );
remove_action( 'wp_head', 'index_rel_link' );
remove_action( 'wp_head', 'adjacent_posts_rel_link' );
}
add_action( 'init', 'tacensi_remove_header_info' );

Exemplos: add_action
// add promo banner
add_action(
'woocommerce_before_shop_loop',
'tacensi_add_promo'
);
function tacensi_add_promo() {
?>
<div class="banner-promo">
<h2>O patrão está maluco!</h2>
<p>Somente hoje, tudo pela metade do dobro!</p>
</div>
<?php
}

Exemplos: add_filter
// change 0800 text
add_filter(
'woocommerce_free_price_html',
'tacensi_free_price'
);
function tacensi_free_price( $price ) {
$price = '<span class="amount">' .
__( 'Totalmente de GRÁTIS!', 'tacensi' ) .
'</span>';
return $price;
}

// change 2017 home sections
add_filter(
'twentyseventeen_front_page_sections',
function(){
return 5;
}
);

// 2016 credits
add_action( 'twentysixteen_credits', 'tacensi_copyright' );
function tacensi_copyright() {
echo '<p>© Copyright ' . date( 'Y' ) . ' Acme Inc.</p>';
}

Mais informações
Codex: codex.wordpress.org/Plugin_API
Hook data: adambrown.info/p/wp_hooks
Woo: docs.woocommerce.com/document/
introduction-to-hooks-actions-and-filters/
Mais: Leitura e análise do core ;-)

Obrigado.

Introdução a Hooks - Aprenda a customizar o WordPress com filtros e ações

Mais conteúdo relacionado

Destaque (9)

Semelhante a Introdução a Hooks - Aprenda a customizar o WordPress com filtros e ações (20)

Introdução a Hooks - Aprenda a customizar o WordPress com filtros e ações