{"id":37457,"date":"2020-06-01T00:29:01","date_gmt":"2020-06-01T07:29:01","guid":{"rendered":"https:\/\/kinsta.com\/?p=72202"},"modified":"2023-08-22T04:46:21","modified_gmt":"2023-08-22T07:46:21","slug":"hooks-wordpress","status":"publish","type":"post","link":"https:\/\/kinsta.com\/pt\/blog\/hooks-wordpress\/","title":{"rendered":"Hooks Bootcamp WordPress: Como Utilizar as A\u00e7\u00f5es, Filtros e Hooks Personalizados"},"content":{"rendered":"

Os Hooks do WordPress s\u00e3o uma das ferramentas mais importantes a ter no arsenal de um desenvolvedor de WordPress<\/a>. Eles s\u00e3o a base do plugin WordPress e do desenvolvimento de temas. Voc\u00ea pode usar os muitos hooks embutidos do WordPress para “enganchar” o WordPress Core com seu c\u00f3digo personalizado e fazer<\/strong> ou modificar<\/strong> algo.<\/p>\n

Existem dois tipos de hooks para WordPress: A\u00e7\u00f5es<\/strong> e Filtros<\/strong>. Os hooks s\u00e3o t\u00e3o comuns que at\u00e9 mesmo o WordPress Core os utiliza extensivamente. O WordPress tamb\u00e9m inclui uma forma de voc\u00ea definir seus pr\u00f3prios hooks personalizados<\/strong> para que outros desenvolvedores possam se conectar ao seu c\u00f3digo.<\/p>\n

Aprender como funcionam as a\u00e7\u00f5es, filtros e hooks personalizados \u00e9 essencial para dominar o desenvolvimento do WordPress.<\/p>\n

A primeira metade deste artigo cobre os princ\u00edpios b\u00e1sicos dos hooks do WordPress e explica como eles funcionam com v\u00e1rios exemplos. Na segunda metade, voc\u00ea aprender\u00e1 como usar os hooks para personalizar o WordPress, criar seus pr\u00f3prios hooks personalizados e us\u00e1-los para construir seus pr\u00f3prios plugins extens\u00edveis.<\/p>\n

Parece excitante? Vamos mergulhar!<\/p>\n

<\/div><\/kinsta-auto-toc>\n

O que s\u00e3o hooks WordPress?<\/h2>\n

Uma p\u00e1gina WordPress <\/a>\u00e9 montada por toneladas de fun\u00e7\u00f5es e consultas a banco de dados. O WordPress Core, plugins e tema trabalham em conjunto para produzir os elementos da p\u00e1gina como texto, imagens<\/a>, scripts e estilos. Uma vez totalmente montado, o navegador ent\u00e3o os coloca todos juntos e renderiza a p\u00e1gina.<\/p>\n

Os hooks do WordPress permitem que voc\u00ea ‘entre’ neste processo de compila\u00e7\u00e3o em certos pontos e execute seu c\u00f3digo personalizado. A principal fun\u00e7\u00e3o dos hooks \u00e9 permitir que voc\u00ea modifique ou adicione recursos ao WordPress sem tocar nos arquivos principais<\/a>.<\/p>\n

\"Os
Os hooks v\u00e3o ajud\u00e1-lo a estender o WordPress com seu pr\u00f3prio c\u00f3digo<\/figcaption><\/figure>\n

A Plugin API do WordPress<\/a> potencializa a funcionalidade dos hooks do WordPress. Voc\u00ea usa hooks chamando certas fun\u00e7\u00f5es do WordPress chamadas Hook Functions<\/strong> em inst\u00e2ncias espec\u00edficas durante o tempo de execu\u00e7\u00e3o do WordPress.<\/p>\n

Usando fun\u00e7\u00f5es hooks, voc\u00ea pode agrupar seu c\u00f3digo personalizado dentro de uma fun\u00e7\u00e3o de Callback<\/strong> e t\u00ea-lo registrado com qualquer hooks. Uma vez registrado, este callback ser\u00e1 executado onde quer que os hooks estejam, permitindo que voc\u00ea aumente ou substitua os recursos padr\u00e3o do WordPress.<\/p>\n

A posi\u00e7\u00e3o dos hooks no processo de execu\u00e7\u00e3o do c\u00f3digo \u00e9 um fator importante. Voc\u00ea aprender\u00e1 mais sobre sua import\u00e2ncia nas pr\u00f3ximas se\u00e7\u00f5es.<\/p>\n\n

Dois tipos de hooks para WordPress: A\u00e7\u00f5es e Filtros<\/h3>\n

O WordPress inclui dois tipos de hooks chamados Actions<\/strong> e Filters<\/strong>. As Actions permitem que voc\u00ea fa\u00e7a<\/strong> algo em certos pontos pr\u00e9-definidos no tempo de execu\u00e7\u00e3o do WordPress, enquanto os Filters permitem que voc\u00ea modifique<\/strong> qualquer dado processado pelo WordPress e o\u00a0return<\/code><\/strong>.<\/strong><\/p>\n

As a\u00e7\u00f5es s\u00e3o definidas no c\u00f3digo do WordPress como:<\/p>\n

do_action( 'action_name', [optional_arguments] );<\/code><\/pre>\n
A string action_name<\/strong><\/code> \u00e9 o nome da action. Voc\u00ea pode especificar a vari\u00e1vel [optional_arguments]<\/strong><\/code> para passar argumentos adicionais para a fun\u00e7\u00e3o callback. Se este campo n\u00e3o for especificado, ent\u00e3o seu valor padr\u00e3o estar\u00e1 vazio.<\/p>\n
Exemplo: <\/strong>A a\u00e7\u00e3o do_action( 'wp_head' )<\/strong><\/code> pode ser ligada para executar c\u00f3digo personalizado toda vez que o WordPress processa o cabe\u00e7alho do site<\/a>. Esta a\u00e7\u00e3o n\u00e3o tem nenhum outro argumento.<\/p>\n
Os filtros s\u00e3o definidos no c\u00f3digo do WordPress como:<\/p>\n
apply_filters( 'filter_name', 'value_to_be_filtered', [optional_arguments] );<\/code><\/pre>\n
A string filter_name<\/strong><\/code> \u00e9 o nome do filtro, a vari\u00e1vel value_to_be_filtered<\/strong><\/code> \u00e9 o valor que precisa ser filtrado e retornado, e a vari\u00e1vel [optional_arguments]<\/strong><\/code> pode passar argumentos adicionais, assim como com a\u00e7\u00f5es.<\/p>\n
Exemplo: <\/strong>O filtro apply_filters( 'admin_footer_text' , string $text )<\/strong><\/code> pode ser ligado para modificar o texto exibido no rodap\u00e9 do administrador. A partir do WordPress 5.4, seu valor padr\u00e3o exibir\u00e1 a frase Thank you for creating with\u00a0<\/em>WordPress<\/em><\/a>.<\/em><\/code> no rodap\u00e9 da \u00e1rea admin.<\/p>\n
Voc\u00ea aprender\u00e1 como se conectar em a\u00e7\u00f5es e filtros mais tarde com muitos exemplos do WordPress Core.<\/p>\n
Uma vez viciado, voc\u00ea pode direcionar seu c\u00f3digo para fazer<\/strong> ou customizar<\/strong> algo em seu site. Por exemplo, voc\u00ea pode usar hooks para enviar um e-mail autom\u00e1tico<\/a> ap\u00f3s a publica\u00e7\u00e3o de um post, ou carrega rfolhas de estilo personalizadas<\/a> para mudar a apar\u00eancia do seu site.<\/p>\n
\"Os
Os hooks WordPress ajudam voc\u00ea a interagir ou modificar seu site<\/figcaption><\/figure>\n
A maneira mais simples de entender os hooks \u00e9 imaginar o seu site WordPress<\/a> como a constru\u00e7\u00e3o de uma casa.<\/p>\n
Os hooks s\u00e3o semelhantes ao uso de uma grua para mover itens de constru\u00e7\u00e3o para frente e para tr\u00e1s. Os itens que est\u00e3o sendo transferidos s\u00e3o as fun\u00e7\u00f5es de Callback<\/strong> que incluem seu c\u00f3digo personalizado<\/a>. Estes itens (ou fun\u00e7\u00f5es) podem ajudar voc\u00ea a construir ou modificar a casa.<\/p>\n
\"Exemplo
Exemplo de liga\u00e7\u00e3o \u00e0 a\u00e7\u00e3o ‘wp_head’ no WordPress<\/figcaption><\/figure>\n
As fun\u00e7\u00f5es de retorno podem ser fun\u00e7\u00f5es regulares do PHP, fun\u00e7\u00f5es padr\u00e3o do WordPress, ou fun\u00e7\u00f5es personalizadas definidas por voc\u00ea.<\/p>\n
S\u00f3 podemos transportar certos itens em suportes espec\u00edficos presos a hooks espec\u00edficos. Assim, as a\u00e7\u00f5es s\u00f3 podem ser ganchadas com fun\u00e7\u00f5es de a\u00e7\u00e3o. <\/strong>Da mesma forma, os filtros s\u00f3 podem ser enganchados com Fun\u00e7\u00f5es de Filtro<\/strong>.<\/p>\n
Embora seja tedioso trocar os hooks e suportes em um guindaste, o WordPress torna isso super f\u00e1cil ao incluir mais de 2.200 tipos de hooks padr\u00e3o<\/a>.<\/p>\n
\"WordPress
WordPress 5.1 tem 2200+ hooks nativos (Fonte: Adam Brown)<\/figcaption><\/figure>\n
Voc\u00ea pode encontrar hooks espalhados pelo WordPress Core, permitindo que voc\u00ea toque na posi\u00e7\u00e3o exata onde voc\u00ea quer se conectar e executar seu c\u00f3digo personalizado.<\/p>\n\n
Hooks vs A\u00e7\u00f5es vs Filtros<\/h2>\n
Conforme o WordPress Plugin Handbook<\/a>:<\/p>\n
“Hooks\u00a0s\u00e3o uma forma de um peda\u00e7o de c\u00f3digo interagir\/modificar outro peda\u00e7o de c\u00f3digo… Existem dois tipos de hooks: A\u00e7\u00f5es e Filtros. <\/em>\u201d<\/p><\/blockquote>\n
H\u00e1 uma inconsist\u00eancia generalizada com a forma como os termos Hooks<\/strong>, A\u00e7\u00e3o<\/strong> e Filtro<\/strong> s\u00e3o usados. Alguns tutoriais e guias os misturam com as fun\u00e7\u00f5es associadas a eles. Uma das principais raz\u00f5es para essa confus\u00e3o \u00e9 a natureza complexa de como os hooks funcionam.<\/p>\n
Mesmo quando voc\u00ea olha cuidadosamente dentro do WordPress Core, voc\u00ea vai descobrir que n\u00e3o h\u00e1 muita diferen\u00e7a entre adicionar a\u00e7\u00f5es e filtros. Aqui est\u00e1 o c\u00f3digo fonte para a fun\u00e7\u00e3o add_action() <\/a>do arquivo wp-includes\/plugin.php<\/code>:<\/strong><\/p>\n
function add_action( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {\u00a0 \u00a0 \u00a0 \n    return add_filter( $tag, $function_to_add, $priority, $accepted_args );\n}<\/code><\/pre>\n
A fun\u00e7\u00e3o add_action()<\/strong><\/code> apenas chama a fun\u00e7\u00e3o add_filter()<\/strong><\/code> e retorna seu valor. Por que? Porque ambas funcionam fundamentalmente da mesma forma, exceto por uma diferen\u00e7a.<\/p>\n
A fun\u00e7\u00e3o apply_filters()<\/strong><\/code> retorna um valor que pode alterar os tipos de dados existentes, enquanto a fun\u00e7\u00e3o do_action()<\/strong><\/code> n\u00e3o retorna nada (valor NULL no PHP<\/a>).<\/p>\n
Se voc\u00ea ainda estiver confuso, n\u00e3o se preocupe! Assim que voc\u00ea passar da primeira metade deste artigo, tudo ficar\u00e1 claro. Vamos nos ater \u00e0 terminologia oficial do WordPress Codex, pois ela \u00e9 clara, precisa e universal.<\/p>\n
Por enquanto, familiarize-se com a rotina de Hooks mostrada abaixo.<\/p>\n
\"A
A Rotina dos Hooks: Fun\u00e7\u00f5es de Hooks e Callback<\/figcaption><\/figure>\n
Vamos quebrar as diferen\u00e7as entre A\u00e7\u00f5es e Hooks.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Hooks WordPress<\/strong><\/td>\n<\/tr>\n
A\u00e7\u00f5es<\/strong><\/td>\nFiltros<\/strong><\/td>\n<\/tr>\n
As a\u00e7\u00f5es s\u00e3o utilizadas para executar fun\u00e7\u00f5es personalizadas em um ponto espec\u00edfico durante a execu\u00e7\u00e3o do WordPress Core..<\/td>\nOs filtros s\u00e3o utilizados para modificar ou personalizar os dados utilizados por outras fun\u00e7\u00f5es.<\/td>\n<\/tr>\n
As a\u00e7\u00f5es s\u00e3o definidas\/criadas pela fun\u00e7\u00e3o do_action( 'action_name' )<\/code><\/strong> no c\u00f3digo do WordPress.<\/td>\nOs filtros s\u00e3o definidos\/criados pela fun\u00e7\u00e3o apply_filters( 'filter_name', 'value_to_be_filtered' )<\/code><\/strong> no c\u00f3digo do WordPress.<\/td>\n<\/tr>\n
As a\u00e7\u00f5es tamb\u00e9m s\u00e3o chamadas de hooks de a\u00e7\u00e3o<\/strong>.<\/td>\nOs filtros tamb\u00e9m s\u00e3o chamados de hooks de filtro<\/strong>.<\/td>\n<\/tr>\n
As a\u00e7\u00f5es s\u00f3 podem ser ligadas com as fun\u00e7\u00f5es Action. Por exemplo, add_action(), remove_action()<\/code><\/strong>.<\/td>\nOs filtros s\u00f3 podem ser conectados com as fun\u00e7\u00f5es de Filtro. Por exemplo, add_filter(), remove_filter()<\/code><\/strong>.<\/td>\n<\/tr>\n
Fun\u00e7\u00f5es de a\u00e7\u00e3o n\u00e3o precisam passar nenhum argumento para suas fun\u00e7\u00f5es de chamada de retorno.<\/td>\nFun\u00e7\u00f5es de filtro precisam passar pelo menos um argumento para suas fun\u00e7\u00f5es de callback.<\/td>\n<\/tr>\n
Fun\u00e7\u00f5es de a\u00e7\u00e3o podem realizar qualquer tipo de tarefa, incluindo a mudan\u00e7a do comportamento de como o WordPress funciona.<\/td>\nAs fun\u00e7\u00f5es de filtro s\u00f3 existem para modificar os dados passados a eles pelos filtros.<\/td>\n<\/tr>\n
Fun\u00e7\u00f5es de a\u00e7\u00e3o n\u00e3o devem return<\/strong><\/code> nada. Entretanto, elas podem echo<\/code><\/strong> a sa\u00edda ou interagir com o banco de dados.<\/td>\nAs fun\u00e7\u00f5es de filtro devem return<\/code><\/strong> suas altera\u00e7\u00f5es como sa\u00edda. Mesmo que uma fun\u00e7\u00e3o de filtro n\u00e3o mude nada, ela ainda deve return<\/code><\/strong> a entrada n\u00e3o modificada.<\/td>\n<\/tr>\n
As a\u00e7\u00f5es podem executar quase tudo, desde que o c\u00f3digo seja v\u00e1lido.<\/td>\nOs filtros devem funcionar de forma isolada, para que n\u00e3o tenham nenhum efeito colateral n\u00e3o intencional.<\/td>\n<\/tr>\n
Resumo:<\/strong> Uma a\u00e7\u00e3o interrompe o processo normal de execu\u00e7\u00e3o do c\u00f3digo para fazer algo com as informa\u00e7\u00f5es que recebe, mas n\u00e3o devolve nada de volta, e depois sai.<\/td>\nResumo:<\/strong> Um filtro modifica a informa\u00e7\u00e3o que recebe, retorna para a fun\u00e7\u00e3o do Hooks de chamada e outras fun\u00e7\u00f5es podem usar o valor que ele retorna.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\u00a0<\/p>\n
\u00c0s vezes, voc\u00ea pode usar tanto uma a\u00e7\u00e3o quanto um filtro para atingir o mesmo objetivo. Por exemplo, se voc\u00ea quiser modificar o texto em um post, voc\u00ea pode registrar uma fun\u00e7\u00e3o de callback com a a\u00e7\u00e3o publish_post<\/a> e alterar o conte\u00fado do post quando ele estiver sendo salvo no banco de dados<\/a>.<\/p>\n
\/\/ define the callback function to change the text\nfunction change_text_callback() { \n    \/\/ add the code to change text here\n}\n\n\/\/ hook in to the 'publish_post' action with the add_action() function\nadd_action( 'publish_post', 'change_text_callback' );<\/code><\/pre>\n
Ou voc\u00ea pode registrar outra fun\u00e7\u00e3o de callback com o filtro the_content<\/a> para modificar o conte\u00fado do post antes que ele seja exibido no navegador.<\/p>\n
\/\/ define the callback function to modify the text\nfunction change_text_another_callback( $content ) { \n    \/\/ add the code to change text here and then return it \n    return $filtered_content;\n}\n\n\/\/ hook in to 'the_content' filter with the add_filter() function\nadd_filter( 'the_content', 'change_text_another_callback');<\/code><\/pre>\n
Duas abordagens diferentes com o mesmo resultado. Saber quando usar uma sobre a outra \u00e9 fundamental para ser um bom desenvolvedor do WordPress<\/a>.<\/p>\n
Como funcionam os hooks do WordPress?<\/h2>\n
O exemplo da casa foi simples o suficiente para entender o funcionamento b\u00e1sico dos hooks, mas n\u00e3o capta a complexidade de como eles funcionam. Mais importante ainda, os conceitos de posi\u00e7\u00e3o e especificidade dos hooks.<\/p>\n
Um exemplo melhor seria imaginar processar uma p\u00e1gina web WordPress como montar um carro. Ao contr\u00e1rio da fabrica\u00e7\u00e3o de um carro, que leva tempo, a montagem de uma p\u00e1gina da web \u00e9 quase instant\u00e2nea.<\/p>\n
\"Montar
Montar uma p\u00e1gina web \u00e9 como montar um carro<\/figcaption><\/figure>\n
Assim como um carro \u00e9 montado pe\u00e7a por pe\u00e7a em uma moderna linha de montagem, uma p\u00e1gina web WordPress \u00e9 montada elemento por elemento pelo servidor e pelo cliente.<\/p>\n
O WordPress Core \u00e9 como o motor do carro, chassis e outros essenciais, potencializando a funcionalidade “core” do site.<\/p>\n
Voc\u00ea pode ter um site funcional apenas com o WordPress Core, mas onde est\u00e1 a gra\u00e7a nisso? Voc\u00ea precisa adicionar recursos empolgantes ao site. \u00c9 a\u00ed que entram os plugins<\/a> e temas<\/a> do WordPress<\/a>, ambos usando hooks extensivamente.<\/p>\n
No exemplo acima, cada esta\u00e7\u00e3o numerada \u00e9 como um Hooks dentro do WordPress Core. Existem dois tipos de esta\u00e7\u00f5es, como a\u00e7\u00f5es e filtros. Cada esta\u00e7\u00e3o inclui um tipo espec\u00edfico de slot que aceita apenas certas ferramentas, semelhantes a fun\u00e7\u00f5es de a\u00e7\u00e3o e fun\u00e7\u00f5es de filtro.<\/p>\n
Todas as esta\u00e7\u00f5es s\u00e3o colocadas em intervalos freq\u00fcentes para modularidade e efici\u00eancia.<\/p>\n
Dependendo da necessidade em uma determinada posi\u00e7\u00e3o, podemos acoplar (ou enganchar) a ferramenta mais apropriada para o trabalho naquela esta\u00e7\u00e3o espec\u00edfica. Estas ferramentas s\u00e3o como as fun\u00e7\u00f5es de callback utilizadas para interagir ou modificar o WordPress.<\/p>\n
Algumas ferramentas podem alterar significativamente o funcionamento do carro, como os callbacks registrados para a\u00e7\u00f5es. Outras ferramentas s\u00e3o utilizadas apenas para personalizar a apar\u00eancia do carro, como as callbacks registradas em filtros.<\/p>\n
Usar as ferramentas certas nas esta\u00e7\u00f5es certas \u00e9 crucial para construir um carro de primeira linha. Da mesma forma, os hooks nos ajudam a personalizar o WordPress de acordo com nossas necessidades \u00fanicas.<\/p>\n
Se voc\u00ea estender esta analogia, os plugins s\u00e3o como adicionar recursos \u00fateis para autom\u00f3veis, como airbags, console de entretenimento, sistema remoto sem chave, etc (como estes par amelhorar a funcionalidade do WooCommerce<\/a>). Os temas s\u00e3o an\u00e1logos para personalizar a parte visual do carro, como o design geral, pintura, jantes, etc. (veja aqui como customizar seu tema do WordPress<\/a>).<\/p>\n
Onde registrar os hooks e suas fun\u00e7\u00f5es?<\/h2>\n
Existem duas formas recomendadas de adicionar hooks no WordPress:<\/p>\n