Realización del desarrollo del arte de los complementos de WordPress

WordPress es el sistema de gestión de contenido más popular. Nos gusta no solo porque es fácil de usar, sino también porque es fácil de construir. Hemos construido más de 25 complementos en WordPress, que poseemos, y algunos otros para nuestros clientes. Nuestro enfoque para el desarrollo de complementos ha madurado a lo largo de los años. Para aquellos que comienzan con el desarrollo de complementos, el manual de complementos debe ser su Biblia de codificación. Enséñete “cómo” construir un complemento en WordPress. Contiene todo lo que necesita saber cuando cubre un complemento. Pero, por supuesto, más allá de la codificación, hay más.
Para que su complemento de WordPress sea fácil de usar, sin errores, que se pueden mantener, extensible, ¡hay algunos procesos que debe seguir! Estos incluyen el uso de un diseño adecuado, cumplimiento de las convenciones de codificación, optimización de código, pruebas, etc. Algunos de ustedes ya serán conscientes de ellos. Pero para aquellos que no son y buscan mejorar su proceso de desarrollo actual de arados, este artículo puede ser un excelente comienzo. Pocos de los elementos básicos mencionados aquí están presentes en el manual del desarrollador de complementos; Los otros: nos hemos acumulado a partir de nuestra experiencia de codificación a lo largo de los años.
Entonces, sin ninguna otra extensiones, manténgase en la espalda, active el modo Zen y lea.
Los estándares de codificación #1 no terminan en las convenciones de nombre no pueden enfatizar suficientemente la importancia de la codificación de los estándares durante el desarrollo de complementos o, además, ningún código. La razón por la cual las instrucciones van a seguir es simple, evitan errores estúpidos y hacen que el código sea fácil de mantener. Ya sea que cumpla con los estándares predefinidos o que tenga las pautas específicas de la empresa, aquí hay algunas convenciones que debe seguir: los convenciones de nombre de los convenciones están destinadas a hacer que el código sea legible, mantenido y seguro. Son necesarios para evitar confrontaciones con otros complementos. Debe agregar un prefijo para todas las funciones, clases, nombres de archivos y nombres para garantizar que no aparezcan problemas de compatibilidad. La estructura de la carpeta JS, CSS, archivos de administración, medios de comunicación, debe ser parte de su proceso. Diseño. Cuando trabaje en un proyecto, recuerde separar estos archivos incluso si es una solución de una página. Formateo del código Formateo El código debe ser una cuestión de curso. Si no, hay editores que ayudan. El formato del código lo hace legible. Al tratar de reducir los archivos JS, CSS y HTML, tendemos a eliminar espacios blancos y comentarios de código. Si bien esto puede ser necesario para archivos grandes, intente mantenerlo como mínimo.
La fecha de validación siempre valide los datos que se reciben o se envían. Comience por verificar el formato o diseñarlo al tipo de datos correcto. Desinfecte los valores de acuerdo con el tipo de datos que están fuera o ingresados. Según su escenario, también puede verificar los datos ingresados ​​en comparación con los valores de confianza.
Si no puede decidir sobre un estándar de codificación para adoptar o trabajar en un código que se agregará a la base, permanezca en los estándares de codificación de WordPress. En WISDMLABS, respetamos los estándares de codificación de PSR-2. Recuerde que el cumplimiento de las convenciones de codificación debería ser cómo codificó y no un paso adicional.
# 2 Hacer el código modular La programación modular es el proceso de subdividir un programa de computadora en subprogramas separados. -Se prefiere la tehopedia para facilitar el desarrollo de aplicaciones a gran escala, programación orientada a objetos. Haga el software modular dividiéndolo en piezas más pequeñas. Hace que el código se mantenga, porque las pruebas de cambios y remedios pueden limitarse a un módulo y no deben afectar todo el sistema. #2.1 Use patrones de diseño (si es necesario)
Fuente de la imagen: Pinterest
¡Los modelos de diseño son geniales! Son realmente.

Simplifican el proceso de desarrollo y hacen su código. Según el problema en cuestión, debe diseñar un modelo que se ajuste. Por ejemplo, la fábrica abstracta, el observador, el método de plantilla, el MVC se utilizan popularmente. Ahora, estoy de acuerdo en que no todos los complementos pueden necesitar que implemente un modelo de diseño. Pero los complementos con grandes cantidades de código necesitan un diseño adecuado.
El código de diseño escalable no. 3 Su complemento crecerá. La funcionalidad mejorará, la base de los usuarios aumentará. Al diseñar un complemento, debe planificar el código por el momento y las características que implementará en el futuro.
Optimizar sus interrogatorios en las consultas de la base de datos de la base de datos son caras. Cuando realice una operación que toma datos de la base de datos, intente obtener la mayor cantidad de información posible utilizando un número mínimo de consultas. Con la consulta y las tablas de la base de datos más optimizadas, más su aplicación se debe a que puede administrar muchos datos. Puede tener su propia estructura de archivo para mantener los archivos de complemento. Pero la comunicación con la base de datos siempre debe ser suave y optimizada … dependiendo de cuán escalable sea su aplicación, debe decidir si utilizar un complemento independiente o una arquitectura adicional.
– Sumit Pore, sobre la arquitectura de un complemento. (Lea la entrevista completa aquí)
Cree una arquitectura de base de datos escalable para suponer que su complemento debe guardar valores en la base de datos. En tal escenario, siempre existe la pregunta de si usar tablas de WordPress o crear sus propias tablas. Si se deben guardar algunas opciones o si se debe guardar el meta, puede considerar usar tablas de WordPress. Pero si se deben guardar más valores interconectados, entonces debe pensar en construir su propia tabla (o tablas).
Limite el uso de operaciones costosas similares a la consulta de la base de datos, varias otras operaciones son costosas y pueden afectar el rendimiento de su complemento y, de hecho, al sitio web al que se agregará. Por ejemplo, cuando tiene que conectarse a servidores remotos, almacenar datos grandes, cargar archivos grandes. En este caso, optimice el uso de estas operaciones para mejorar el rendimiento general del sistema.#4 No hay código “demasiado seguro”. Todos sabemos eso. La seguridad es una preocupación seria. Cuando construya su complemento de WordPress, asegúrese de ocuparse de las medidas de seguridad. Algunos de estos son:
Verifique las capacidades de usuario al mostrar/guardar configuraciones
Uso de Nonce Check para enviar formularios
Desinfectar las entradas antes de realizar la consulta en la base de datos
Escape correcto de salida para evitar ataques de scripts de sitios cruzados (XSS).
Evite el acceso directo a los archivos de complemento verificando la existencia de Abspath constante
Prevención de la lista directa de archivos del director de su complemento, agregando un archivo vacío “index.php” al archivo principal del complemento (y en cada subdirector)
Siempre considere los factores de seguridad al escribir consultas en la base de datos. Por ejemplo, debe asegurarse de que sus interrogatorios SQL sean inyección … use Nonce para enviar formularios para evitar scripts entre sitios … Todas las entradas deben desinfectarse y el resultado debe ser asegurado por el escape de los datos del usuario.
– Praveen Chauhan, cuando se le preguntó sobre las prácticas de codificación (aquí está la entrevista completa de Praveen)#5 ningún código es 100% sin errores
Fuente de la imagen: Google
La prueba de código es tan importante como su construcción. Honestamente, no tiene sentido atormentar cientos de horas para construir un complemento que tenga errores. Hará daño a los usuarios y afectará su marca. Para la funcionalidad simple, las pruebas manuales o de usuario pueden ser suficientes. Un complemento complejo requiere más. Puede agregar pruebas unitarias, pruebas de estrés, prueba de integración, prueba de aceptación, etc. en su proceso. Los controles simples incluyen:
Verificación de advertencias y errores, en la solución de problemas (puede usar un complemento como la barra de depuración para grabar información)

Use complementos como Consuly Monitor y P3 para probar consultas lentas/solicitudes HTTP y rendimiento de arado
#5.1 Revisión del código Ayuda Ver trabajo con revisiones de COD es que puede ver el código a través de la mente de un colega desarrollador. Además de identificar errores, nuevas ideas, técnicas de optimización podrían aparecer. Agregue revisiones de código al proceso de desarrollo si tiene la libertad de hacerlo.

# 6 Haga la contribución al código amigable ahora, la mayoría de nosotros creamos el código teniendo en cuenta el usuario final. Pero los desarrolladores trabajarán con su complemento y existe la posibilidad de que quieran confiar en él. Fomentar la contribución haciendo el código extensible: agregue acciones y filtros personalizados en el código del complemento. Con los ganchos necesarios, es fácil para los desarrolladores expandir su código y simplifica la personalización de la funcionalidad para ciertos usuarios o la construcción de suplementos. ¡Todo esto sin tocar el núcleo! Piense en los tiempos en que trabajó con otros complementos y le resultó más fácil personalizar cuando había un gancho apropiado. Hooks personalizados = Código extensible = Buen desarrollo #6.1 Prepara un complemento y ubicación multisitio Para aumentar la base de su usuarios, asegúrese de seguir técnicas de codificación simples para que su código de complemento sea compatible con múltiples sitios (bueno, al menos sin errores cuando se instala en varios sitios) y listo para ubicar.
#7 Mentenabilidad recibe sobre la optimización El mantenimiento del complemento no solo se refiere a la remediación de errores, sino que es a la provisión de actualizaciones y la optimización del código. La optimización es buena. Está. La apoyo. Pero a veces los desarrolladores tienden a exagerar con la optimización del código. Recuerde, el mantra es, optimizar el código, no complicarlo. Si estuviera en una situación en la que debería elegir entre el código de escritura que pueda mantenerse u optimizar, elegiría el anterior. Eso es porque trabajamos en equipo. Cuando eres parte de un equipo, más de una persona puede trabajar en el complemento. No desea quedarse y explicar el código de diferentes personas todo el tiempo. No podía recordar el código que escribió hace unos meses. – Hugh Lashbrooke, sobre las prácticas de codificación a seguir
#7.1 Gestión de actualizaciones importantes Recientemente, reescribí completamente todo el complemento Edwiser Bridge. Cuando queríamos lanzar la actualización, nos dimos cuenta de que teníamos que agregar una “notificación de actualización” a los usuarios existentes, solo para estar en el lado más seguro. Pero nuevamente, esto solo podría ser posible si hemos admitido soporte para una notificación de advertencia en la versión actual del complemento. ¡Yo no tenía! Lección aprendida: ¡agregue el soporte de notificaciones de actualización! (## Notificación de actualización ## en archivos ReadMe)
La siguiente tarea fue sobre la eliminación segura del código heredado. Marcar las opciones/código depreciado es una forma de asegurarse de que los usuarios/desarrolladores vayan a nuevas configuraciones/ganchos. Pero no hay una regla general sobre el momento para deshacerse por completo del código que ya no se acepta. Debe asegurarse de que el menor número de usuarios se vea afectado cuando el código está volviendo a hacer. Documentación#8. Documentación. Documentación.
Lo principal es documentar su código tanto para su beneficio como para otros desarrolladores que miran su código durante un año, no recordará lo que debería haber hecho un poco de código: usted escribe, pero si está bien documentado, su futuro yo le agradecerá ! – Carrie Dils, sobre las prácticas de codificación.
Su complemento no está listo hasta que lo documente. Y créeme, ninguna cantidad de documentos es suficiente. Así que ve por completo; Cree una guía del usuario, agregue preguntas frecuentes, cree videos, ayude a los usuarios de cualquier manera que pueda. Pero al menos, cree un archivo ReadMe.txt.
# 9 Usando la inteligencia para mejorar bien sus opciones, siempre puede llevar las cosas un paso más y mejorar su complemento con los datos que recibe de los usuarios. Descubra cómo los usuarios interactúan con la configuración, qué opciones no se utilizan; Envíe formularios de comentarios para obtener información sobre las funciones que los usuarios esperan y no solo
Ingredientes secretos para un excelente complemento
Una interfaz de usuario que se ajusta naturalmente al tablero de WordPress

Una experiencia intuitiva y eso requiere poco para aprender la validación, validación y seguridad adecuadas de los datos que administran
Instala y se limpia correctamente después de la instalación y desinstalación
Resuelve un problema que el usuario final da la bienvenida con su sitio web basado en WordPress.
– Tom McFarlin, sobre los ingredientes para un gran complemento.
Recuerde, este artículo no es una guía para el proceso de desarrollo de complementos.Su objetivo es ayudarlo a mejorar su proceso de desarrollo.Entonces, en beneficio de los lectores, está invitado a unirse a mí y contribuir a esta lista