Los estándares de codificación de WordPress garantizan la coherencia y la capacidad de mantenimiento de la amplia base de código de la plataforma. Estas directrices meticulosamente elaboradas destilan consejos de desarrollo de WordPress, fomentando la claridad y la eficiencia.
Siguiendo estas guías de mantenimiento de WordPress, los desarrolladores de todo el mundo contribuyen de forma armoniosa, comprendiendo el trabajo de los demás a la perfección. Haz que tu equipo de desarrollo de WordPress siga diligentemente los estándares de codificación de WordPress para garantizar soluciones de alta calidad, escalables y mantenibles a largo plazo.
¿Por qué ceñirse a las normas de codificación de WordPress?
El objetivo de los estándares de codificación de WordPress es garantizar la coherencia del código entre proyectos y colaboradores. Mejoran la legibilidad y el mantenimiento del desarrollo colaborativo y facilitan la revisión del código y el cumplimiento de las mejores prácticas en todo el ecosistema de WordPress.
¿Qué son los estándares de codificación de WordPress?
Los Estándares de Codificación de WordPress proporcionan una base para la colaboración y la coherencia en todo el proyecto y la comunidad de WordPress, desde el código central hasta los temas y plugins. Estas normas, desarrolladas por la comunidad de WordPress, en consulta con las fuentes de soporte de WordPress, constituyen las mejores prácticas que los desarrolladores y colaboradores de WordPress deben seguir.
Más información: ¿Cómo reducir el impacto del código de terceros?
Importancia de las normas de codificación
Las normas de codificación ayudan a evitar errores comunes, mejoran la legibilidad del código y simplifican las modificaciones. Al adherirse a ellas, el código parece escrito por una sola persona, lo que facilita su comprensión y modificación.
Contribución al núcleo de WordPress
Si contribuye al núcleo de WordPress, familiarizarse con estas normas es crucial, ya que el código enviado debe cumplirlas.
¿Problemas para mantener los estándares de codificación de su sitio exclusivo de WordPress?
Deje que nuestros expertos desarrolladores de WordPress se encarguen de todo.
Componentes de las normas de codificación de WordPress
Las normas cubren directrices específicas de lenguaje para CSS, HTML, JavaScript y PHP, así como directrices de accesibilidad alineadas con WCAG AA.
Lea también: ¿Cómo convertir HTML a tema de WordPress?
Excepción para bibliotecas de terceros
Sin embargo, las bibliotecas de terceros incorporadas a WordPress están exentas de estas normas.
Ejemplos de normas de codificación de WordPress
Exploremos los Estándares de Codificación de WordPress a través de varios ejemplos para entender su aplicación en escenarios del mundo real. Estos ejemplos ilustran las mejores prácticas recomendadas para escribir código claro y mantenible en WordPress.
PHP EN WORDPRESS
WordPress utiliza actualizaciones de PHP como lenguaje de programación principal. Adherirse a los estándares de codificación PHP es crucial para un código mantenible y consistente en WordPress. He aquí por qué son importantes los estándares de codificación PHP:
Saltos de línea
WordPress no especifica mucho sobre los saltos de línea, pero es común añadir uno después de la mayoría de las sentencias. Además, se recomienda poner las definiciones de variables, los bloques if y los elementos de array en líneas separadas.
Indentación
Para facilitar la lectura del código, utilice sangrías que muestren su estructura lógica. Los tabuladores deben utilizarse al principio de las líneas, mientras que los espacios se emplean para la sangría intermedia.
Uso del espacio
Facilita la lectura de tu código eliminando los espacios sobrantes al final de las líneas. Elimine también las líneas vacías con tabuladores o espacios de no ruptura. Utilice espacios entre paréntesis para mayor claridad. Añade un salto de línea después de un paréntesis de apertura y antes de un paréntesis de cierre, excepto para la tipificación.
Citas
En WordPress, la regla principal es utilizar comillas simples para las cadenas a menos que estés evaluando algo dentro. Si necesita comillas dentro de una cadena, alterne entre comillas simples y dobles. Escapar las comillas está permitido, pero rara vez es necesario.
Ortesis
La forma más sencilla es utilizar siempre llaves. Aunque las normas permiten omitir las llaves en las sentencias "if" de una sola línea sin bloques de varias líneas en la misma estructura, esto no está permitido en los bucles de una sola línea. Yo prefiero utilizar siempre llaves para mayor claridad. Además, los estándares especifican colocar la llave de apertura en la misma línea que la sentencia inicial, no debajo de ella como en la documentación de PHP.
Formato de consultas SQL
Cuando escriba consultas SQL, recuerde escribir las palabras clave en mayúsculas. Las consultas complejas deben dividirse en varias líneas. Es importante entender bien las consultas, especialmente sus aspectos de seguridad, que discutiremos más adelante. Los ataques de inyección SQL ocurren debido a errores de seguridad de WordPress, permitiendo a los hackers acceder directamente y manipular la base de datos detrás de un sitio WordPress.
Convenciones de denominación
En el código de WordPress, evite CamelCase para los nombres. Las funciones deben usar minúsculas, con guiones bajos si es necesario. Los nombres de clases deben usar mayúsculas en la primera letra de cada palabra, separadas por guiones bajos.
Los nombres de archivo deben escribirse todos en minúsculas, con guiones entre las partes. Si un archivo contiene una sola clase, nómbrelo con el nombre de la clase, precedido de "class-".
Utilice valores de cadena para los argumentos de las funciones en lugar de booleanos para mayor claridad. La regla más importante es que los nombres sean descriptivos. En un entorno colaborativo, intenta que todo el mundo entienda tu código.
Declaraciones comparativas
Una buena práctica, no sólo para WordPress, es colocar siempre la variable a la derecha de una comparación. De esta forma, si olvidas un signo igual, provocará un error en lugar de evaluarse a verdadero. Si te gusta usar operadores ternarios, está permitido, pero se recomienda comprobar la verdad para hacer las cosas más claras. Una excepción es cuando se comprueban variables no vacías usando ! empty().
FORMATO HTML
Según el Codex de WordPress, es importante validar todo el código HTML utilizando el Validador del W3C. Sin embargo, un código válido no siempre significa que sea un buen código, aunque existe una clara conexión entre ambos.
Doctype
WordPress sigue la especificación XHTML 1.0 recomendada por el W3C en 2000. A pesar de ello, el tema Twenty Eleven, predeterminado en WordPress, utiliza HTML5. No hay conflicto real porque HTML5 incluye serialización XML, lo que permite el uso de "XHTML5".
Utilizar citas
En HTML, las comillas se utilizan principalmente para los atributos y sus valores. Puedes elegir comillas simples o dobles, pero cíñete a un tipo de forma consistente. Personalmente, utilizo comillas simples siempre que es posible, como hago en PHP, por coherencia. Esto me ayuda a detectar rápidamente cualquier caso especial en una línea con sólo mirar las comillas.
Etiquetas de cierre
La especificación XHTML obliga a cerrar todas las etiquetas. Los elementos vacíos deben cerrarse con una barra inclinada justo antes del último corchete angular. Asegúrese de que hay un espacio antes de la barra diagonal, como se especifica.
Indentación
Sangrar el HTML siguiendo las mismas reglas que para PHP. Procure que la sangría tenga una estructura lógica. Al combinar PHP y HTML, sangrar los bloques PHP basándose en el flujo habitual de sangría.
FORMATO CSS
El formateo de CSS consiste en organizar y estilizar la presentación del contenido web, garantizando la coherencia y legibilidad en distintos dispositivos y navegadores. Un CSS correctamente formateado mejora la estructura y el atractivo visual de los sitios web, lo que contribuye a mejorar la experiencia del usuario.
Más información: ¿Cómo eliminar CSS no utilizado en WordPress?
Sangría y estructura
Tu CSS debería seguir este esquema aproximado: Escribe cada selector en una línea separada, incluso si estás listando múltiples selectores para un conjunto de reglas. Además, cada par propiedad-valor debe ir en su propia línea. Pon la llave de apertura en la línea del selector, y pon la llave de cierre en una línea separada con la misma sangría que el selector de apertura.
Convenciones de denominación
Utilice sólo minúsculas. Separe las palabras dentro de un selector con un guión. Asigne a los selectores nombres legibles.
Propiedades y valores
Hay bastantes reglas para escribir propiedades y valores. Utilice versiones abreviadas de las propiedades siempre que sea posible, excepto cuando sobrescriba una propiedad previamente definida. Utilice el código HEX en minúsculas para los colores siempre que sea posible. Si procede, utilice la versión abreviada. Inserte un espacio después de los dos puntos que siguen a una propiedad. Utilice siempre caracteres en minúscula, excepto cuando se requiera un carácter en mayúscula, como en el caso de nombres de fuentes y propiedades específicas de proveedores. Organice las propiedades CSS alfabéticamente, con la excepción de las propiedades específicas del proveedor, que siempre deben preceder a su homóloga general, y las propiedades dimensionales, que deben agruparse. Si se especifican la anchura y la altura, escriba primero la anchura.
Comentarios
CSS sólo admite un tipo de comentario: el estilo bloque; no tiene una notación separada para los comentarios en línea. Escriba comentarios cortos en una sola línea, sin un salto de línea a continuación. Para los comentarios que abarcan varias líneas, inserta un salto de línea justo después de la sintaxis de apertura y otro justo antes de la sintaxis de cierre. Si utiliza comentarios para delimitar secciones del código, utilice la siguiente notación:
Uso de preprocesadores CSS
El uso de preprocesadores de CSS como SASS y Less nos facilita mucho la vida como desarrolladores, pero no está exento de inconvenientes. El código producido por estas herramientas suele ser válido, pero no puede decirse que sea muy limpio. Una hoja de estilo producida manualmente (y con cuidado) será mucho más legible que una producida automáticamente por Less. Depende de lo que estés haciendo. Si tu producto es comercial, entonces el objetivo final es una buena experiencia de usuario, con código válido y optimizado. En este caso, utilice la salida del preprocesador como CSS principal, pero incluya el archivo original para los desarrolladores. Aunque su CSS no se ajustará a los estándares de WordPress, incluir el archivo original salva un poco las distancias hasta que WordPress adopte una postura oficial. Sacrificar los estándares de codificación CSS para simplificar el proceso de desarrollo (con el objetivo de mejorar la experiencia del usuario) está bien. Sacrificar la validez del código no lo es.
¿Cómo puede contribuir a los estándares de codificación de WordPress?
El código es como escribir: cada uno tiene su propio estilo. Tu HTML puede ser diferente del mío, mi JavaScript puede hacerte sangrar los ojos y tu CSS puede ser de una belleza que te cambie la vida. Pero cuando se trata de colaborar en un proyecto como WordPress, es crucial contar con unos estándares de codificación coherentes.
Los estándares de codificación de WordPress existen para asegurar que cualquiera que contribuya a la base de código pueda leer, entender y construir fácilmente sobre el trabajo de otros. Al adherirte a estos estándares, básicamente estás hablando el mismo idioma que los demás colaboradores. Es como comprometerse a utilizar reglas gramaticales y de formato coherentes para que todo el mundo pueda colaborar sin problemas en el mismo libro.
Si quieres contribuir a WordPress, es fundamental que te familiarices con los estándares de codificación y los sigas. De este modo, tu estilo de codificación individual encajará a la perfección con el código base de WordPress.
Conclusiones
Cumplir las normas de codificación de WordPress es esencial para mantener una base de código cohesionada y colaborativa. Estas directrices, desarrolladas por la comunidad de WordPress, sirven como lenguaje común para colaboradores de todo el mundo. Siguiendo los estándares para PHP, HTML, CSS, JavaScript y accesibilidad, los desarrolladores pueden garantizar que su código sea coherente, legible y fácil de mantener.
A medida que WordPress siga evolucionando, estas normas de codificación desempeñarán un papel crucial en el fomento de un entorno de desarrollo armonioso y eficaz para toda la comunidad.
