de WordPress garantizan la consistencia y la facilidad de mantenimiento en la extensa base de código de la plataforma. Estas directrices, meticulosamente elaboradas, resumen los consejos de desarrollo de WordPress , fomentando la claridad y la eficiencia.
Al seguir estas de mantenimiento de WordPress , los desarrolladores de todo el mundo colaboran en armonía y se comprenden a la perfección. Insta a tu de desarrollo de WordPress a seguir rigurosamente los estándares de codificación para garantizar soluciones de alta calidad, escalables y fáciles de mantener a largo plazo.
¿Por qué ceñirse a los estándares de codificación de WordPress?
Los estándares de codificación de WordPress buscan garantizar la coherencia del código entre proyectos y colaboradores. Mejoran la legibilidad y el mantenimiento para el desarrollo colaborativo y facilitan las revisiones de 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 principal hasta los temas y plugins. Estos estándares, desarrollados por la comunidad de WordPress en consulta con los foros de soporte 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 los estándares de codificación
Los estándares de codificación ayudan a prevenir errores comunes, mejoran la legibilidad del código y simplifican las modificaciones. Al cumplirlos, 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 estos estándares es fundamental, ya que el código enviado debe cumplirlos.
¿Tiene dificultades para mantener los estándares de codificación para su sitio exclusivo de WordPress?
¡Deje que nuestros expertos desarrolladores de WordPress se encarguen del dolor de cabeza!
Componentes de los estándares de codificación de WordPress
Los estándares cubren pautas específicas del lenguaje para CSS, HTML, JavaScript y PHP, así como pautas de accesibilidad alineadas con WCAG AA.
Lea también: ¿Cómo convertir HTML a un tema de WordPress?
Excepción para bibliotecas de terceros
Sin embargo, las bibliotecas de terceros incorporadas a WordPress están exentas de estos estándares.
Ejemplos de estándares de codificación de WordPress
Exploremos los estándares de codificación de WordPress con varios ejemplos para comprender su aplicación en situaciones reales. Estos ejemplos ilustran las mejores prácticas recomendadas para escribir código claro y fácil de mantener en WordPress.
PHP EN WORDPRESS
WordPress utiliza actualizaciones de PHP como lenguaje de programación principal. Cumplir con los estándares de codificación PHP es crucial para un código consistente y fácil de mantener en WordPress. Aquí explicamos 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 habitual añadir uno después de la mayoría de las sentencias. Además, se recomienda colocar las definiciones de variables, los bloques if y los elementos de array en líneas separadas.
Sangría
Para facilitar la lectura del código, utilice sangría para mostrar su estructura lógica. Las tabulaciones deben usarse al principio de las líneas, mientras que los espacios se usan para la sangría a mitad de línea.
Uso del espacio
Para facilitar la lectura de su código, elimine los espacios adicionales al final de las líneas. También elimine las líneas vacías con tabulaciones o espacios indivisibles. Use espacios entre paréntesis para mayor claridad. Añada un salto de línea después de una llave de apertura y antes de una de cierre, excepto para la conversión de tipos.
Citas
En WordPress, la regla principal es usar comillas simples para las cadenas, a menos que se evalúe algo dentro. Si necesita comillas dentro de una cadena, alterne entre comillas simples y dobles. Se permite el escape de comillas, pero rara vez es necesario.
Tirantes
La forma más sencilla es usar siempre llaves. Si bien los estándares permiten omitir las llaves en sentencias "if" de una sola línea sin bloques de varias líneas en la misma estructura, esto no está permitido en bucles de una sola línea. Prefiero usar siempre llaves para mayor claridad. Además, los estándares especifican que la llave de apertura debe colocarse en la misma línea que la sentencia inicial, no debajo, como en la documentación de PHP.
Formato de consultas SQL
Al escribir consultas SQL, recuerde usar mayúsculas en las palabras clave. Las consultas complejas deben dividirse en varias líneas. Es importante comprender bien las consultas, especialmente sus aspectos de seguridad, que abordaremos más adelante. Los ataques de inyección SQL se producen debido a errores de seguridad de WordPress , lo que permite a los hackers acceder directamente y manipular la base de datos de un sitio web de WordPress.
Convenciones de nomenclatura
En el código de WordPress, evite usar CamelCase para los nombres. Las funciones deben usar minúsculas, con guiones bajos si es necesario. Los nombres de clase deben escribir la primera letra de cada palabra en mayúscula, separadas por guiones bajos.
Los nombres de archivo deben escribirse en minúsculas, con guiones entre cada parte. Si un archivo contiene una sola clase, asígnele el nombre de la clase, con el prefijo "class-".
Para mayor claridad, use valores de cadena como argumentos de función en lugar de booleanos. La regla más importante es que los nombres sean descriptivos. En un entorno colaborativo, procure que todos comprendan su código.
Declaraciones de comparación
Una buena práctica, no solo para WordPress, es colocar siempre la variable a la derecha de la comparación. De esta forma, si se olvida un signo igual, se generará un error en lugar de que la variable sea verdadera. Si prefiere usar operadores ternarios, está permitido, pero se recomienda comprobar su veracidad para mayor claridad. Una excepción es comprobar variables no vacías con ! empty().
FORMATO HTML
Según el Codex de WordPress, es importante validar todo el código HTML con el Validador del W3C. Sin embargo, un código válido no siempre significa que sea bueno, aunque existe una clara conexión entre ambos.
Tipo de documento
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, usa HTML5. No existe un conflicto real, ya que HTML5 incluye serialización XML, lo que permite el uso de "XHTML5"
Uso de comillas
En HTML, las comillas se usan principalmente para atributos y sus valores. Puedes elegir comillas simples o dobles, pero siempre es mejor usar un solo tipo. Personalmente, uso comillas simples siempre que sea posible, al igual que en PHP, por coherencia. Esto me ayuda a identificar rápidamente cualquier caso especial en una línea con solo mirar las comillas.
Etiquetas de cierre
La especificación XHTML exige cerrar todas las etiquetas. Los elementos vacíos deben cerrarse con una barra diagonal justo antes del último corchete angular. Asegúrese de que haya un espacio antes de la barra diagonal, como se especifica.
Sangría
Sangre su HTML siguiendo las mismas reglas que para PHP. Busque una estructura lógica con la sangría. Al combinar PHP y HTML, sangre los bloques PHP según el flujo habitual de sangría.
FORMATO CSS
El formato CSS implica organizar y estilizar la presentación del contenido web, garantizando la coherencia y la legibilidad en diferentes dispositivos y navegadores. Un formato CSS correcto mejora la estructura y el atractivo visual de los sitios web, contribuyendo a una mejor experiencia de usuario.
Leer más: ¿Cómo eliminar CSS no utilizado en WordPress?
Sangría y estructura
Tu CSS debe seguir este esquema básico: escribe cada selector en una línea aparte, incluso si enumeras varios selectores para un conjunto de reglas. Además, cada par propiedad-valor debe ocupar su propia línea. Coloca la llave de apertura en la línea del selector y la llave de cierre en una línea aparte con la misma sangría que la del selector de apertura.
Convenciones de nomenclatura
Use solo minúsculas. Separe las palabras dentro de un selector con un guion. Asigne a sus selectores nombres legibles.
Propiedades y valores
Existen varias reglas para escribir propiedades y valores. Utilice versiones abreviadas de las propiedades siempre que sea posible, excepto al sobrescribir una propiedad previamente definida. Utilice código hexadecimal en minúsculas para los colores siempre que sea posible. Si corresponde, utilice la versión abreviada. Inserte un espacio después de los dos puntos que siguen a una propiedad. Utilice siempre minúsculas, excepto cuando se requiera una mayúscula, como en el caso de los nombres de fuentes y las propiedades específicas del proveedor. Organice las propiedades CSS alfabéticamente, con la excepción de las propiedades específicas del proveedor, que siempre deben preceder a su equivalente general, y las propiedades dimensionales, que deben agruparse. Si se especifican el ancho y la altura, escriba primero el ancho.
Comentando
CSS solo admite un tipo de comentario: el estilo de bloque; no tiene una notación independiente para los comentarios en línea. Escriba comentarios breves en una sola línea, sin saltos de línea. Para comentarios que ocupen varias líneas, inserte un salto de línea justo después de la sintaxis inicial y otro justo antes de la sintaxis final. Si utiliza comentarios para delimitar secciones del código, utilice la siguiente notación:
Uso de preprocesadores CSS
El uso de preprocesadores CSS como SASS y Less nos facilita mucho la vida como desarrolladores, pero también presenta inconvenientes. El código generado por estas herramientas suele ser válido, pero no se puede decir que sea muy limpio. Una hoja de estilo generada manualmente (y con cuidado) será mucho más legible que una generada automáticamente por Less. Depende de lo que estés haciendo. Si tu producto es comercial, el objetivo final es una buena experiencia de usuario, con código válido y optimizado. En este caso, usa la salida del preprocesador como CSS principal, pero incluye el archivo original para los desarrolladores. Si bien tu CSS no se ajustará a los estándares de WordPress, incluir el archivo original acorta la distancia 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 una mejor experiencia de usuario) está bien. Sacrificar la validez del código no lo está.
¿Cómo puedes 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 al mío, mi JavaScript puede hacerte sangrar los ojos y tu CSS puede ser increíblemente hermoso. Pero cuando se trata de colaborar en un proyecto como WordPress, es crucial tener estándares de codificación consistentes.
Los estándares de codificación de WordPress existen para garantizar que cualquier persona que contribuya al código base pueda leer, comprender y desarrollar fácilmente el trabajo de otros. Al adherirse a estos estándares, se habla esencialmente el mismo idioma que los demás colaboradores. Es como aceptar usar reglas gramaticales y de formato consistentes para que todos puedan colaborar sin problemas en el mismo libro.
Si quieres contribuir a WordPress, es fundamental familiarizarte con los estándares de codificación y seguirlos. Esto permite que tu estilo de codificación se integre perfectamente con el código base de WordPress.
Conclusiones
Cumplir con los estándares de codificación de WordPress es esencial para mantener una base de código cohesiva y colaborativa. Estas directrices, desarrolladas por la comunidad de WordPress, sirven como lenguaje común para los colaboradores de todo el mundo. Al seguir los estándares de PHP, HTML, CSS, JavaScript y accesibilidad, los desarrolladores pueden garantizar que su código sea consistente, legible y fácil de mantener.
A medida que WordPress continúa evolucionando, estos estándares de codificación desempeñarán un papel crucial en el fomento de un entorno de desarrollo armonioso y eficiente para toda la comunidad.
