Creando un plugin para WordPress parte 2: Estilo del Código

A la hora de escribir el código de nuestro plugin, es muy recomendable emplear técnicas de Programación Orientada a Objetos (POO). Podemos partir del Boilerplate de Devin Vinson, que sigue una convención existente sobre la estructura de archivos y carpetas que debe contener un plugin POO para WP.

WordPress tiene una serie de guías de buenas prácticas de desarrollo de plugins, el conocido como Plugin Handbook. Además no hay que olvidar que WordPress es un CMS escrito en PHP, por lo tanto no está de más echar un vistazo a los Estándares de codificación básica y Guías de estilo de codificación POO.

Dentro de un plugin podremos encontrar código HTML, CSS, JS y PHP. Cada lenguaje tiene su propio marcado, atributos, estándares, funciones, etc…así como sus propias buenas prácticas. Es difícil agruparlas ya que algunas de estas buenas prácticas son comunes, pero podríamos hacer un resumen a grandes rasgos del siguiente modo:

 

HTML

  • Declara el DOCTYPE correcto
  • Codificación UTF-8
  • Cierra SIEMPRE las etiquetas y nómbralas SIEMPRE en minúsculas
  • Usa ficheros externos para CSS y colócalos en el head, y usa ficheros externos para JS y colócalos antes de cerrar el body.
  • Indentación a 4 espacios
  • Valida el código con https://validator.w3.org/

 

CSS

 

JS

  • Espaciado en objetos, arrays, funciones
  • Puntuación, indentación y saltos de línea
  • Declaración de variables, comprobación de tipos
  • Yoda Style *

 

PHP

  • Uso de prefijos
  • Indentación, llaves y espaciado
  • Nomenclatura en ingles y descriptiva
  • No usar short tags (<?=$value;?>)
  • Usa el operador ternario
  • Yoda Style *
  • Control de errores

 

Esto es a grandes rasgos. La idea es que tengas un código ordenado y limpio. Si trabajas en equipo esto adquiere una mayor importancia, ya que si todos los miembros del equipo trabajan del mismo modo, es más fácil leer y retomar el código de un compañero. Además, es buena costumbre comentar el código, de esta manera siempre podremos ver que hace una función leyendo un párrafo de texto antes de bucear en el código para ver que hace.

 

*¿En qué consiste el yoda-style?

yoda style

Es una buena práctica para evitar errores cuando comparamos una variable. En lenguajes como PHP cuando comparas una variable utilizamos 2 signos igual (==), pero este lenguaje permite utilizar 1 signo igual para asignación de valores y 3 signos igual para la comparación idéntica. De este modo, la forma lógica cuando queremos preguntar si nuestra variable cumple una condición es hacer un if ($value == true).

El yoda style nos sugiere hacerlo al revés (al igual que Yoda habla al revés), es decir: if (true == $value). ¿Porqué? Para evitar errores. En ocasiones podemos confundirnos mientras escribimos código y poner un if ($value = true) y nuestro código no rompería….simplemente estamos asignado SIEMPRE true a nuestra variable. Nos costaría identificar el error en nuestro código ya que no hay un error como tal, simplemente siempre es true y siempre se ejecuta lo que haya dentro del if.

Si usamos yoda style de este modo if (true = $value) si que nos dará error ya que no podemos hacer esa asignación, e identificaremos el fallo rápidamente.

Si te ha gustado, valora este artículo para mejorar la calidad del blog o compártelo en Redes Sociales…
1 Star2 Stars3 Stars4 Stars5 Stars (2 votos, valoración 3,00 sobre 5) Loading...

Web Hosting