Crear un Widget para el dashboard de WordPress

[ 24 agosto 2016 ] [ Autor: Jhon Marreros Guzmán ] [ Plugins - Avanzado] [ ]

¿Te has preguntado cómo hacer para mostrar información en el tablero de inicio o dashboard de WordPress?, en este artículo te explico cómo realizarlo de manera sencilla, creando un Widget para el dashboard de WordPress.

1- Creamos el Plugin

De antemano debemos tener un plugin creado, este plugin tendrá la funcionalidad de Widget para el Dashboard. En el siguiente código se muestra un ejemplo de metadata para nuestro plugin:


/*
Plugin Name: Mi Dashboard Widget
Plugin URI: https://decodecms.com
Description: Ejemplo para mostrar un dashboard Widget
Version: 1.0
Author: Jhon Marreros Guzmán
Author https://decodecms.com
License: GPLv2 or later
*/

Este código lo colocaremos en un archivo dentro de la carpeta plugins de nuestro WordPress, no olvidar activar el plugin.

2- Mostar contenido en el Widget

Luego de tener un plugin activo, entonces empezaremos a codificar, para esto usaremos el siguiente código:


//Accion Hook
add_action('wp_dashboard_setup','dcms_agregar_widget');

//Agregar Widget
function dcms_agregar_widget(){
	wp_add_dashboard_widget('id_mi_widget','Mi Widget de Ejemplo','dcms_mostrar_widget');
}

//Mostrar Widget
function dcms_mostrar_widget(){
	echo "Hola desde mi nuevo Widget";
}

En el código anterior:

Definimos el Action Hook, en este caso será wp_dashboard_setup y la función de entrada.
La función de entrada dcms_agregar_widget usa la función de WordPress wp_add_dashboard_widget
En la función wp_add_dashboard_widget estamos usando los primeros tres parámetros, el ID, el título y el nombre de la función usada para mostrar contenido.
La función para mostrar contenido es dcms_mostrar_widget y en esta función se mostrará el contenido del Widget.

Con el código anterior aplicado, si nos dirigimos a la pantalla de inicio del dashboard de WordPress veremos algo similar a la siguiente imagen:

3- Opción de Configuración en el Widget

Para usar la opción de configuración para el Widget del dashboard de WordPress, necesitamos definir un parámetro adicional a la función wp_add_dashboard_widget, en el siguiente código se muestra la modificación a la función y la función agregada



//Agregar Widget Modificado
function dcms_agregar_widget(){
	wp_add_dashboard_widget('id_mi_widget','Mi Widget de Ejemplo','dcms_mostrar_widget','dcms_configurar_widget');
}


//Configurar Widget
function dcms_configurar_widget()
{

	if ( isset($_POST['dcms_texto']) )
	{
		$dcms_texto = $_POST['dcms_texto'];
		update_option('dcms_text_bd', $dcms_texto); 
	}

	$dcms_texto = get_option('dcms_text_bd');

?> 
<label> Ingrese texto : 
<input type="text" name="dcms_texto" id="dcms_texto" value="<? echo $dcms_texto; ?>" /> 
</label> <?php
}

En el código anterior:

Se agregó el parámetro adicional, la función dcms_configurar_widget.
La función dcms_configurar_widget permite almacenar un valor dentro de un campo de texto.
Para almacenar y recuperar el valor en la base de datos se usan las funciones de WordPress update_option y get_option, respectivamente.

Aplicando el código anterior veremos el siguiente Widget con su pantalla de configuración:

4- Conclusión

Siguiendo las pautas indicadas anteriormente hemos visto cómo realizar un Widget para el Dashboard de WordPress que puede servir de base para utilizar nuestro propio contenido, ya sea contenido estático o contenido externo proporcionado por alguna API.
El código completo del plugin se puede descargar desde: Widget base dashboard WordPress

¿Aún con dudas?, en el siguiente vídeo se detalla cada uno de los puntos anteriores.