Una guía sobre cómo mejorar los estándares de codificación de WordPress
Si eres un desarrollador, definitivamente estás buscando mejorar tus estándares de codificación. Cada lenguaje de programación y su CMS / Frameworks ha establecido sus propios estándares de codificación. En este artículo, estudiamos cómo mejorar los estándares de codificación de WordPress.
Hemos escrito un artículo sobre cómo mejorar los estándares de codificación PHP. Primero debe consultar este artículo antes de continuar con los estándares de codificación para el desarrollo de WordPress.
Errores que cometemos durante la programación de WordPress
Cada trabajo de desarrollo tiene diferentes soluciones. Probablemente cada desarrollador implemente una forma / lógica diferente para dar el mismo resultado. Es natural en el mundo de la programación.
Por ejemplo, digamos que hemos agregado nonce en nuestro formulario de registro para evitar ataques CSRF.
<form method="post">
<?php wp_nonce_field( 'signup_nonce', 'signup_form_nonce' ); ?>
</form>Al enviar un formulario, tenemos que verificar si nonce es correcto o no. Normalmente, un desarrollador que no conoce los estándares de codificación lo hace de la siguiente manera.
<?php
if (! isset( $_POST['signup_form_nonce']) ||! wp_verify_nonce( $_POST['signup_form_nonce'], 'signup_nonce')) {
print 'Sorry, your nonce did not verify.';
exit;
} else {
// process form data
}
?>No hay nada de malo en el código anterior. Pero no es una buena práctica. Al recuperar valores de campo de texto, debemos usar sanitize_text_field()y wp_unslash()funciones en los valores de campo de entrada.
El método sanitize_text_field realiza el siguiente proceso en segundo plano.
- Comprueba si UTF-8 no es válido
- Convierte caracteres <únicos en una entidad
- Elimina todas las etiquetas
- Elimina los saltos de línea, las pestañas y los espacios en blanco adicionales
- Tira de octetos
El método wp_unsplash elimina las barras inclinadas de una cadena o matriz de cadenas.
Habiendo dicho eso, nuestro código anterior debería gustar a continuación.
<?php
if (! isset( $_POST['signup_form_nonce']) ||! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['signup_form_nonce']) ), 'signup_nonce')) {
print 'Sorry, your nonce did not verify.';
exit;
} else {
// process form data
}
?>Este es un ejemplo. Hay varios otros errores que estamos cometiendo en nuestra programación de WordPress.
Instalar la biblioteca de estándares de codificación de WordPress
Esta biblioteca nos ayudará a mejorar nuestros estándares de codificación en el desarrollo de WordPress y nos establecerá como un mejor desarrollador de WordPress.
Para instalar esta biblioteca, abra el símbolo del sistema en el directorio raíz de un proyecto y ejecute el siguiente comando.
composer create-project wp-coding-standards/wpcs --no-dev
Nota: Debe tener Composer instalado en su sistema para ejecutar el comando anterior.
Después de ejecutar el comando, creará una carpeta llamada ‘wpcs’ en el directorio raíz de un proyecto.
Suponemos que ha leído nuestro artículo sobre cómo mejorar los estándares de codificación PHP y ha instalado la biblioteca PHP_CodeSniffer dentro de la carpeta ‘php_codesniffer’ en el directorio raíz del proyecto.
A continuación, necesitamos registrar los estándares de WordPress en la configuración de PHP_CodeSniffer. Abra el símbolo del sistema en ‘php_codesniffer / vendor / bin’ y ejecute el siguiente comando.
phpcs --config-set installed_paths /path/to/wpcs
Reemplace ‘/ ruta / a / wpcs’ con su ruta. En nuestro caso, en la plataforma Windows, escribimos el comando de la siguiente manera.
phpcs --config-set installed_paths D:wampwwwwp1wpcs
Descubramos nuestros errores y mejoremos los estándares de codificación de WordPress
Nos hemos puesto con nuestra biblioteca. Ahora es el momento de encontrar nuestros errores y evitarlos la próxima vez.
Digamos que hemos creado un complemento ‘test-plugin’ y tenemos que validar un archivo llamado ‘core.php’.
Abra el símbolo del sistema en el directorio ‘wpcs / vendor / bin’ y ejecute el siguiente comando.
phpcs --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
Después de ejecutar el comando, se le indicarán los errores y advertencias. Todos estos errores y advertencias se muestran porque no hemos seguido las prácticas de codificación estándar para el desarrollo de WordPress.
Una buena parte es que obtenemos el informe detallado sobre los números de línea y cómo corregir ese error específico. Solo necesitamos mirar las pautas y corregir los errores uno por uno.
phpcbf El comando también puede corregir algunos errores menores como sangría, espacios, etc.
phpcbf --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
Esperamos que comprenda cómo usar la biblioteca de estándares de codificación de WordPress para mejorar los estándares de codificación de WordPress. Si tiene alguna pregunta o sugerencia, deje un comentario a continuación.