As 4 regras da criação de shortcodes no WordPress

Shortcodes no WordPress são largamente utilizados por usuários diversos da plataforma, sejam eles gestores de conteúdo ou desenvolvedores.

Um shortcode precisa ser interpretado em dois cenários. No editor do WordPress e em seu código que o interpreta e o renderiza. Essa código pode estar nativamente no WP, em temas ou plugins.

Os shortcodes no editor do WordPress

No editor do WordPress um shortcode é reconhecido pela sua composição, ou seja, “[” (abertura de colchete) seguido do seu nome que pode ser composto por letras minúsculas, números e sublinhados e “]” (fechamento de colchete).

Evite o uso de “-” hífen na composição de nomes de shortcodes.

A inserção de uma galeria de fotos, por padrão, no editor do WordPress se dá pelo shortcode “gallery”. Talvez o mais conhecido deles. Em versões mais recentes do WP os códigos de shortcodes padrão passaram ser destacados no editor com uma representação visual.

Representação visual do shortcode gallery no editor do WordPress

Funções que interpretam os shortcodes

Os códigos que declaram e interpretam um shortcode postado no editor do WordPress é uma função que aceita parâmetros e retorna dados.

Esse retorno de dados é o output desejado pelo shortcode, o qual pode ser personalizado com base nos parâmetros utilizados, se suportados.

As regras de sucesso

São quatro. E você como desenvolvedor ou empresa de desenvolvimento precisa conhece-las a fundo para se dar bem e aproveitar ao máximo esse recurso muito utilizado e requisitado.

1. A função de callback do shortcode enviará três argumentos para a função registrada para sua interpretação. São eles: os atributos do shortcode, o conteúdo (se houver) e o nome do shortcode;
2. Cada shortcode pode conter somente uma função associada a ele. No caso de conflito, por exemplo um plugin adicionou um shortcode semelhante, a função associada será sobrescrita. A sua função, ou a do plugin, poderá ficar em desuso. A ordem de carregamento que definirá a função a ser utilizada;
3. Os nomes de atributos serão sempre convertidos para minúsculos. No entanto seus valores serão preservados. Adote o padrão de manter tudo em minúsculo, nome e atributos;
4. Funções associadas a shortcodes não devem, em hipótese alguma, printar qualquer tipo de conteúdo. O conteúdo deve ser obrigatoriamente retornado. O não respeito a essa regra acarretará em comportamentos inesperados.

Além dessas quatro regras para a criação de shortcodes, você costuma utilizar alguma outra?