Un buen desarrollo de plugins en WordPress requiere seguir una serie de buenas prácticas para hacer nuestro trabajo más profesional y eficaz.
Nombre del plugin
Es recomendable que el nombre del plugin tenga relación con la funcionalidad que va a realizar. No es de recibo llamar a un plugin Jesús Plugin que haga tareas de SEO. Cuando el usuario busca plugins lo primero que ve es el nombre y si este no le dice nada pues no lo descargará. También hay que intentar que el nombre de tu plugin sea único. Si desarrollas un plugin para pagos contra reembolso para WooCommerce sería recomendable que te des una vuelta por el directorio de plugins y veas los que hacen esa tarea. Intenta no confundir a tus posibles clientes con nombres como: Pago Contrareembolso WooCommerce. Un buen nombre podría ser por ejemplo: Garber ContraReembolso WC.
Usar una carpeta
Un plugin puede ser un único archivo con todo el código. Esto no es una buena práctica de programación. Crea tu plugin dentro de una carpeta, con su nombre único y ahí irán bien organizados todos los archivos, imágenes, etc que necesite tu plugin.
Prefijo a todo
Es muy recomendable poner un prefijo a todo. A las funciones y las variables que utilices, todo lo que hay en tu plugin. Esto evita que se llamen dos funciones iguales. Es decir, si tenemos una función que sirva para enviar un email a un cliente, un posible nombre para esta podría ser: email_cliente() pero es tan genérico que otro desarrollador podría utilizarlo en sus plugins y no pueden haber dos funciones en php con el mismo nombre. Una forma de evitarlo es poniendo un prefijo a tu función para hacerla única. Puedes utilizar tus iniciales, las iniciales de tu plugin, etc. En nuestro plugin Garber ContraReembolso WC podría ser --> gcwc_email_cliente()
Organización de Archivos
Tus archivos y carpetas tienen que tener una organización profesional. Por eso, en la carpeta raíz de tu plugin solamente debería estar el primer archivo PHP del plugin y el uninstall.php. Todo lo demás en carpetas como se describe a continuación.
Estructura de Carpetas
Un plugin puede ser mayor o menor, pero casi siempre necesitará varios archivos, css, JavaScript, etc. Una buena organización de carpetas para tu plugin podría ser:
/garber_contrareembolsoWC
garber_contrareembolsoWC.php
uninstall.php
/js --> carpeta para los ficheros JavaScript
/css --> aquí guarda tus css
/includes --> otros archivos php
/images --> si necesita imágenes tu plugin van aquí.
...
Assets
Crea carpetas assets y dentro de esta las carpetas css con los archivos de estilo y la carpeta js, con sus correspondientes archivos. También es recomendable crear la carpeta languages para los idiomas, templates para las plantillas que puedas crear, etc. La idea es tener todo bien organizado y fácil de acceder. Recuerda que otros programadores pueden necesitar tu código algún día, facilítales la tarea y demuestra que eres un buen programador. Teniendo una buena estructura de carpetas, ahorrarás tiempo a la hora de programar, de entender tu código y cuando tengas que volver a él meses después, verás que tener una buena organización te ayudará.
