Normas de codificación de WordPress

Una de las razones por las cuales WordPress ha triunfado es la naturaleza para abrir el código: cualquiera puede ver el código fuente y contribuir al proyecto … ¡y no solo técnicamente! Además, la posibilidad de expandirse a través de temas y complementos también ha promovido la participación de terceros en WordPress (somos un ejemplo a este respecto). Pero, por supuesto, permitir que cualquiera participe tiene sus desventajas …

Sí, tener mucha gente en el mismo lugar es un poco aterrador. … Una es que cada programador tiene su propio estilo de programación. Por ejemplo, existe la discusión eterna sobre el uso de tabuladores o espacios para la sangría del código, las convenciones de nombre para variables y funciones, como escribir declaraciones condicionales, etc.
¿Cómo podemos hacer que todos en la misma página? ¿Existe una fórmula para que todos los desarrolladores sigan las mismas reglas y principios? ¿Podemos crear un proyecto consistente y coherente cuando se involucran miles de personas de todo el mundo? ¿Cuáles son los estándares de codificación de WordPress? En un artículo publicado en 2004 en el sitio, el autor explicó claramente cuáles son los estándares de codificación y por qué los necesitamos. Por ejemplo, imagine que necesita crear una variable PHP para almacenar un nombre de usuario. ¿Cómo lo llamarías? $ Nombre de usuario? $ Nombre de usuario? $ user_name? ¿Y cómo lo llamaría tu compañero de equipo? Por ejemplo, comencé programado con Java, por lo que lo más natural para mí habría sido usar “Camel Case” ($ UserName). Cada vez que veía algo escrito con el “caso de la serpiente” ($ user_name), ¡se veía tan horrible!
La verdad es que no importa qué opción elija: solo hablamos de “estilos” y aquí todos tienen la suya. Como se mencionó anteriormente, el problema surge cuando tenemos más desarrolladores que trabajan en el mismo proyecto, cada uno con su propio estilo. Si queremos que nuestro proyecto sea consistente, necesitamos que todos usen lo mismo, o podemos alcanzar un fragmento como este: donde casi todas las líneas tienen su propio estilo …
Podría haber sido peor. La solución de la solución del problema es el uso de estándares de codificación. Un estándar de codificación es un documento simple que define cómo los desarrolladores necesitan escribir su código. Si todos los desarrolladores siguen las recomendaciones de la guía, haremos nuestro proyecto consistente con estilo y evitaremos que se vea como un frankenstein roto.

Por lo general, un buen estándar de codificación debe:
Anime a los desarrolladores a escribir código inteligible
Organice el código en unidades de trabajo fáciles de entender (por ejemplo, funciones con un cierto número de líneas, organización en párrafos, etc.)
Definir convenciones para nombres de variables, estilo de espacio …
Describe cómo comentar sobre el código
Definir un buen estándar de codificación no es fácil. Pero, después de una pequeña búsqueda, pronto descubrirá que hay muchas líneas de dirección en Internet que puede usar o adaptar en sus propios proyectos. Pero aquí estamos hablando del mundo de WordPress, y como comunidad de código abierto ya hemos definido estas pautas. Si aún no los conoces, déjame presentarlos en un momento.
WordPress tiene varios estándares de codificación Lo primero que debería haberte sorprendido de mi párrafo anterior es que hablé de “guías” en el plural. “¿Cómo? WordPress define más guías? ¿Por qué?” ¡Muy buenas preguntas, amigo! ? Como saben, WordPress es un proyecto web y, como tal, utiliza más tecnologías: PHP, JavaScript, HTML y CSS. Como resultado, tenemos un estándar de codificación para cada uno de ellos: uno para el lenguaje PHP, otro para el código escrito en JavaScript, otro para los sitios web de diseño en HTML y otro para los estilos CSS. No es mi intención entrar en detalles para cada uno de ellos … más que nada porque toda la información que necesita se explica muy bien en las guías. Para cada una de las reglas descritas allí, encontrará un ejemplo explicativo de qué hacer y qué hacer. Entonces no deberías tener ningún problema para seguirlos. Pero me gustaría enfatizar algunos de los ejemplos que más me sorprendieron cuando comencé a aplicarlos. El código de WordPress es tímido y ama mi propio espacio, recuerdo lo que más me impresionó sobre los estándares de codificación de WordPress fue el uso de espacios. Hasta entonces, estaba acostumbrado a escribir el código bastante compacto:
Pero resulta que en WordPress necesitas muchos espacios:
Y no solo en PHP, sino también en JavaScript (para que todo el código se vea coherente, ya sabes …):

Si eres como yo, creerás que “tanto espacio es inútil”. Pero la verdad es que cuando te acostumbras, ¡es difícil volver! Estos espacios ayudan al código a respirar y verse menos sobrecargados, lo que hace que (en mi opinión) sea más fácil de leer y comprender.
Yoda condiciona a otra cosa que me hizo reír fue el uso de “condiciones de Yoda”. Por lo general, estamos acostumbrados a escribir las condiciones de la siguiente manera: pero el estándar de codificación nos dice que lo hagamos:
Poniendo el primer literal (en este caso, un todo) seguido de la variable. La razón de este pequeño cambio es que si ingresa la comparación mal (es decir, un signo igual en lugar de dos), el artista PHP dará un error de sintaxis (intente asignar una variable a un literal) y puede identificarlo rápidamente. algo no está bien. Por cierto, si te preguntas por qué se llama “Condición Yoda”, ¿solo tienes que leer este ejemplo y lo entenderás?:
Escribir el código que se puede mantener ¿Recuerdas cuando le dije que un buen estándar de codificación debería promover la generación de código inteligible? WordPress no es una excepción. Por ejemplo, en PHP puede escribir código como el siguiente:
Lo cual es totalmente bien y compacto. Pero, en comparación con esto, aquí:
Está claro que la segunda versión es mucho más fácil de entender, porque se parece más a un inglés simple. Cada vez que programes y se encuentre en una situación en la que deba decidir si escribir un alternativo ligeramente más largo y “verbos” o breve y “hacky”, opte por la primera opción: tu futuro ser o los desarrolladores de tus colegas. Su equipo lo aprecio.
Con un buen estándar de codificación, la vida es preciosa. ¡Cuídate! También hay diferencias que finalmente debes recordar, déjame terminar con una pequeña advertencia. Aunque los creadores de los estándares de codificación han tratado de hacerlos como coherentes y uniformes (recuerde, por ejemplo, de espaciado), hay algunas diferencias entre ellos. Por ejemplo, mientras que en la guía PHP, recomiendan escribir el nombre en el “caso de serpiente”: en la guía de JavaScript le pido que lo haga en “Camel Case”:
Esta pequeña diferencia entre un idioma y otro genera “curiosidades” como la siguiente:
Cuando queremos pasar las variables de PHP a JavaScript, utilizamos la función WP_LOCALSE_cript, que nos permite definir un objeto con valores de PHP que queremos estar disponibles en JavaScript. En este caso, vemos cómo las gargantas de matriz no cumplen con las instrucciones que describimos para PHP. Esto se debe al hecho de que estas variables están destinadas a ser utilizadas en JavaScript, no en PHP.

Deje que el editor ayude a pensar que las guías son geniales, pero no tiene tiempo ni desea aprenderlos. Después de todo, depende de usted, un programador, aplicarlos o no a su código, ¿verdad? Bueno, te equivocas! Puede confiar en su editor de código para esto. ?
Puede configurar Atom para detectar errores en su código de estándares de codificación.Mire esta captura de pantalla en la que el editor detecta “la condición no es Yoda”.En una publicación anterior, mi socio Antonio le contó sobre Atom, un editor de código elegante y versátil.Bueno, una de sus ventajas es que puede configurarlo para verificar automáticamente si el código que escribe respeta los estándares de codificación que indica y, si no, para advertirle que lo corregirá.No hace falta decir que este consejo no depende solo del átomo.Por ejemplo, lo uso en VIM y definitivamente puedes configurar el editor para él.Ahora es tu turno, amigos.¿Qué opinas sobre los estándares de codificación de WordPress?¿Los estás siguiendo?¿Dejas que tu editor te ayude?¡Deja tu opinión en los comentarios y hablemos de ello!Imagen presentada por Glenn Carstens-Peters.