en este post pondremos el ejemplo de una estructura de pluguin hecho solo con funciones.

Esta estructura poseerá las siguientes características :

• Hecha solo con funciones ( sin clases  class  mi _clase{} etc  )
• Incluye función instalación en WordPress.
• Incluye función desinstalación en WordPress
• Incluye opciones de administración.
• Incluye Shortcode ( codigo corto para ejecutar función principal )
• Incluye opción de Widget para ejecutar como widget

En este caso por primera vez , se empiezan a utilizar funciones  ( hooks ) propias de WordPress, que se deben conocer antes que son:

• add_options_page :  Añade el menu de opciones a WordPress de nuestro Pluguin/Widget
• add_action(‘admin_menu’, ‘inserta_menu_huw’) :  Accción que se ejecuta al acceder a las opciones de wordpress.
• add_action(‘activate_TU-DIRECTORIO/TU-FICHERO.php’,'instala_huw’) : Añade la función que se ejecutará cuando se active el pluguin/widget ( inicialización ). Puede servir por ejemplo para crear una tabla en la base de datos de wordpress.
• add_action(‘deactivate_TU-DIRECTORIO/TU-FICHERO.php’, ‘desinstala_huw’) . Añade la función que se ejecutará cuando se desactive el pluguin/widget .
• register_sidebar_widget(“Widget HazmeUnaWeb”, “principal_widget_huw”) :  Registramos la función a ejecutar como widget.
• add_action(“plugins_loaded”, “iniciar_widget_huw”):  Solo cuando el pluguin sea leido , activamos el widget !!!
• add_shortcode(‘hazmeunaweb’, ’shortcode_huw’) :  Añadimos la función a ejecutar cuando se escriba el shortcode en los post . En los post se escribirá :     y se ejecutará esa función.

A continuación viene el código que se explica por si solo. En principio todo esta incluido dentro de un directorio, con un único fichero (wp-content/pluguins/huw_estructura_funciones/huw_estructura_funciones.php )

<?php
 /*
 Plugin Name: huw_estructura_funciones
 Plugin URI: http://www.hazmeunaweb.com
 Description: Pluguin de ejemplo que consta de :    Estructura solo con funciones - Incluye widget - Incluye SortCode - Incluye funci&oacute;n de instalaci&oacute;n - Incluye funcion de desinstalaci&oacute;n - Incluye opciones en el Admin de WordPress
 Version: 0.1
 Author: Manuel Mart&iacute;nez
 Author URI: http://www.hazmeunaweb.com
 */

 /* Función que se ejecutará en wordpress , cuando se haya puesto denro del codigo <?php principal_huw(); ?> */
 function principal_huw(){
 // Tu codigo
 }

 /* Función que se ejecutará en wordpress COMO UN WIDGET  */
 function principal_widget_huw(){
 // Tu codigo PUEDE SER EL MISMO QUE principal_huw()  o  no
 }

 // Funcion que SOLO !!!  se ejecuta al activar por primera vez el pluguin ( hace la instalación inicial )
 function instala_huw(){
 // Tu codigo
 }

 // Función que SOLO !!! se ejecuta al desisnstalar el pluguin ( hace la desinstalación final )
 function desinstala_huw(){
 // Tu codigo
 }

 // Función para poner nuestro saludo personalizado , configurandolo en 'nuestro' panel personalizado del admin de wordpress
 function admin_huw()
 {
 // Tu codigo
 echo utf8_encode( "Aquí esta la zona de administración del Widget HazmeUnaWeb");

 }

 // shortcode del plugin para usar en los post
 // se usa poniendo  en los post
 function shortcode_huw($atts) {
 // el valor devuelto por return se inserta en el post en lugar
 // del shortcode. No se debe usar echo sino return  !!!!!
 return principal_huw();
 }

 /////////////////////////////////////////////////////////////////
 // COMIENZO DE FUNCIONES Y HOOKS PARA QUE WORDPRESS LO INSTALE //
 /////////////////////////////////////////////////////////////////

 // Función para insertar nuestro panel de conficguración del pluguin en wordpress
 function inserta_menu_huw()
 {
 if (function_exists('add_options_page'))
 {
 //add_menu_page
 add_options_page('Estructura HazmeUnaWeb', 'HazmeUnaWeb', 8, basename(__FILE__), 'admin_huw');
 }
 }

 // Condicional para asegurarnos que existe la función
 if (function_exists('add_action'))
 {
 add_action('admin_menu', 'inserta_menu_huw');
 }

 // Le decimos a wordpresss cual es la función  a ejecutar al ACTIVAR el pluguin ( función instalación del pluguin )
 add_action('activate_TU-DIRECTORIO/TU-FICHERO.php','instala_huw');

 // Le decimos a wordpress cual es la función  que debe ejecutar al DESACTIVAR el pluguin ( función desinstalación del pluguin )
 add_action('deactivate_TU-DIRECTORIO/TU-FICHERO.php', 'desinstala_huw');

 // Función para instalar el widget
 function iniciar_widget_huw(){
 register_sidebar_widget("Widget HazmeUnaWeb", "principal_widget_huw");
 }

 // Cuando los pluguins se han leido , entonces instalamos el widget
 // Por esto la activación del widget se hace dentro de la función !!!
 add_action("plugins_loaded", "iniciar_widget_huw");

 // Ponemos el shortcode
 // se usa poniendo  en los post
 add_shortcode('hazmeunaweb', 'shortcode_huw');

?>

Como dice el título veremos como hacer nuestro primer plugin , pluguin : )

Lo que más conocemos, realmente como pluguin de WordPress. Es decir un pluguin dentro del directorio pluguins de wordpress ( wp-content/pluguins/ ).

Haremos exactamente lo mismo que en el anterior POST , pero dentro del directorio pluguins , para activarlo en el menu de WordPress, y con alguna diferencia para seguridad y evitar conflictos de colisión de nombres.

Como va a ser una pluguin simple , podemos hacerlo de dos formas principalmente:

• La primera en único fichero php . Por ejemplo mi_pluguin.php , dentro del directorio ( wp-content/pluguins/ )
• La segunda forma ( que es la que haremos ) , consiste en crear dentro del directorio plugins , otro directorio que se llame  mi_pluguin ( wp-content/pluguins/huw_pluguin/ ) . Esto nos servirá para :
  • Que dentro de ese directorio, podamos poner todo lo que queramos en función de lo complicado que sea ese pluguin de WordPress. Es decir dentro de ese diirectorio podríamos pones los típicos directorios que hay en toda web como:
    • wp-content/pluguins/huw_pluguin/css/    : Directorio para guardar el estilo del pluguin
    • wp-content/pluguins/huw_pluguin/js/       : Directorio para guardar el javascript del pluguin
    • wp-content/pluguins/huw_pluguin/img/   : Directorio para guardar las imagenes del pluguin
    • wp-content/pluguins/huw_pluguin/etc/
  • Además nos será más fácil,  eliminarlo después, si queremos.
  • Tendremos una estructura más ordenada para evitar conflictos, de nombres.

Al pluguin además de la “programación normal” se debe añadir el título y otros detalles como cabecera.

A continuació se pone el pluguin completo y se explicará algún detalle.

/*
Plugin Name: huw_pluguin
Plugin URI: http://www.hazmeunaweb.com/
Version: v1.00
Author: <a href="http://www.hazmeunaweb.com/">HazmeUnaWeb.com</a>
Description: Un ejemplo de plugin para WordPress , con varias estructuras juntas

Copyright 2009  HazmeUnaWeb.com  (email : frelance@hazmeunaweb.com

 El tipo de licencia que se quiera poner
 por ejemplo :

 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/

 // Función simple definida dentro del fichero huw_pluguin.php
 function hola_huw() {
    return "Hola  , ";
 }

 // Comprobamos que la clase no existe antes de crearla para evitar problemas
 if (!class_exists("HazmeUnaWeb_pluguin_compatible")) {
    class HazmeUnaWeb_pluguin_compatible {
       // declaración y definición de variable ( compatibilidad PHP4 )
       var $texto = "Bienvenido";

       function HazmeUnaWeb_pluguin_compatible() { //constructor con compatibilidad PHP4, PHP5
           $this->texto = $this->texto." a ";
       }

    }    // final de la defición de la clase
 }

 // nos aseguramos de que existe ante de instanciarla y llamar a su constructor
 if (class_exists("HazmeUnaWeb_pluguin_compatible")) {
     $nueva_instancia_compatible = new HazmeUnaWeb_pluguin_compatible();
 }

 // Comprobamos que la clase no existe antes de crearla para evitar problemas
 if (!class_exists("HazmeUnaWeb_pluguin_php5")) {
    class HazmeUnaWeb_pluguin_php5 {
        // declaración y definición de variable
        public $texto_php5 = "Hazme";

        function __construct() { //constructor SOLO  PHP5
           $this->texto_php5 = $this->texto_php5."UnaWeb.com";
        }
    }    // final de la defición de la clase
 }

 // nos aseguramos de que eiste ante de instanciarla y llamar a su constructor
 if (class_exists("HazmeUnaWeb_pluguin_php5")) {
     $nueva_instancia_php5 = new HazmeUnaWeb_pluguin_php5();
 }

Las únicas diferencias con respecto , al previo pluguin hecho con el fichero functions.php son:

• Una cabecera donde se explican los detalles del pluguin y se pone un copyright si se quiere
• la comprobación de la existencia de la clase antes de instanciarla
• Para que funcione el pluguin,  el usuario debe activarlo en la sección pluguins

Después de crear el directorio y el fichro del pluguin , al usuario le aparecerá esta imagen:

Solo se debe pulsar en ACTIVAR para que se pueda utlizar el pluguin y listo

Para que se vea su efecto, hemos puesto lo siguiente en single.php

// Ejemplo de pluguin con el fichero huw_pluguin.php
 $titulo_post = the_title('','',FALSE);
 // Si es el post donde queremos poner el pluguin
 if ( $titulo_post == 'Nuestro Primer Plugin Plugin WordPress' )
 {
echo "<p style='color:#ff0000;'>";
echo     "<strong>";
echo         hola_huw();                            // llamada a funcion simple
echo         $nueva_instancia_compatible->texto;    // llamada a clase compatible
echo         $nueva_instancia_php5->texto_php5;    // llamada a clase php5
echo     "</strong>";
echo "</p>";

 }

Que es lo mismo que habia en el anterior POST, pero cambiando los nombres de las clases para evitar conflictos de nombres.

Vamos a hacer nuestro primer pluguin WordPress.

Los desarrolladores, suelen aprender antes el lenguaje de programación PHP ( más “general” ) y después se va aplicando a los distintintos frameworks , CMS , por esto es normal que se sepa PHP y después se aprendan las particularidades ( como en este caso ) de WrodPress.

Así el ejemplo simple elegido para empezar , será uno que utilice “SOLO” PHP . Es decir no se necesitan conocimeientos de Hooks u otra funcionalidad de WordPress.

De esta forma , sirve para plantear las estructuras iniciales del pluguin , en base a los parámetros del anterior POST

Más tarde solo se deberá , incluir más conocimientos de WordPress dentro de estas estructuras.

1^er Ejemplo de Pluguin

Para este primer ejemplo , usaremos varias estructuras a la vez , para “matar varios pajaros de un tiro”. esto lo  haremos siguiendo estos puntos :

• Planteamiento del Objetivo : En este caso, el objetivo será, una frase de bienvenida al web/blog  hazmeunaweb.com , utilizando varias estructuras ” PHP “  a la vez,  dentro del fichero functions.php , que serán :
  • Una simple estructura de función .
  • Una Clase con compatibilidad para PHP4 , PHP5
  • Una Clase solo con compatibilidad PHP5
• En base al objetivo y los parametros indicados en el POST anterior ir definiendo la solución:

¿Cómo crear un pluguin?

La necesidad : Queremos añadir el pluguin como una funcionalidad extra, de nuestro theme. En este caso empezaremos por lo más sencillo que es ponerlo dentro de nuestro fichero functions.php

Estructura de Programación y Compatibilidad: Queremos poner varias estructuras a la vez para conseguir algo. Sería como utilizar 3 pluguins diferentes para un mismo objetivo. Es este caso se hace así , como medio didáctico para ver varias estructuras a la vez ( con solo una de ellas habríamos conseguido el mismo resultado )

¿Donde crear un pluguin?

Hemos decido que será en el fichero functions.php , que se encuentra en wp-content/themes/mi_theme/functions.php

¿Cuando crear un pluguin?

Desde el punto de vista de del conocimiento de wordpress:  En principio supondremos que no hemos encontrado que se pueda hacer de otra forma ( esto sería lo primero que hariamos normalmente ). Ahora es didáctico.

¿Existe ya ese pluguin? : Suponemos que no existe. 

Ahora que ya tenemos “todo” decidido y planteado , vamos a  programar dentro del fichero functions.php

Primero empezamos por una función sencilla:

// Función sola definida dentro del fichero functions.php
 function hola_hazmeunaweb() {
 return "Hola  , ";
 }

Esta función la utilizaremos en cualquiera de nuestros fiheros de WordPress de la siguiente forma:

<?php echo hola_hazmeunaweb() ?>

Segundo pondremos una estructura de clase con compatiblidad para PHP4, PHP5

// clase definida dentro del fichero functions.php
     // con compatibilidad PHP4, PHP5
 class hazmeunaweb {
     // declaración y definición de variable ( compatibilidad PHP4 )
    var $texto = "Bienvenido";

    // función constructor de la clase ( compatibilidad PHP4 , PHP5 )
    // lo que hace es añadir el texto "a " para terminar de formar la frase de bienvenida
    function hazmeunaweb() {
      $this->$texto = $this->$texto." a ";
     }
 }

 // Hacemos una instancia para poder llamarla desde cualquier fichero
 // Se llama implicitamente al constructor de forma que $texto = "Bienvenido" + " a  "
 $mi_clase_compatible = new hazmeunaweb();

Tercero pondremos una estructura de clase con compatiblidad SOLO para PHP5 ( hasta que se implante el 6 )

// clase definida dentro del fichero functions.php
 // NOS ASEGURAREMOS QUE SOLO SERÁ PARA PHP 5 !!!!!
 // MEDIANTE LA DEFINCICIÓN ESPECÍFICA DEL CONSTRUCTOR "__construct"
 class hazmeunaweb_php5 {
    // declaración y definición de variable
    public $texto_php5 = "Hazme";

    // función constructor de la clase ( compatibilidad PHP4 , PHP5 )
    // lo que hace es añadir el texto "UnaWeb.com" para terminar de formar la frase de bienvenida
    function __construct() {
        $this->$texto_php5 = $this->$texto_php5."UnaWeb.com";
     }
 }

 // Hacemos una instancia para poder llamarla desde cualquier fichero
 // Se llama implicitamente al constructor de forma que $texto_php5 = "Hazme" + "UnaWeb.com"
 $mi_clase_php5 = new hazmeunaweb_php5;

Una vez hemos preparado y guardado el fichero functions.php, solo falta ponerlo donde queramos
En este caso , como queremos que se ponga SOLO DEBAJO DEL CONTENIDO DE ESTE POST , haremos los siguiente:

Comprobaremos que el título del post , coincide con el post en el que estamos para de esa forma ejecutar el pluguin que queremos.

La comprobación se hace mediante codigo PHP y codigo WordPress

El código WordPress necesario para esto es   the_title(”,”,FALSE) que significa : El título del POST actual .

Este codigo admite 3 párametros : the_title(parametro_1,parametro_2,parametro_3)

• parametro_1 = Contenido  que queremos insertar antes del título
• parametro_2 = Contenido  que queremos insertar después del título
• parametro_3 = TRUE -> El contenido , se “imprime directamente en pantalla” , FALSE -> El contenido se devuelve como un string para ser utilizado dentro de PHP.

<?php  $titulo_post = the_title('','',FALSE);
      // Si es el post donde queremos poner el pluguin
      if ( $titulo_post == 'Nuestro primer pluguin WordPress' )
      {
          echo "<p style='color:#ff0000;'>";
          echo     "<strong>";
          echo         hola_hazmeunaweb();             // llamada a funcion simple
          echo         $mi_clase_compatible->texto;    // llamada a clase compatible
          echo         $mi_clase_php5->texto_php5;     // llamada a clase php5
          echo     "</strong>";
          echo "</p>";
      }
 ?>

De esta forma SOLO ejecutamos este código si el título del POST coincide con ‘Nuestro primer pluguin WordPress’.
Este código se ha introducido en el fichero single.php ( wp-content/themes/mi_theme/single.php ) , que es el que se ejecuta cuando queremos ver un solo POST en WordPress.
Se puede ver en el código las llamadas a la función simple y a cada una de las clases.
En este caso como el hosting tiene PHP Version 5.1.6, no ha habido problema con la clase que SOLO era para PHP5
Normalmente siempre intentaremos hacer las clases compatibles, para que se pueda utilizar por más personas.

Después de todo esto se puede ver debajo de este post la frase con color rojo Hola , Bienvenido a HazmeUnaWeb.com

En este  post, plantearemos el tipo de estructura del pluguin en función de las carácteristicas , ya comentadas en el anterior POST .

Ahora lo que haremos será ir respondiendo las preguntas iniciales de ¿Cómo? ¿Donde? ¿Cuando crear un pluguin? , según las explicaciones del primer post y veremos que las tres preguntas están relacioneadas.

¿Cómo crear un pluguin?

La necesidad :

• Si lo que queremos, es simplemente añadir alguna funcionalidad  extra,  a nuestro WordPress , que ya tiene un THEME definido , tenemos dos posibilidasdes.

1. Añadirlo en el fichero  functions.php . Este fichero lo podemos encontrar ( O CREAR SI NO EXISTE ) en la ruta que tenga , nuestro THEME ( por ejemplo :   wp-content/themes/mi_theme/functions.php ). LO QUE SE CREA EN ESTE FICHERO TAMBIEN ES UN PLUGUIN , PERO DENTRO DEL FICHERO  functions.php
2. Añadir la funcionalidad extra,  dentro del directorio   wp-content/pluguins/ ( es lo que MÁS se conoce como pluguin ). Aquí se puede hacer de dos formas :

• la más sencilla es simplemente un fichero php ( wp-content/pluguins/mi_pluguin.php )
• la “MEJOR”  sería dentro de un directorio , dentro del directorio pluguins ( por ejemplo : wp-content/pluguins/mi_pluguin/mi_pluguin.php ). Esto sirve para varias cosas : encontarlo , borrarlo y editarlo más facilmente además de poder complicarlo mucho más : ) , ya que dentro de ese directorio podríamos crear “NUESTRA” propia estructura, tipo web, donde poner los directorios típicos
  • wp-content/pluguins/mi_pluguin/mi_pluguin.php -> Nombre del fichero principal del pluguin.
  • wp-content/pluguins/mi_pluguin/css/mi_estilo_del_pluguin.css -> Estilo del pluguin
  • wp-content/pluguins/mi_pluguin/js/mi_javascript_del_pluguin.js -> Javascript del pluguin
  • wp-content/pluguins/mi_pluguin/ETC

Elegir una u otra dependerá de la complicación del pluguin que hagamos y de las funcionalidades u objetivos que busquemos. Por ejemplo si queremos compartirlo , simplemente queremos probar alguna cosa, etc

Estructura de Programación y Compatibilidad:

• Dependerá de lo complicado y su funcionalidad o de si alguien nos lo pide    de alguna forma en concreto.

¿Donde crear un pluguin?

Ahora podemos ver , que todas estas preguntas estaban relacionadas ya que el ¿DONDE? se refería unicamente, desde el punto de vista de la estructura de archivos de WordPress y se ha contestado en el punto anterior relacionado, con la necesidad que tengamos.

¿Cuando crear un pluguin?

Desde el punto de vista de del conocimiento de wordpress: En principio cuando empezamos NO TENEMOS CONOCIMIENTO , por lo tanto lo normal es buscar por ejemplo ( primero en el DIOS google   ), y después en la información de WordPress si existe alguna ‘Función/Hok/Utilidad ‘ sobre lo que queremos hacer. Si no existe , se intentará implementar en alguno de los ’sitios’ que ya sabemos ( function.php o directorio pluguins ) .

• ¿Existe ya ese pluguin? : Puede que no exista en WordPress , pero si que alguien haya hecho algo parecido, que nos sirve como punto de partida.

En el siguiente post , pondremos el primer ejemplo de pluguin. Intentando abarcar varias posibilidades a la vez.

Este  post, pretende ser el primero , de  una serie de post sobre como inciciarse, en el mundo de los pluguins , en WordPress.

El título, intenta hablar sobre dichos conceptos y como se relacionan entre ellos.

Para entender este artículo se deben conocer estos conceptos:

• ¿Qué es un Theme de WordPress?: Simplificando podemos decir que es un diseño de una página web para WordPress. Más info AQUI

• ¿Qué es PHP4 , PHP5 ? : Es un lenguaje de programación PHP ( que se ejecuta en el servidor donde se aloja la web) y dos versiones del mismo 4 y 5 . Más info AQUI

• ¿Qué son funciones , Clases ? : Dentro del lenguaje de programación funciones se refiere a una programación estructurada y clases a una OOP ( programación orientada  a objetos ) . Más info AQUI

• ¿Qué es Css ? : Css es un mecanismo que define como se interpretará el documento en la salida que elijmos ( por ejemplo define como se verá este documento en tu pantalla , colores tamaño letra etc) Más info AQUI

• ¿Qué es Js o JavaScript ? : Es un lenguaje de programación ( scripting) , del lado del cliente ( se ejecuta en tu ordenador ) . Sirve para añadir acciones a la página para hacerla más interactiva.  Más info AQUI

Estas son las principales preguntas que uno se hace al buscar información de como hacer un pluguin.

¿Cómo crear un pluguin?

Aquí hablaremos de como crearlo,  desde varios puntos de vista.

• La necesidad : ¿Debe estar incluido, en un theme de wordpress, o queremos añadir alguna funcionalidad extra a un theme ya defininido?.
• Estructura de Programación :¿Qué debe incluir ese pluguin en concreto?  ¿Sólo funciones , Clases, Css, Js etc?
• Compatibilidad : ¿PHP4? ¿PHP5? ¿Ambos?

¿Donde crear un pluguin?

Aquí hablaremos de donde crearlo desde el punto de vista, de la estructura de archivos de wordpress.

¿Cuando crear un pluguin?

Aquí hablaremos de cuando crearlo desde varios puntos de vista.

• Desde el punto de vista de del conocimiento de wordpress: Este punto es el más dificl de todos. Implica conocer TODA la programación y HOOKS ( ‘funciones’ de WordPress)  ya implementados , para no reinventar la rueda y repetir algo ya hecho. Por ejemplo existe una digamos por ahora “función” en WordPress llamada  is_home() , que indica cuando el usuario, se encuentra el la HOME de la blog/web. Si desconocemos esto podemos intentar implementar una función, que nos averigue la URL para hacer lo mismo .
• ¿Existe ya ese pluguin? : ¿Existe, pero queremos mejorarlo/cambiarlo, etc ?

En el siguiente post , definiremos unas variables sencillas para empezar y lo iremos complicando ; )