Jul 28 2008

Como hacer un plugin para Wordpress {

Tag: PHP, Wordpress

Luego de escribir mi primer plugin, voy a explicar a grandes rasgos lo que se necesita para escribir un plugin, éste está compuesto de 2 archivos, uno con la funcionalidad del plugin y otro con la página de opciones para el panel de administración de wordpress.

Lo primero que haremos será escribir el encabezado para el plugin, ésto es lo que permitirá que Wordpress reconozca el plugin.

/* 
Plugin Name: Category 2 Post 
Plugin URI: http://nuevosprogramadores.com/category2post/ 
Description: Allows to include posts from one selected category 2 your post or page body. 
Version: 0.1 Author: Pablo Rodríguez Author URI: http://nuevosprogramadores.com 
*/ 
/*  Copyright 2008  Pablo Rodríguez  (email : prodriguez@nuevosprogramadores.com)      
This program is free software; you can redistribute it and/or modify     
it under the terms of the GNU General Public License as published by     
the Free Software Foundation; either version 2 of the License, or     
(at your option) any later version.      
This program is distributed in the hope that it will be useful,     
but WITHOUT ANY WARRANTY; without even the implied warranty of     
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the     
GNU General Public License for more details.      
 
You should have received a copy of the GNU General Public License     
along with this program; if not, write to the Free Software     
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA 
*/

Como se puede apreciar, el encabezado está compuesto de 2 comentarios, sólo el primero es obligatorio, el segundo especifica que el plugin es publicado bajo licencia GPL.

Luego escribiremos la funcionalidad del plugin, en nuestro caso es una función que recorre los posts de una determinada categoría, arma un html con el contenido y por último reemplaza el comentario <!--category2post--> por el html con los posts que encontró anteriormente.

function category2post($c2p_content) { 
	$c2p_IDCategory = stripslashes(get_option('c2p_IDCategory')); 
	$c2p_NumberOfPosts = stripslashes(get_option('c2p_NumberOfPosts')); 
	$c2p_ShowAllContent = stripslashes(get_option('c2p_ShowAllContent')); 
	$c2p_result = ""; $c2p_posts = array(); 
 
	switch($c2p_NumberOfPosts) { 
		case 0: 
			c2p_posts = get_posts("category=$c2p_IDCategory"); 
			break; 
		default: 
			$c2p_posts = get_posts("numberposts=$c2p_NumberOfPosts&amp;category=$c2p_IDCategory"); 
			break; 
		} 
		if(sizeof($c2p_posts)) { 
			foreach($c2p_posts as $c2p_post) { 
			$c2p_result .= "<h3><a href="\">guid."\" id=\"".$c2p_post-&gt;ID."\"&gt;".$c2p_post-&gt;post_title."</a></h3>\n";
			if($c2p_ShowAllContent == '0') { 
				$c2p_result .= $c2p_post-&gt;post_excerpt."\n"; 
			} else { 
				$c2p_result .= $c2p_post-&gt;post_content."\n"; 
			} 
		} 
	} 
	return preg_replace('<!-- category2post -->|', $c2p_result, $c2p_content); 
}

Es muy importante buscar que los nombres de las funciones para no tener problemas con otros plugins y si las hubiese, hay que aplicar el mismo criterio con las variables. En mi caso utilicé el mismo prefijo para todo.

Como este plugin requiere de configuración, escribiremos también una función que agregue la página al panel de Wordpress.

function c2p_add_option_page() { 
	add_options_page('Opciones', 'Category2Post', 'manage_options', 'category2post/options-c2p.php'); 
}

Y por último haremos que todo esto funcione:

add_action('admin_head', 'c2p_add_option_page'); add_filter('the_content', 'category2post');

La primera línea asigna nuestra función c2p_add_option_page a la acción admin_head de Wordpress, mientras que la segunda indica que nuestra función category2post se debe ejecutar con el filtro the_content.

Por suerte Wordpress cuenta con una buena Referencia de Funciones, que nos sirve como guía para nuestras creaciones, además contamos con otros plugins que podemos utilizar como referencia para ver el código.

Hasta aquí las funciones que utilizamos son: get_option que nos permite obtener el valor de una opción desde la base de datos, get_posts para obtener los posts que cumplan con cierto criterio, en nuestro caso buscamos los que pertenezcan a una categoría y de ser necesario, que sólo devuelva x cantidad de posts, add_options_page para agregar nuestra página de opciones al panel de administración de Wordpress y por último add_action y add_filter.

}


Jul 26 2008

Plugin para Wordpress - Category2Post - v0.1 {

Después de mucho tiempo diciendo “algún día voy a hacer un plugin para Wordpress”, finalmente llegó el día, desde hoy se encuentra funcionando en Nuevos Programadores el plugin Category2Post que se encarga de recopilar las entradas publicadas bajo la categoría Mini Tips y mostrarlos en la página del mismo nombre.

El plugin está totalmente escrito en php y utiliza funciones de la muy documentada API de Wordpress para seleccionar los posts y mostrarlos. Si hay algún curioso que desee ver como funcionan los plugins de Wordpress, éste es bastante simple, lo suficiente como para entender la lógica para escribir un plugin e incluir una página para la configuración de opciones.

En un próximo post voy a explicar lo básico de la experiencia que fue escribir mi primer plugin para wordpress, mientras tanto si alguien lo prueba y encuentra algún bug o se le ocurre que se podría agregar una nueva funcionalidad, puede dejar un comentario o comunicarse conmigo a través del formulario de contacto del blog.

Descargar Category2Post

}


Jul 22 2008

Aplicación con plugins en VB.Net {

Tag: VB.Net

Este ejemplo muestra una forma sencilla de crear aplicaciones cuya funcionalidad se puede extender con el uso de plugins o agregados.
En este caso, como lo que importa es mostrar como se hace la carga mediante herramientas de Reflection, nuestros plugins son sólo forms con una funcionalidad muy simple, un web browser y un reloj… queda en la imaginación de cada uno crear algún nuevo plugin.

Para la carga de los plugins, o sea buscar los archivos y cargar los menús correspondientes utilizaremos un nuevo thread, pero como no es el propósito de este post mostrar el manejo de threads, utilizaremos un Background Worker que automatiza el proceso.

    Private Sub bgwCargaPlugins_DoWork(ByVal sender As System.Object, ByVal e As System.ComponentModel.DoWorkEventArgs) Handles bgwCargaPlugins.DoWork
        Dim DirectorioPlugins As String = String.Format("{0}{1}", Threading.Thread.GetDomain().BaseDirectory, "plugins")
        If Directory.Exists(DirectorioPlugins) Then
            For Each _dir As String In Directory.GetDirectories(DirectorioPlugins)
                Try
                    Dim aux As System.Collections.Generic.KeyValuePair(Of String, String) = PluginLoader.CargarPluginDesdeDirectorio(_dir)
                    _pluginsEncontrados.Add(aux.Key, aux.Value)
                Catch ex As Exception
                    Trace.WriteLine(ex.ToString())
                End Try
            Next
        Else
            Trace.WriteLine("El directorio de plugins no existe.")
        End If
    End Sub
 
    Private Sub bgwCargaPlugins_RunWorkerCompleted(ByVal sender As Object, ByVal e As System.ComponentModel.RunWorkerCompletedEventArgs) Handles bgwCargaPlugins.RunWorkerCompleted
        If _pluginsEncontrados.Count > 0 Then
            mostrarMenuDePlugins()
        End If
    End Sub

Lo primero que hacemos es chequear que el directorio de plugins exista, en este caso es un directorio hard-coded llamado plugins que se ubica en el directorio de instalación, pero en una aplicación real deberíamos podríamos hacer que esa ruta sea configurable.
Luego recorreremos los subdirectorios y pasaremos la ruta de cada uno a nuestra clase PluginLoader para guardar el resultado en un objeto del tipo Dictionary(Of String, String), que a grandes rasgos es una colección ordenada que guarda un valor asociado a una determinada clave; en este caso, la clave será el nombre del tipo a cargar, o sea el form del plugin y el valor será la ruta a la dll que contiene el plugin.

Una vez que el background worker ha finalizado su ejecución, llamamos a un método que lo que hará es recorrer nuestro Dictionary cargado de plugins y agregar un item al menú plugins y agregarle un handler genérico para el evento click a cade item que agregue.

    ' Método que carga los items en el menú
    Public Sub mostrarMenuDePlugins()
        For Each p As System.Collections.Generic.KeyValuePair(Of String, String) In _pluginsEncontrados
            Dim aux As System.Windows.Forms.ToolStripMenuItem = Me.PluginsToolStripMenuItem.DropDownItems.Add(p.Key)
            AddHandler aux.Click, AddressOf PluginMenuClick
        Next
        Me.PluginsToolStripMenuItem.Enabled = True
    End Sub
 
    ' handler para el evento click de cada item del menú plugins
    Public Sub PluginMenuClick(ByVal sender As Object, ByVal e As System.EventArgs)
        Try
            Dim plugin As Form = PluginLoader.InstanciarPlugin(_pluginsEncontrados.Item(sender.ToString()), sender.ToString())
            plugin.MdiParent = Me
            plugin.Show()
        Catch ex As Exception
 
        End Try
    End Sub

Lo que haremos en el click de cada item del menú plugins será pedirle a nuestra clase PluginLoader que nos instancie el plugin para luego mostrarlo como MDI Child.

Ahora sólo nos resta ver el código de la clase PluginLoader:

Imports System.IO
 
Public Class PluginLoader
    Public Shared Function CargarPluginDesdeDirectorio(ByVal Directorio As String) As System.Collections.Generic.KeyValuePair(Of String, String)
        Dim aux As System.Collections.Generic.KeyValuePair(Of String, String) = Nothing
 
        'Busco solo los archivos .dll en el directorio especificado
        Dim archivos() As String = Directory.GetFiles(Directorio, "*.dll")
        If archivos.Length > 0 Then
            For Each dll As String In archivos
                Try
                    Dim assembly As System.Reflection.Assembly = System.Reflection.Assembly.LoadFrom(dll)
                    'Recorro los tipos que se encuentran en la dll cargada
                    For Each t As Type In assembly.GetTypes()
                        Try
                            'cargo solo los que son derivados de Form
                            If t.BaseType Is GetType(Form) Then
                                aux = New System.Collections.Generic.KeyValuePair(Of String, String)(t.Name, assembly.Location)
                            End If
                        Catch ex As Exception
                            Trace.WriteLine(ex.ToString())
                        End Try
                    Next
                Catch ex As Exception
                    Trace.WriteLine(ex.ToString())
                End Try
            Next
        End If
        Return aux
    End Function
 
    Public Shared Function InstanciarPlugin(ByVal RutaDll As String, ByVal PluginName As String, Optional ByVal ExtraData As Object = Nothing) As Form
        Dim TipoPlugin As Type
        Dim frm As Form
 
        Dim PluginAssembly As System.Reflection.[Assembly] = System.Reflection.[Assembly].LoadFrom(RutaDll)
        TipoPlugin = PluginAssembly.GetType(PluginName, False, True)
 
        If Not TipoPlugin Is Nothing Then
            Dim Instancia As Object
            'ExtraData se puede utilizar para pasar argumentos al constructor
            If ExtraData Is Nothing Then
                Instancia = Activator.CreateInstance(TipoPlugin)
            Else
                Dim arg() As Object = {ExtraData}
                Instancia = Activator.CreateInstance(TipoPlugin, arg)
            End If
 
            frm = CType(Instancia, Form)
        Else
            'En caso de error devuelvo un form cualquiera con el texto de error
            frm = New Form()
            frm.Text = "Error cargando el plugin"
        End If
 
        Return frm
    End Function
End Class

El código de esta clase no es muy complejo y con los comentarios se puede entender lo más relevante de la misma, al final del artículo está el enlace para descargar la solución, que está hecha con Visual Studio 2005.

Con respecto a los plugins, son proyectos de tipo Class Library, los mismos tienen referencia a System.Windows.Forms y el proyecto de la aplicación principal no tiene ninguna referencia a éstos, de manera que el proyecto no tiene por qué estar incluido en la misma solución.

Descargar el código fuente de la aplicación con plugins en VB.Net (124.71 KB)

}


Página 1 de 11