Guía de la Shortcode API de WordPress: 1 Introducción

Publicado el Deja un comentario

En esta ocasión vamos a ver de cabo a rabo la Shortcode API de WordPress que, como veremos, es una herramienta imprescindible cuando estamos programando en WordPress.

¿Qué es la Shortcode API?

Bien, como menciona la documentación oficial de WordPress.org, la Shortcode API es un conjunto de sencillas funciones que nos permiten crear nuestros propios Shortcodes para incluirlos en algunas ubicaciones de nuestro WordPress y de esta manera facilitarnos la vida con ciertas tareas que sin disponer de el Shortcode en cuestión, nos llevaría mucho más tiempo y nos provocaría mas de un quebradero de cabeza.

A lo largo de los artículos dedicados a la Shortcode API iremos viendo y avanzando sobre este tema.

¿Qué es un Shortcode?

Claro, he comentado qué es la Shortcode API pero no he comentado qué es un Shortcode.

Pues bien, un Shortcode lo podríamos definir como un "código" a través del cual llamamos a una función que tenemos previamente implementada y la cual realizará una o varias operaciones aunque también podemos utilizarla para hacer sustituciones. Esta última utilidad es la más utilizada en estos momento o por lo menos eso creo yo.

Un ejemplo para entenderlo mejor

El típico ejemplo de lo más sencillo es crear un Shortcode para sustituir en el lugar en el que ponemos el Shortcode por otro contenido.

Por ejemplo, imaginad que tenemos costumbre de poner el texto "Google" muchas veces en casi todos los artículos o entradas que creamos, y creamos muchas. Es un ejemplo, ok?

Pero no sólo eso. Imaginad que sobre el texto Google siempre ponéis el enlace a la web de Google España. Entonces, cada vez que ponéis el texto Google tenéis que seleccionarlo, pulsar sobre el botón de "Insetar / editar enlace" del editor de texto de WordPress y poner el texto que hará de enlace "http://www.google.es" y ya que estamos, hacer check para que se abra en otra pestaña del navegador.

Vale, si lo tenemos que hacer 5 veces en un mes pues casi que no nos importa pero si tenemos que hacerlo 10 veces todos los días... Esto ya es ago tedioso y hay que intentar siempre que sea posible automatizar las tareas para ahorrar tiempo.

Para el caso que estamos comentando, podemos crear un Shortcode para que cada vez que escribamos ese código en el editor de entradas de WordPress, o sustituya por lo que finalmente queremos, que no es otra cosa que el texto Google que contenta un enlace a "http://www.google.es".

Entonces, nosotros sólo tendríamos que escribir el código [google] en nuestra entrada y el lo sustituiría por Google.

Interesante y útil, ¿verdad?

Hemos visto un ejemplo muy sencillo pero ya veremos que podemos hacer verdaderas virguerías con los Shortcodes. Ya veréis...

Tipos de Shortcodes

Como ya habréis adivinado o intuido y si no lo habéis hecho, os lo digo yo: Hay varios tipos de Shortcodes. Cada uno de estos tipos tiene sus propias características y añaden funcionalidades y características que nos vienen muy bien para realizar tareas avanzadas.

Hay tres tipos de Shortcodes ( o cuatro, según se mire):

Sencillo y sin parámetros ni contenido.

Este tipo es el que hemos comentado hace un momento:  

[codigo]

Y como también hemos comentado, este tipo de Shortcode lo escribimos tal cual y WordPress se encarga de sustituirlo por lo que hayamos programado en la función correspondiente.

Con parámetros.

Estos del estilo: [codigo parametro="valor"]

En este caso se utiliza el parámetro que se pasará a la función del Shortcode y realizará algo teniendo en cuenta el parámetro en cuestión.

Como ejemplo podemos seguir con el anterior y darle una vuelta para que cuando pongamos [enlace url="google"] nos lo intercambie por Google. Parece igual que el anterior, ¿verdad? Pues no, porque este nos permitiría tomar el parámetro y en la función hacer una cosa u otra o más bien mostrar una cosa u otra en función de ese parámetro.

Por ejemplo, si en lugar de "google" le indicamos "facebook" o "bing", que haga lo correspondiente dependiendo del valor del parámetro que le indiquemos. Por consiguiente habrá que implementar estas opciones en la función del Shortcode.

Para entenderlo mejor, a continuación indico tres posibles opciones de este Shortcode :

[codigo url="google"]   -->    Google

[codigo url="facebook"]  -->  Facebook

[codigo url="bing"]  -->  Bing

Como vemos en los ejemplos anteriores, dependidiendo del parámetro que indiquemos, mostrará una cosa u otra.

En este ejemplo hemos usado un parámetro pero es posible utilizar más de uno.

Haré algún ejemplo en otro artículo de esta serie para que veamos cómo se hace, cómo crear el código necesario para implementarlo.

Con contenido.

Este tipo de Shortcode se implementa de la siguiente forma:

[codigo]Contenido dentro del shortcode[/codigo]

Observamos que es como el primer tipo que hemos comentado antes pero extendemos su funcionalidad introduciendo contenido entre

[codigo] y [/codigo]

.

De forma similar al tipo de Shortcode anterior, en este caso también podremos utilizar el contenido que se indique entre la apertura y cierre del Shortcode.

Podríamos pasarlo a la función que  implementemos en el código del Shortcode y hacer algo con este contenido pero también podríamos hacer que, simplemente sea texto y lo formateemos a nuestro gusto. Por ejemplo, que se le aplique: negrita, un tamaño de fuente de 22, cambiarle el tipo de fuente y/o cualquier cosa que se nos ocurra.

Y ahora vamos a comentar el último tipo de Shortcode.

Con parámetros y con contenido.

[codigo parametro="valor"]contenido[/codigo]

Si hemos prestado atención a los anteriores tipos, nos daremos cuenta que este tipo es una mezcla del segundo y del tercero, ¿verdad?

Utilizará uno o varios parámetros y también contenido.

No me voy a extender más con este tipo porque habla por si mismo y haré algún ejemplo sobre este y los demás en otros artículos de esta serie, más adelante.

Espero que os haya gustado este artículo sobre la Shortcode API de WordPress y que me comentéis lo que queráis, dudas, comentarios, etc...

Si duda, la utilización de los Shortcodes es imprescindible en programación WordPress y debemos aprender a manejarlos con soltura. Me refiero a lo que se refiere a su programación.

En el próximo artículo de esta serie veremos las diferentes opciones que tenemos para crear un Shortcode y alguna que otra cosa más.

Saludos y hasta el próximo artículo.

Programad todo lo que podáis!!

Deja una respuesta

Tu dirección de correo electrónico no será publicada.