La Dashboard Widgets API

La Dashboard Widgets API hace muy fácil gestionar los widgets del tablero de administración de inicio del back-end de WordPress. Para hacerlo, necesitaremos conocimientos de PHP y de la Plugin API de WordPress, pero los desarrolladores de plugins o temas, familiarizados con los ganchos de acciones y filtros, sólo precisarán unos pocos minutos para su comprensión y será una gran manera de hacer sus plugins más útiles.

El hook de la Dashboard Widgets API

Para ejecutar tu script, necesitas enganchar en la acción wp_dashboard_setup a través de add_action(). En el caso de utilizar un WordPress multi-usuario, deberás utilizar el hook  wp_network_dashboard_setup.

Las funciones de la Dashboard Widgets API

wp_add_dashboard_widget

Emplearemos esta función para añadir nuevos widgets a nuestro panel inicial de administración del back-end de WordPress. Encontraréis más información de esta función clicando en este enlace.

El identificador del widget servirá para generar una clase CSS con la que podremos formatear nuestro widget.

Ejemplo

Vamos a ver un ejemplo de cómo se emplea esta función

remove_meta_box

Si queremos aclarar nuestro dashboard de widgets que no nos resultan útiles, emplearemos la función remove_meta_box(). Para más información sobre esta función, clica en este enlace al corex de WordPress.

La página variará según dónde deseemos eliminar el meta box, pero en el caso que nos incumbe ahora, es ‘dashboard’.

El contexto es el lugar en el que se encuentra dentro de la página.

¿Cómo sabemos el $id_meta_box? Fácil, desde el mismo explorador, clicamos encima con el botón derecho del ratón y en ‘Inspeccionar’:

Notas

En cuanto a qué hook debemos utilizar para eliminar los meta boxes, dependerá en función de la página en la que se encuentren. Además, para que surja efecto la función, el meta box debe estar previamente creado. Así, en el dashboard las hooks más probables son wp_dashboard_setupadmin_init.

Ejemplo

Este ejemplo está sacado directamente del codex de WordPress y resulta interesante, ya que nos dejará el dashboard totalmente en blanco.

 

Mover nuestro dashboard widget arriba

El siguiente es un truco para conseguir ubicar nuestro widget por encima del resto de widgets del dashboard. Para ello, modificaremos manualmente la matriz de los metaboxes del dashboard.

Algo similar podemos utilizar si queremos colocar el widget a la derecha del dashboard, ya que por defecto WordPress lo colocará en posición ‘normal’:

Finalmente, si queremos modificar los parámetros de los widgets, deberemos utilizar get_option(‘dashboard_widget_options’). Encontraréis más información, y funciones para la modificación de dichos parámetros, en el codex de WordPress.

 

Ejemplo

Para hacer el ejemplo de este artículo, vamos a compilarlo todo en un plugin. Al ejecutar el plugin, conseguiremos un resultado muy similar al de la imagen de cabecera de este artículo.

Si queréis saber más acerca de la programación de plugins, encontraréis mis artículos del Manual de Plugins WP.

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.