Los estándares de codificación de WordPress unirlo todo

Cuando se trata de escribir una serie de publicaciones de blog, uno de los aspectos más desafiantes para los lectores es mantenerse al día con cada publicación que se publica..

Incluso si se las arregla para intentar mantenerse al día, las publicaciones que tienen más de 1,000 palabras, especialmente aquellas que incluyen código, pueden llevar tiempo que muchos de nosotros no tenemos, especialmente cuando se trata de hacer malabarismos con nuestras vidas laborales, vidas familiares, aficiones, y otras cosas.

Así que para asegurarme de que la información presentada a lo largo de esta serie todavía se presenta de una manera digerible, pensé que experimentaría haciendo un resumen de toda la serie. De esa manera, para aquellos de ustedes que se han perdido un artículo o no han tenido tiempo de sentarse y leer cada artículo, aún pueden obtener la esencia de cada punto mencionado en todos los artículos..

Dicho esto, echemos un vistazo a todo lo que cubrimos al revisar los estándares de codificación de WordPress.

Los estándares de codificación de WordPress

En términos generales, el propósito de toda esta serie es ayudar a aclarar los Estándares de codificación de WordPress para que aquellos que no han oído hablar de ellos, aquellos que no los conocen o aquellos que no los han seguido estén mejor equipados para escribir Temas de WordPress, complementos y aplicaciones.

Para hacer esto, nos sumergimos profundamente en varios aspectos diferentes de los Estándares de Codificación a lo largo de seis artículos diferentes que destacan los principios, las mejores prácticas y las cosas que deben evitarse..

A continuación, hemos resumido cada uno de los artículos, así como las viñetas que son puntos clave y vale la pena destacar para el tema en cuestión. Por supuesto, si te quedas con ganas de obtener más información, puedes volver al artículo de la serie (vinculado en la parte superior de esta publicación) para leerlo en su totalidad..

1. Convenciones de nomenclatura y argumentos de función

Convenciones de nombres

Cuando trabaja con clases, funciones, variables, atributos o argumentos, las convenciones de nomenclatura deben ayudar a explicar el propósito que sirven.

Por ejemplo, las clases son generalmente nombres y los nombres de funciones son normalmente verbos. En última instancia, se trata de asegurarse de que el código sea legible y mantenible.

Directamente de los Estándares de Codificación:

No abrevie nombres de variables no necesariamente; Dejemos que el código sea inequívoco y auto documentado..

Pero vale la pena seguir este principio particular. sin importar de donde en el codigo estas trabajando.

Argumentos de la función

Recuerde que cuando se trata de pasar argumentos de función, es importante recordar que si el nombre de una función describe la acción que se lleva a cabo dentro del contexto de la clase, entonces el argumento debería representar en qué está funcionando realmente la función..

Prefiere valores de cadena a solo cierto y falso al llamar a funciones.

Esto significa que los argumentos de la función deben ser valores claros, cadenas o números, ya que los valores booleanos a menudo no son claros y no indican necesariamente qué acción tomará la función.

2. El uso de comillas simples y dobles.

Cuando se trata de trabajar con cadenas en WordPress, normalmente se trata de trabajar dentro de los matices de la manipulación de cadenas de PHP. Como tal, en este artículo, revisamos cómo PHP maneja las citas (tanto simples como dobles) y cómo afecta nuestro desarrollo de WordPress.

Comillas simples

La forma más fácil de definir una cadena en PHP es envolverla con comillas simples (es decir, el 'carácter').

Como con la mayoría de los lenguajes de programación, hay son formas de escapar de los caracteres para que puedas escribir una cadena literal. Por ejemplo, si desea escribir: "Las cadenas en PHP son fáciles", como una cadena, puede hacer esto:

'Cadenas en PHP son fáciles.'

Las barras invertidas indicarán a PHP que escriba la comilla simple en lugar de terminar la cadena real. La segunda cosa a tener en cuenta es que si tiene una variable, no reemplazado cuando se cita entre comillas simples.

Doble comillas

Las comillas dobles operan un poco diferente dentro de PHP. Específicamente:

Si la cadena está entre comillas dobles ("), PHP interpretará más secuencias de escape para caracteres especiales.

Esto significa que si incrusta una variable dentro de una cadena de PHP entre comillas dobles, la variable se interpretará y su valor se insertará en lugar de la variable antes de mostrarla en la pantalla..

Cuerdas y WordPress

Dado que gran parte del trabajo realizado en WordPress también incluye escribir un marcado dentro una cadena PHP, es mejor colocar esas cadenas entre comillas simples para que los atributos del elemento HTML puedan encerrarse entre comillas dobles.

Pero hay veces en que es más preferible usar comillas dobles especialmente cuando necesitas evaluar una variable.

El mejor consejo que se puede ofrecer aquí es saber cómo funcionan las comillas simples y las comillas dobles dentro de PHP, y luego usarlos de manera adecuada según su caso de uso..

3. Sangría, espacio utilizable y espacios finales

Recuerde: el espacio en blanco mejora la legibilidad del código y, como desarrolladores, uno de nuestros principales objetivos debe ser asegurarnos de que el código que estamos escribiendo no solo siga un estándar predefinido, sino que también esté dirigido a otros desarrolladores para facilitar la legibilidad y mantenibilidad.

Sangría

En lo que respecta a la sangría, no hay nada realmente nuevo, especialmente si está familiarizado con los lenguajes de estilo C. La mayoría de las veces, sangrarás cada vez que comiences un nuevo bloque..

• Tus funciones serán sangradas dentro de la clase.
• Sus condicionales y cambio / casos y otros bloques serán sangrados dentro de sus funciones
• Sus bucles serán sangrados dentro de sus funciones, dentro de sus condicionales, etc.

Tenga en cuenta que los estándares de codificación hacer tener reglas sobre tabulaciones y espacios:

Su sangría siempre debe reflejar la estructura lógica. Utilizar pestañas reales y no espacios, Como esto permite la mayor flexibilidad entre los clientes..

Esto es especialmente útil en la comunidad de código abierto..

Uso del espacio

Los espacios deben colocarse en los siguientes lugares:

• Despues comas
• A ambos lados de los operadores lógicos (es decir,, ||, &&, y !)
• En ambos lados de los operadores de comparación (es decir,, <, >, ==, ===, etc.)
• A ambos lados de los operadores de asignación (a saber, =)
• En ambos lados del paréntesis de apertura y cierre de funciones, condicionales, bucles, etc..
• Cuando una variable se pasa como un índice de una matriz, pero no cuando un valor literal (como una cadena o un entero)

Espacios finales

Esta es una de las convenciones más simples a seguir. Honestamente, es muy probable que su IDE o el editor de su elección tengan esta característica incorporada, o hay un complemento disponible que le permitirá hacerlo automáticamente..

De lo contrario, debería poder activar la capacidad de ver pestañas, espacios, retornos de carro, etc. para que pueda identificarlos fácilmente. dónde Los espacios finales son. Y cuando los veas, elimínalos..

4. Estilo de refuerzo, expresiones regulares y etiquetas PHP

En esta sección, echamos un vistazo a por qué el estilo importa. También definimos exactamente cómo los estándares de codificación y las convenciones definen cómo diseñamos nuestro código.

Estilo corsé

En general, las reglas son simples:

• Los bloques de una sola línea pueden omitir llaves
• Bloques multilínea siempre deben incluir llaves
• Cuando tenga demasiados condicionales multilínea, considere dividir los condicionales en sus propias funciones para minimizar el bloqueo.

Estos son particularmente comunes si vienes de otros lenguajes de estilo C; Sin embargo, al igual que WordPress tiene matices sutiles que otros idiomas no tienen, vale la pena resaltarlos aquí..

Expresiones regulares

PHP ofrece una variedad de formas de trabajar con expresiones regulares, aunque WordPress recomienda que solo usemos algunas de las funciones disponibles.

Las reglas para trabajar con expresiones regulares en PHP en WordPress son las siguientes:

• Utilizar el pregonar funciones que ofrece PHP
• No utilice el \mi interruptor que ofrece PHP - use preg_replace_callback en lugar.

Específicamente, recomiendo estar familiarizado con las siguientes funciones:

• preg_replace
• preg_match
• preg_match_all

Además, tenga en cuenta que preg_replace_callback es una forma de llamar a una función cuando una expresión regular ha encontrado una coincidencia.

Etiquetas PHP

Existe una regla general muy sencilla para usar etiquetas PHP en el desarrollo de WordPress:

• Nunca uses etiquetas PHP abreviadas

Esto significa que nunca debe abrir un archivo o una declaración de PHP en línea con  o con . Naturalmente, todas las declaraciones de PHP en línea deben terminarse con la ?> etiqueta de cierre.

 $ uses_gasoline = 'hybrid' == $ car_type? falso verdadero; echo $ uses_gasoline;