Recursos. Núcleo. El Codex. Referencia a funciones. Coding Standards. Francisco Javier Cervigon Ruckauer

Recursos

Núcleo

El núcleo de WordPress es la base del CMS, que nos aporta la mayor parte de la lógica y las funcionalidades. No debemos modificarlo, ya que podríamos causar un funcionamiento inesperado. Además, cualquier modificación podría perderse al instalar una nueva actualización.
Sin embargo, conviene acceder a él para comprender su funcionamiento y con él, la forma en la que podemos modificarlo mediante nuestro propio código en los temas y plugins. Casi todo el código está comentado. Muchos archivos incluyen al inicio un bloque de comentario aportando una descripción de lo que hacen y otra información útil. También la mayoría de funciones cuenta con una descripción de lo que hacen, así como de los parámetros que esperan y que devuelven o la versión de Wordpress en la que fueron incluidas.
Veamos un par de ejemplos de comentarios en diferentes archivos:
  

El Codex

La web es una wiki mantenida por la comunidad y traducida, al menos parcialmente, a diversos idiomas. Sin embargo, hay que tener en cuenta que a veces la documentación no está todo lo actualizada que debiera. Pese a eso, sigue siendo una referencia ineludible a la hora de trabajar con WordPress.

Referencia a funciones

Como has visto al comienzo de este módulo, en esta página podremos buscar fácilmente una función y consultar su descripción, los parámetros, el valor devuelto, el changelog y la propia definición de la función. Esta es la misma información que vemos en los archivos PHP, y no es casualidad.
Esta referencia está construida a partir de la información del propio código, haciendo uso de PHPDoc, lo que nos asegura que esté siempre actualizada. En ese sentido, será cuestión de comodidad acudir según el caso a esta referencia o al propio código de los archivos.

Coding Standards

Con el objetivo de que WordPress siga siendo un CMS de código legible y sencillo, nacen los Coding Standards.
A continuación, te mostramos algunos ejemplos de las reglas de PHP en WordPress:

Convenciones sobre nombres:

  • Los nombres de las variables se escriben en letras minúsculas.
  • Las clases comienzan las palabras en mayúsculas.
  • Las constantes están escritas íntegramente en mayúsculas.
  • En los tres casos anteriores, las palabras se separan mediante guiones bajos ("snake_case").
  • En los nombres de archivo las palabras se separan con guiones medios.

Uso de espacios
  • Se deben usar espacios a ambos lados de los paréntesis de los condicionales y bucles.
  • En los lados interiores de los paréntesis al definir y llamar a funciones.
  • A ambos lados de los comparadores.
  •  
Condiciones "Yoda"
En las comparaciones lógicas se deben poner las variables en la parte izquierda y las constantes, literales o funciones en el lado derecho. Así, por ejemplo, en caso de que olvidemos un signo de igual (=) al ir a hacer una comparación de igualdad (==), se lanzará un error en lugar de asignarse un valor de forma errónea.

Francisco Javier Cervigon Ruckauer

No hay comentarios:

Publicar un comentario