aNieto2K Desarrollo web, Wordpress, y alguna cosilla más

Para ser un buen desarrollador de plugins para Wordpress debemos mejorar algunos de nuestros puntos de interacción con el usuario. Para ello Wordpress nos ofrece una serie de opciones para mejorar la información relacionada con el plugin que hemos desarrollado.

plugin_action_links

Se trata de un filtro que se aplicara siempre que entremos en la página de gestión de plugins. En él podemos modificar la salida de links que el plugin nos ofrece:

(Ver Imagen)

Estos links pueden, por ejemplo, llevarnos directamente a la página de configuración del plugin. Un valor añadido que hará que el plugin gane un poco de calidad.

<?php
// Asociamos la función add_plugin_links() al filtro
add_filter('plugin_action_links', 'add_plugin_links', 10, 2);

// Declaramos la función
function add_plugin_links($links, $file) {
	// Marcamos el plugin actual
	static $this_plugin;
	if (!$this_plugin) $this_plugin = plugin_basename(__FILE__);

		// Comprobamos que el plugin que estamos mostrando por pantalla es el nuestro.
		if ($file == $this_plugin ){

		// Definimos el enlace a "Configuración"
		$settings_link = '<a href="index.php">Configuración</a>';

		// Añadimos el nuevo link a los ya existentes
		array_unshift($links, $settings_link);
	}
	// Devolvemos los links
	return $links;
}
?>

after_plugin_row

Otra forma de ofrecer más información al usuario es informar de que existe una actualización pendiente para el plugin. Para ello podemos mostrar un mensaje en la parte inferior del plugin y así se verá claramente la actualización:

(Ver Imagen)

Esto hará que el usuario sea consciente del cambio de versión que está disponible en cada momento. Para ello Wordpres nos ofrece la posibilidad de comprobar un fichero alojado en nuestro servidor que indicará la versión y la contrastará con la instalada (siempre y cuando el servidor permita este tipo de peticiones).

<?php
// Asociamos add_plugin_row() al action.
add_action('after_plugin_row', 'add_plugin_row', 10, 2);

// Declaramos la función
function add_plugin_row($links, $file) {
	global $wp_version;
	// Marcamos el plugin actual
	static $this_plugin;
	if (!$this_plugin) $this_plugin = plugin_basename(__FILE__);

	// Comprobamos que el plugin que estamos mostrando por pantalla es el nuestro.
	if ($file == $this_plugin ){
		// ¿Está disponible la actualización de plugins?
		$current = get_option('update_plugins');
		if (!isset($current->response[$file])) return false;

		// Controlamos el número de columnas disponibles dependiendo de la versión.
		$columns = substr($wp_version, 0, 3) == "2.8" ? 3 : 5;

		// Definimos la ruta de nuestro fichero de información.
		$url = "http://www.yoursite.com/info.txt";

		// Lanzamos la consulta externa.
		$update = wp_remote_fopen($url);

		// Pintamos el mensaje de alerta.
		echo '<td colspan="'.$columns.'">';
		echo $update;
		echo '</td>';
	}
}

Minimizando

Apartir de Wordpress 2.7 disponemos de 2 posibilidades más:

<?php
// Nombre del plugin
$plugin_name = "miplugin";

// Filtros específicos para cada plugin
add_filter("plugin_action_links_$plugin_name", "....");
add_action("after_plugin_row_$plugin_name", "....");
?>

Enviar un mail en texto con PHP es tan sencillo como usar la función mail(), que únicamente puede ocuparnos una línea de texto como esta:

mail($to, $asunto, $body, $headers);

Resalto los $headers por que son la clave para permitirnos enviar un email en HTML. En ellos indicaremos los datos que los lectores de correo deberán tener en cuenta para distinguir entre un simple email de texto y uno de HTML.

$headers = "From: " . strip_tags($from) . "\r\n";
$headers .= "Reply-To: ". strip_tags($to) . "\r\n";
$headers .= "CC: CON COPIA\r\n";
$headers .= "MIME-Version: 1.0\r\n";
$headers .= "Content-Type: text/html; charset=ISO-8859-1\r\n";

Como podemos ver en el código en negrita estamos indican que el Content-type del email es un text/html y con la codificación ISO-8859-1, además de permitir añadir un emails en copia o incluso en copia oculta.

Esto nos permitirá usar un HTML bastante limitado, pero en fin HTML para hacer nuestros emails algo más elegantes y más ordenados. Nuestro $body ya podrá contener dichos tags.

$body = '<strong>Texto en negrita</strong> este no lo es  ';

La mágia es que podemos seguir usando la misma función mail() para enviar nuestro email.
Via

Hace unas semanas conocimos la noticia de Google Analytics había publicado su API pública para permitir que usáramos nuestros datos almacenados en sus servidores en nuestras aplicaciones. Si estás interesado en ella y además el lenguaje de programación que quieres usar es PHP esta class hará tu vida más fácil.

<?php
// include the Google Analytics PHP class
include "googleanalytics.class.php";

// create an instance of the GoogleAnalytics class using your own Google {email} and {password}
$ga = new GoogleAnalytics('{email}','{password}');

// set the Google Analytics profile you want to access - format is 'ga:123456';
$ga->setProfile('{GA Profile ID}');

// set the date range we want for the report - format is YYYY-MM-DD
$ga->setDateRange('2009-04-01','2009-04-07');

// get the report for date and country filtered by Australia, showing pageviews and visits
$report = $ga->getReport(
	array('dimensions'=>urlencode('ga:date,ga:country'),
		'metrics'=>urlencode('ga:pageviews,ga:visits'),
		'filters'=>urlencode('ga:country=@Australia'),
		'sort'=>'-ga:pageviews'
		)
	);

//print out the $report array
print_r($report);
?>

Modo de empleo

Como vemos en el código, además de llamar a la class al inicio del fichero declaramos una nueva instancia del objeto GoogleAnalytics, al que le pasamos los parámetros de email y password, los que usamos para hacer login en Google Analytics. Despues indicamos el perfil del que queremos obtener datos. Este perfil lo podemos obtener de la misma página de Google Analytics. Simplemente hace referencia al ID asociado a la página web que vemos en el menú, en la URL podemos encontrarlo fácilmente.

(Ver Imagen)

El formato requerido es el siguiente: ga:XXXXXX donde XXXXXX es el id que vemos arriba en la imagen.

Ya solo nos queda indicar un rango de fechas en formato YYYY-MM-DD y lanzar la petición de lo que queremos solicitar.

$report = $ga->getReport(
	array('dimensions'=>urlencode('ga:date,ga:country'),
		'metrics'=>urlencode('ga:pageviews,ga:visits'),
		'filters'=>urlencode('ga:country=@Australia'),
		'sort'=>'-ga:pageviews'
		)
	);

El resultado lo recibimos como un array con los datos solicitados.

Array
(
    [20090406~~Australia] => Array
        (
            [ga:pageviews] => 11
            [ga:visits] => 9
        )

    [20090401~~Australia] => Array
        (
            [ga:pageviews] => 8
            [ga:visits] => 6
        )

    [20090402~~Australia] => Array
        (
            [ga:pageviews] => 8
            [ga:visits] => 4
        )

    [20090405~~Australia] => Array
        (
            [ga:pageviews] => 4
            [ga:visits] => 2
        )

    [20090407~~Australia] => Array
        (
            [ga:pageviews] => 4
            [ga:visits] => 2
        )

    [20090403~~Australia] => Array
        (
            [ga:pageviews] => 2
            [ga:visits] => 2
        )

)

¿Estás pensando en añadir una funcionalidad a Wordpress y no sabes por donde empezar a extenderlo? ¿te gustaría hacer las tareas más comunes de tu día a día con el blog sean más fáciles? Pues solo necesitas conocer, como actuar frente a esta pregunta.

¿Como y donde puedo extender Wordpress?

Wordpress, por defecto, nos presenta 3 formas de extender las funcionalidades de Wordpress:

1. Mediante actions.
2. Mediante filters.
3. Mediante declaración de funciones.

Todas ellas sin necesidad de tocar el código propio del núcleo de Wordpress, evitando así tener que hacer modificaciones cada vez que actualicemos nuestro Wordpres.

Extender Wordpress mediante Actions

Uno de los métodos que podemos usar y que están disponibles el la API de Wordpress es el uso de actions. Como su nombre indica, actions son las acciones definidas por el equipo de Wordpress en las que podremos añadir nuestras propias funcionalidades.

<?php add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1); ?>

Esta función que tanto hemos visto en plugins o código que hemos mostrado para extender Wordpress, hace una función muy importante y cada parámetro aporta un grado más de personalización.

• $tag: Nombre del action (ahora los veremos).
• $function_to_add: Nombre de la función que ejecutaremos al activarse el action ($tag).
• $priority: Prioridad de ejecución, de menor a mayor.
• $accepted_args: Aceptamos (o no) el paso de parámetros a nuestra función.

Ejemplo:

<?php
define("TWITTER_USER", 'username');
define("TWITTER_PASS", 'password');
define("TWITTER_MESSAGE", '[Post] %name%: %link% <-- %title%');

function update_twitter($post_ID = '')  {
	$curl_handle = curl_init();

	// Nombre del blog
	$message = str_replace("%name%", get_bloginfo('name'), TWITTER_MESSAGE);

	// Cargamos el post
	$post = get_post($post_ID);

	// Enlace y título
	$message = str_replace("%link%", $post->guid, $message);
	$message = str_replace("%title%", $post->post_title, $message);

	// Enviamos el Tweet
	curl_setopt($curl_handle, CURLOPT_URL, 'http://twitter.com/statuses/update.xml');
	curl_setopt($curl_handle, CURLOPT_CONNECTTIMEOUT, 2);
	curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER, 1);
	curl_setopt($curl_handle, CURLOPT_POST, 1);
	curl_setopt($curl_handle, CURLOPT_POSTFIELDS, "status=$message";
	curl_setopt($curl_handle, CURLOPT_USERPWD, TWITTER_USER.":"TWITTER_PASS);
	$buffer = curl_exec($curl_handle);
	curl_close($curl_handle);
  return $post_ID;
}
// Añadimos funcionalidad a publish_post
add_action('wp_insert_post', 'update_twitter');
?>

No le hagais mucho caso al código, es ilustrativo y puede producir un funcionamiento erroneo en Wordpress

En este código, vemos lo sencillo que es añadir una funcionalidad a nuestro Wordpress. En este caso, estamos añadiendo al action wp_insert_post la función update_twitter(). En este caso, una vez hayamos pulsado el botón de publicar en nuestro Wordpress, este ejecutará la función update_twitter() y esta enviará a Twitter un aviso de un nuevo artículo.

¿Donde se extienden los actions?

Este ejemplo solo debe servir para hacernos una idea de como añadir funcionalidades a nuestro Wordpress, lo interesante es que debemos conocer los actions disponibles para extender nuestro Wordpress.

La API nos muestra un listado bastante detallado de los action disponibles. Pero si tenemos alguna duda lo mejor es siempre revisar el código.

En el fichero post.php del directorio wp-includes/ podemos encontrar en la línea 1534 la llamada do_action() que lanzará las acciones asociadas al nombre wp_insert_post.

[...]
	wp_transition_post_status($post_status, $previous_status, $post);

	if ( $update)
		do_action('edit_post', $post_ID, $post);

	do_action('save_post', $post_ID, $post);
	do_action('wp_insert_post', $post_ID, $post);

	return $post_ID;
}
[...]

do_action(), es la función encargada de lanzar el array de acciones asociadas a la key definida por el primer parámetro. En este caso wp_insert_post, lanzará nuestra función que recibirá por parámetro $post_ID que estamos pasando con el do_action(). Suplementaríamente estamos paando un segundo parámetro con $post, que contiene el objeto con los valores que componen el post que acabamos de insertar en la BD.

Revisando el código de Wordpress encontraremos una infinidad de do_action() que permiten extender Wordpress en casi todos los puntos en los que queramos añadir una nueva funcionalidad.

Mediante filters

Los filters, están mucho más extendidos por el núcleo de Wordpress. Como su nombre indica, sirven para filtrar variables que nos podemos encontrar en cualquier funcionalidad de Wordpress.

Al igual que los actions, podemos extender la funcionalidad de nuestro Wordpress en ellos.

Ejemplo

<?php
	function noShowIPs($IP = '') {
		// Mostramos solo los primeros 7 carácteres
		return substr($IP, 0, 7);
	}
	// Aplicamos el filtro
	add_filter('get_comment_author_IP', 'noShowIPs');
?>

En este pequeño ejemplo, indicamos que no queremos mostrar la IP completa del usuario que comenta en nuestro Wordpress cuando se usa la función get_comment_author_IP(). Mediante un substr() devolvemos los 7 primeros dígitos de $IP.

¿Donde se extienden los filters?

Al igual que los actions, los filters están en los ficheros que componen Wordpress. En el ejemplo que hemos montado previamente hemos hecho uso de get_comment_author_IP() que se encuentra en el fichero comment-template.php del directorio wp-includes/. Si nos dirigimos a la línea 173 veremos el siguiente código.

[...]
function get_comment_author_IP() {
	global $comment;
	return apply_filters('get_comment_author_IP', $comment->comment_author_IP);
}
[...]

apply_filters() es el do_action() de los filters, ya que se encarga de recorrer el array de filtros definidos para la key establecida y los va aplicando uno trás otro. En nuestro caso, recibimos la IP del comentarista para posteriormente devolver una IP recortada.

Mediante declaración de funciones

Esta forma, es quizas la más obvia, pero no por ello deja de ser potente.

En muchos casos, usamos plugins por que son más fáciles de instalar, pero bien bien, podrían ser sustituidos por funciones alojadas en ficheros concretos de Wordpress. Obtendríamos el mismo resultado.

Ejemplo

<?php
function ult_comments($cuantos = 5) {
    global $wpdb;
    $comentarios = $wpdb->get_results($wpdb->prepare("
                            SELECT  wc.comment_date, wc.comment_author, wp.post_title, wp.guid, wp.comment_count
                            FROM ".$wpdb->comments." as wc, ".$wpdb->posts." as wp
                            WHERE wc.comment_post_ID = wp.ID
                            AND  wc.comment_approved = '1'
                            AND wc.comment_type = ''
                            ORDER BY wc.comment_date DESC LIMIT 0,%d;",$cuantos ));
    foreach ($comentarios as $comentario) {
			echo '<li>
				<a href="'.$comentario->guid.'" title="'.$comentario->post_title.'">'.$comentario->post_title.'
				  <small>'.$comentario->comment_count.'</small>
                                </a>
        			<small>Por '.$comentario->comment_author.' hace '.since_date($comentario->comment_date).'</small>
                              </li>';
    }
}
?>

Uno de los puntos recomendados para alojar este tipo de funciones, es el fichero functions.php de nuestro theme. Todas las funciones definidas en él serán visibles desde nuestro themes, plugins, …

En este caso, definimos esta función que nos devolverá los últimos 5 comentarios del blog en el fichero functions.php. Una vez definida, podremos usarla en nuestro theme, donde más rábia nos dé, simplementa llamándola.

<ul>
<?php ult_comments(10); // 10 últimos comentarios ?>
</ul>

¿Que podemos hacer con todo esto?

Pues lo que queramos, podemos hacer que Wordpress se transforme a nuestra voluntad. Nos permite desde añadir funcionalidades que nos ayudan en el día a día, hasta cambiar el concepto de blog por el de CMS, Miniblog, …

Edito:

NUNCA SE DEBE TOCAR EL CÓDIGO DE WORDPRESS

Este artículo intenta mostrar las diferentes formas de extender Wordpress, sin necesidad de tocar los ficheros que componen el núcleo de Wordpress, osea la raíz y wp-includes/ y wp-admin/. Para poder extenderlo puedes hacer uso de los fichero functions.php de tu theme o generar un plugin con dichas funcionalidades dentro.

La limitación, está en nuestra cabeza

Wordpress está pensado para que uno o varios autores introduzcan entradas en él. Y despues los usuarios puedan comentar estas entradas, pero previamente estas deben estar introducidas sinó, el concepto Blog en sí, no tiene ningún sentido. Pero Wordpress va un poco más allá y nos permite hacer que el sistema de insercción de entradas no esté, necesariamente, vinculado al Wordpress.

Para ello, tenemos la función wp_insert_post(), una función a la que le pasaremos los parámetros que compondrán una entrada en nuestro Blog.

Los chicos de WPEngineer.com hacen un repaso a estos parámetros y nos muestran un sistema muy sencillo de realizar insercciones ajenas a nuestro Blog. Está claro que este sistema es peligroso, y que requiere que el usuario esté logueado para realizar la insercción.

wp_insert_post()

wp_insert_post($postarr = array())

Vemos que esta función recibe un parámetro, un array que estará compuesto con los parámetros necesarios para formar una entrada.

Los valores de este parámetro pueden ser:

<?php
$post = array(
  'comment_status' => [ 'closed' | 'open' ] // 'closed' no permite comentarios.
  'ID' => [ <post id> ] // únicamente si estamos actualizando un comentario.
  'menu_order' => [ <order> ] //Si es una nueva página, especifica el orden en el que debería aparecer
  'page_template => [ <template file> ] // Indica el template para la página.
  'ping_status' => [ ? ] // Activamos o desactivamos los pingbacks
  'pinged' => [ ? ] //?
  'post_author' => [ <user ID> ] //ID del usuario
  'post_category => [ array(<category id>, <...>) ] // Categorías del post.
  'post_content' => [ <the text of the post> ] // Contenido del post.
  'post_date' => [ Y-m-d H:i:s ] // Fecha de creación del post.
  'post_date_gmt' => [ Y-m-d H:i:s ] // Fecha de creación en GMT.
  'post_excerpt' => [ <an excerpt> ] // El resumen del post.
  'post_parent' => [ <post ID> ] // El post padre.
  'post_password' => [ ? ] // El password del post.
  'post_status' => [ 'draft' | 'publish' | 'pending' ] // Estado de la publicación
  'post_title' => [ <the title> ] // Título del post.
  'post_type' => [ 'post' | 'page' ] // Post o Página.
  'tags_input' => [ '<tag>, <tag>, <...>' ] // Tags asociados al post.
  'to_ping' => [ ? ] //?
);
// Insertamos el post
wp_insert_post( $post );
?>

Conociendo esto, ya podemos usar funcionalidades de Wordpress fuera de Wordpress.

// Incluimos las funcionalidades de Wordpress
require( '../my_wordpress_install_root/wp-load.php' );

// Creamos el array
$my_post = array();
$my_post['post_title']    = 'Mi post';
$my_post['post_content']  = 'This is my post.';
$my_post['post_status']   = 'publish';
$my_post['post_author']   = 1;
$my_post['post_category'] = array(0);

// Insertamos el post en la base de datos
wp_insert_post( $my_post );"

AyudaWordpress nos muestra un tutorial muy interesante para ocultar contenido a los usuario no registrados mediante el uso de ShortCodes.

Y es que con unas pocas líneas en Wordpress se pueden hacer cosas realmente útiles y potentes.

// Functions.php
add_shortcode( 'visitante', 'shortcode_para_visitantes' );
function shortcode_para_visitantes( $atts, $content = null ) {
if ( ( is_user_logged_in() && !is_null( $content ) ) || is_feed() )
return $content;
return 'Para ver este contenido, <a href="' . site_url('wp-login.php?action=register', 'login') . '">debes estár registrado</a>';
}

Una vez añadido a nuestro functions.php podremos usar [visitante][/visitante] para ocultar el contenido que queramos a los visitantes no registrados.

[visitante]
Aquí pones lo que te apetezca que quieras que vean solo los no registrados
[/visitante]

Más opciones en AyudaWordpress.

Anoche Oscar Barber me  muestra comentaWP. Un plugin para Wordpress, desarrollado por Miquel Laboria y Oriol Farré que nos permitirá informar en Twitter de los comentarios que se realizan en tu blog.

Instalación

La instalación es igual a la de todos los plugins de Wordpress, únicamente tendremos que realizar estos 3 pasos y podemos empezar a configurarlo.

1. Descargamos el plugin
2. Descomprimimos el ficheros y lo subimos a nuestro wordpress en la carpeta wp-content/plugins/
3. Activamos directamente desde el panel administrador.

Configuración

Para personalizar la apariencia que nuestros comentarios tendrán en Twitter, debemos conocer unos parámetros que podemos modificar y que indicarán los datos del usuario que está comentando.

(Ver Imagen)

Descargar

Podemos descargarlo directamente desde el directorio de Wordpress.