¿Cuáles son los estándares de codificación PHP de WordPress?

¿Cuáles son los estándares de codificación PHP de WordPress? En este video de mi curso, Aprenda PHP para WordPress, aprenderá todo sobre los estándares de codificación y por qué son importantes.

Los estándares de codificación PHP de WordPress

 

¿Cuáles son los estándares de codificación PHP de WordPress??

Puede encontrar los estándares de codificación de WordPress PHP completos en el manual oficial de WordPress..

Son esencialmente un conjunto de mejores prácticas sobre cómo usar PHP en WordPress. En el resto de este tutorial, veremos algunos ejemplos de lo que eso significa en la práctica..

Como puede ver, hay estándares no solo para PHP sino también para la accesibilidad y para los otros idiomas que usaría en WordPress. 

¿Por qué son importantes los estándares de codificación PHP??

¿Por qué es importante que todos cumplamos con estos estándares?? 

Bien, hay dos razones. Uno de ellos es sobre la calidad del código, y el otro sobre la calidad del código.. 

Entonces, en primer lugar, la calidad es importante porque significa que todos los que codifican en WordPress están creando un código que funcionará, que hará su trabajo y que se escribirá de manera actualizada y de alta calidad..

El segundo, que tiene que ver con la consistencia, es igualmente importante. Es muy probable que de vez en cuando vayas a trabajar con el código de otras personas. Por ejemplo, si está creando un tema secundario, es posible que deba copiar parte del código del tema principal. Y si está creando un complemento, ese complemento podría ser una bifurcación de un complemento existente de terceros al que está copiando y agregando funcionalidad adicional. Es realmente importante que la manera en que usted codifica sea consistente con la forma en que todos los demás que codifican PHP para WordPress escriben ellos mismos. 

Ejemplos de estándares de codificación PHP para WordPress

Así que echemos un vistazo a algunos de los estándares de codificación de PHP. Y les mostraré ejemplos de estos en algunos de los archivos de mi tema.

Convenciones y casos de nombres

Vamos a empezar con las convenciones de nombres y los casos. Cuando estás pensando en nombrar convenciones, hay cuatro cosas en que pensar:

  1. Las funciones dentro de tu tema o tu plugin.
  2. Los archivos y la forma en que los nombras.
  3. cualquier clase que escribas
  4. cualquier variable que crees

Así que vamos a empezar con las funciones. Aquí está el archivo functions.php en mi tema como ejemplo. 

Puedes ver que tengo una función que he definido llamada rachelmcc_register_widgets. Eso es todo escrito en minúsculas, y estoy usando guiones bajos entre las palabras, que es como siempre debes escribir una función en WordPress.

Como también verás, he usado un prefijo. Esto es para garantizar que esta función no coincida con ninguna otra función que pueda ser proporcionada por mi tema o por otro complemento. Así que si escribiera una función que se acaba de llamar register_widgets y uno de mis complementos también tenía una función llamada register_widgets, Los dos podrían chocar. Puede encontrar que uno de ellos anula al otro o que el complemento no funciona. 

Entonces, en cambio, estoy usando una función única que es relevante para mi tema. Mi tema se llama rachelmccollin, entonces mis funciones tienen rachelmcc como prefijo Y también es importante usar guiones bajos para tus funciones y no usar guiones.

hacer Usa guiones en dos lugares. Primero, usas guiones cuando estás definiendo clases de CSS. Así que puedes ver que dentro de mis widgets, estoy definiendo clases de CSS para mi h3 elemento y también para el carné de identidad de esa área del widget. Y aquí, usas guiones..

El otro lugar en el que usas guiones está en los nombres de tus archivos. Así que esto es front-page.php. 

Siempre debe usar guiones en los nombres de sus archivos dentro de sus temas y sus complementos; no utilice guiones bajos Así que aquí hay una llamada usando Locate_template. Y loop-frontpage.php es un archivo, una parte de la plantilla que estoy llamando, y puedes ver que tiene un guión y no un guión bajo. 

Por otro lado, mi ID de tipo de publicación, que es un tipo de publicación personalizada que he registrado, utiliza un guión bajo: rmcc_blurb

Ahora también es posible que deba pensar en las variables dentro de su tema. Echemos un vistazo a loop-frontpage.php:

Dentro de este archivo en particular, que es el que estaba llamando desde ese archivo anterior, he definido algunas variables, una llamada contar y uno llamado título. Y pueden ver que estoy usando minúsculas para ambos. 

El otro lugar donde necesita pensar sobre los guiones bajos y el uso de mayúsculas es cuando está utilizando una clase. Volvamos a la primera página. Php:

Y puedes ver aquí, estoy usando el WP_Query clase. Así que una clase tiene una letra mayúscula después del subrayado, así como al principio. Así que ahí es donde usas las mayúsculas cuando estás definiendo una clase. Ayuda a las personas que trabajan con su código a identificar instantáneamente que es una clase y no una función.

Uso de comillas simples y dobles

Ahora echemos un vistazo a cómo usarías comillas simples y dobles en PHP para WordPress. 

Puede usar comillas simples o comillas dobles, dependiendo de cuál funcione mejor para el código específico con el que está trabajando.

La razón por la que las comillas dobles a veces pueden ser más útiles es que facilitan el trabajo con caracteres especiales. Aquí hay un ejemplo:

Digamos que estaba escribiendo un archivo de plantilla de búsqueda, search.php. Y dentro de eso, si no se encontró nada, pondría un párrafo que dice: "Lo siento, su búsqueda no encontró nada. ¿Por qué no lo intenta de nuevo?"

Lo he puesto entre comillas dobles porque el texto contiene apóstrofes. Permítame mostrarle cómo funcionaría si lo hiciéramos entre comillas simples. 

Debe colocar una barra invertida antes de los apóstrofes para que se impriman correctamente dentro del HTML; de lo contrario, le dará errores. Ahora no sé usted, pero prefiero escribirlo normalmente entre comillas dobles que hacer todo esto dentro de comillas simples.

La otra cosa que debe recordar es que si necesita poner comillas entre comillas, puede poner comillas simples entre comillas dobles, o viceversa. No importa en qué sentido, pero no puede poner comillas simples entre comillas simples o comillas dobles entre comillas dobles.

Así que aquí hay un ejemplo que se remonta a mi archivo functions.php. 

Dentro de aquí tengo comillas simples por el valor de antes_widget, y luego dentro de eso, tengo comillas dobles para el ID y la clase de eso. No podría usar comillas dobles aquí y luego poner comillas dobles dentro, así que es por eso que estoy usando comillas simples porque es mejor usar comillas dobles en tu CSS. 

Sangría

Ahora, veamos la sangría. Y continuemos mirando el archivo functions.php, que es un buen ejemplo porque he sangrado varias líneas de código dentro de él.. 

Puede ver que el nombre de la función está a la izquierda, y luego dentro de ese register_sidebar La función está sangrada en un nivel. Y los contenidos de eso están sangrados de nuevo.. 

Así que cada vez que coloques contenido entre llaves o llaves, todo lo que esté dentro debe estar sangrado. Y también para la sangría, debe usar saltos de línea. 

Así que echemos un vistazo a otro archivo donde hay líneas simples y dobles.. 

Así que aquí puedes ver que tengo un Si declaración que tiene dos líneas de código dentro de ella. Así que he puesto un salto de línea arriba y debajo de esas dos líneas de código.

Si solo hubiera una línea de código dentro de eso, no tendría que poner esos espacios de línea, simplemente lo pondría dentro de mis llaves. 

El uso de espacios como este ayuda a aclarar dónde se encuentran los bloques de código. Y también se puede ver que se ha utilizado la sangría. Así que hay múltiples capas de sangría.. 

La otra cosa que debe tener en cuenta es dónde abre y cierra su etiqueta PHP y si está en la misma línea que su código o en una línea diferente. Y eso también depende de si está codificando un bloque de código o una sola línea.

Donde tienes un bloque de código, pones tu etiqueta de apertura en una línea y tu etiqueta de cierre en otra línea. Eso ayuda a que sea obvio que es un bloque de PHP y que todo dentro de esas etiquetas es PHP.

La otra cosa que debes hacer es asegurarte de usar una etiqueta PHP de apertura completa. Así que no solo use un signo de interrogación, como podría haber hecho en otros sistemas que usan PHP, porque en WordPress tiene que usar la etiqueta completa de PHP. 

Si escribiera algo de PHP que estuviera solo en una línea, pondría las etiquetas de apertura y cierre de PHP en la misma línea.

Puedes ver que tenemos algo de PHP que está todo en una línea, y después de eso tengo HTML. Así que las etiquetas de apertura y cierre van en la misma línea que mi código. 

Conclusión

Esa es una introducción a algunos de los elementos de los estándares de codificación PHP de WordPress, y les he mostrado algunos ejemplos de ellos en mis archivos y he cambiado algunos a medida que avanzo para mostrarle cómo se hacen las cosas correctamente.. 

Si desea saber más sobre los estándares de codificación, hay documentación en el sitio web de WordPress. Y también puede consultar esta serie Envato Tuts +, que incluye todos los elementos de los estándares de codificación en detalle..

Ver el curso completo

En el curso completo, Aprenda PHP para WordPress, aprenderá todo sobre PHP, el lenguaje de programación en el que está integrado WordPress.  

Le daré una descripción general de qué es PHP y cómo se usa para los temas y complementos de WordPress, con ejemplos. Seguirá aprendiendo cómo crear un archivo PHP y usarlo para generar HTML. Luego aprenderá a usar funciones, bucles y sentencias if para codificar temas y complementos personalizados de WordPress.

Puede tomar este curso de inmediato con una suscripción a Envato Elements. Por una única tarifa mensual baja, obtiene acceso no solo a este curso, sino también a nuestra creciente biblioteca de más de 1,000 cursos de video y libros electrónicos líderes en la industria en Envato Tuts+. 

Además, ahora obtiene descargas ilimitadas de la enorme biblioteca de Elementos Envato con más de 580,000 activos creativos. Cree con fuentes, fotos, gráficos y plantillas únicas, y entregue mejores proyectos más rápido.