DEV Community

Juanan Ruiz
Juanan Ruiz

Posted on • Originally published at kungfupress.com on

Cómo crear tipos y campos personalizados en WordPress

Siguiendo este tutorial verás cómo crear un plugin de WordPress para convertir tu web en algo más que un blog. Vas a crear tipos de contenido personalizado, en inglés “Custom Posts Type” o “CPT” que te permitirán convertir tu página en un recetario de cocinas, un gestor de tu colección de libros, películas o sellos de correo.

Y lo harás todo desde código, sin utilizar ningún plugin pues esta es la mejor manera de aprender como funciona realmente WordPress y como programar aplicaciones completas con él. Más adelante en algún proyecto quizás necesites por cuestiones de tiempo o presupuesto utilizar algún plugin para crear campos personalizados como Advanced Custom Fields pero tu ya sabrás como funciona internamente.

Requisitos previos

Para enfrentar este tutorial te recomiendo un conocimiento medio o avanzado de WordPress y unos conocimientos mínimos de PHP.

Empezarás por lo básico creando el esqueleto del plugin con lo mínimo para que funcione todo correctamente. En tutoriales más avanzados aprenderás a crear plugins utilizando un esqueleto algo más complejo pero más estandarizado. Si ya eres desarrollador de WordPress quizás eches en falta definir el plugin dentro de un objeto, separar en distintos archivos las distintas partes del plugin y otras buenas prácticas que no he utilizado aquí a propósito, porque me parece más didáctico este planteamiento. En sucesivos tutoriales iré incorporando todas esas cuestiones.

Así que busca un sitio tranquilo para realizar tu práctica, con un tiempo delimitado durante el que nada te moleste, cíñete el cinturón, respira hondo y saluda a tu adversario antes de comenzar el combate.

Comienza a crear el plugin

Parte de una instalación básica y limpia, con un tema cualquiera, aunque si quieres que tenga apariencia de recetario te recomiendo uno de estos dos que son gratuitos y del repositorio oficial:

Con tu editor de código favorito crea una nueva carpeta dentro de la ruta wp-content/plugins, la puedes llamar recetario o algo más acorde a lo que quieras hacer.

Dentro de esa carpeta crea un archivo y nómbralo recetario.php , este será el punto de partida de tu plugin. Es muy importante escribir correctamente la cabecera de este artículo para que WP lo identifique como un plugin.

\<?php
/\*
Plugin Name: Recetario
Author Name: Juanan Ruiz
Plugin URI: https://kungfupress.com/como-crear-tipos-y-campos-personalizados-en-wordpress
Description: Un plugin para aprender a programar WP practicando con un gestor de recetas.
\*/
Enter fullscreen mode Exit fullscreen mode

La única línea realmente imprescindible es la del Plugin Name , el resto es información adicional, útil pero no imprescindible a nivel de funcionamiento interno. Que no se te olvide tampoco la primera línea con la etiqueta <?php , si olvidas ponerla el contenido del plugin o una parte de él se verá por toda tu web (si no pasa algo peor).

Si ahora guardas el fichero y vas al listado de plugins desde el panel de administración de tu sitio WP verás tu nuevo plugin esperando y listo para ser activado.

Creando un Custom Post Type o Campo Personalizado

Este pobre plugin aún no sabe hacer nada, así que vas a comenzar a definir el Custom Post Type (CPT). Para ello puedes copiarlo de otro que ya tengas hecho, del código que tienes más abajo o generarlo desde la web GenerateWP. Para ello vas recorriendo las pestañas que aparecen en la página: General, Post Type, Labels, etc y rellenando los campos.

Herramienta GenerateWP

Empieza por la pestaña General y rellena Function Name con: receta_post_type

Este es el nombre de la función con la que vas a definir el CPT

Luego ve a la pestaña Post Type y rellena los siguientes campos:

  • Post Type Key: receta
  • Name (Singular): Receta
  • Description: Receta
  • Name (Plural): Recetas
  • Hierarchical: No

En la pestaña Labels se pueden configurar un montón de etiquetas, rellena sólo estas dos de momento:

  • Menu name: Recetas
  • Admin Bar Name: Receta

Por último en la pestaña Options marca la casilla Custom Fields y para terminar pulsa el botón Update Code que hay un poco más abajo, copia el código generado en tu plugin y te quedará algo parecido a esto.

\<?php
/\*
Plugin Name: Recetario
...
\*/
​
// Register Custom Post Type
function receta\_post\_type() {
 $labels = array(
 'name' =\> \_x( 'Recetas', 'Post Type General Name', 'text\_domain' ),
 'singular\_name' =\> \_x( 'Receta', 'Post Type Singular Name', 'text\_domain' ),
 'menu\_name' =\> \_\_( 'Recetas', 'text\_domain' ),
 'name\_admin\_bar' =\> \_\_( 'Receta', 'text\_domain' ),
 'archives' =\> \_\_( 'Item Archives', 'text\_domain' ),
 'attributes' =\> \_\_( 'Item Attributes', 'text\_domain' ),
 'parent\_item\_colon' =\> \_\_( 'Parent Item:', 'text\_domain' ),
 'all\_items' =\> \_\_( 'All Items', 'text\_domain' ),
 'add\_new\_item'          =\> \_\_( 'Add New Item', 'text\_domain' ),
 'add\_new' =\> \_\_( 'Add New', 'text\_domain' ),
 'new\_item' =\> \_\_( 'New Item', 'text\_domain' ),
 'edit\_item' =\> \_\_( 'Edit Item', 'text\_domain' ),
 'update\_item' =\> \_\_( 'Update Item', 'text\_domain' ),
 'view\_item' =\> \_\_( 'View Item', 'text\_domain' ),
 'view\_items' =\> \_\_( 'View Items', 'text\_domain' ),
 'search\_items' =\> \_\_( 'Search Item', 'text\_domain' ),
 'not\_found' =\> \_\_( 'Not found', 'text\_domain' ),
 'not\_found\_in\_trash' =\> \_\_( 'Not found in Trash', 'text\_domain' ),
 'featured\_image' =\> \_\_( 'Featured Image', 'text\_domain' ),
 'set\_featured\_image'=\> \_\_( 'Set featured image', 'text\_domain' ),
 'remove\_featured\_image' =\> \_\_( 'Remove featured image', 'text\_domain' ),
 'use\_featured\_image' =\> \_\_( 'Use as featured image', 'text\_domain' ),
 'insert\_into\_item' =\> \_\_( 'Insert into item', 'text\_domain' ),
 'uploaded\_to\_this\_item' =\> \_\_( 'Uploaded to this item', 'text\_domain' ),
 'items\_list' =\> \_\_( 'Items list', 'text\_domain' ),
 'items\_list\_navigation' =\> \_\_( 'Items list navigation', 'text\_domain' ),
 'filter\_items\_list' =\> \_\_( 'Filter items list', 'text\_domain' ),
 );
 $args = array(
 'label'                 =\> \_\_( 'Receta', 'text\_domain' ),
 'description'           =\> \_\_( 'Receta', 'text\_domain' ),
 'labels'                =\> $labels,
 'supports'              =\> array( 'title', 'editor', 'thumbnail', 'comments', 'revisions', 'custom-fields' ),
 'hierarchical'          =\> false,
 'public'                =\> true,
 'show\_ui'               =\> true,
 'show\_in\_menu'          =\> true,
 'menu\_position'         =\> 5,
 'show\_in\_admin\_bar'     =\> true,
 'show\_in\_nav\_menus'     =\> true,
 'can\_export'            =\> true,
 'has\_archive'           =\> true,
 'exclude\_from\_search'   =\> false,
 'publicly\_queryable'    =\> true,
 'capability\_type'       =\> 'page',
 );
 register\_post\_type( 'receta', $args );
}
add\_action( 'init', 'receta\_post\_type', 0 );
Enter fullscreen mode Exit fullscreen mode

¿Cómo se ha definido el CPT con este código?

Primero se ha creado un array llamado $labels que contiene las etiquetas para nombrar los diferentes elementos y acciones del nuevo CPT.

Luego se ha definido otro array $args , que a su vez ha incluido a $labels , y en este segundo array se pasan todos los parametros para configurar el comportamiento del CPT. Cosas como si va a ser público, si va a aparecer en el menú de administración, si se va a comportar como una página o como una entrada, si los contenidos se van a incluir en las búsquedas del sitio, etc.

Una vez definido este segundo array se llama a la función register_post_type que requiere dos parámetros, uno con el nombre clave del CPT y otro con el nombre del array de argumentos.

Por último, fuera ya de la función se engancha esta función que define al CPT al hook add_action(init) que es el que se invoca cuando se carga el plugin

Guarda ahora el archivo y ve de nuevo al listado de plugins en el panel de administración. Busca el plugin y ahora puedes darle a activar. Si todo ha ido bien en el menú de la izquierda aparecerá un nuevo elemento con el nombre “Recetas”. Si haces clic en Add New verás que aparece algo parecido a una nueva entrada de blog.

¡Felicidades por haber llegado hasta aquí! Has creado un nuevo tipo de contenido para WordPress, no muchos lo han hecho.

Verás que hay algunos títulos y nombres de menú sin actualizar, abre de nuevo el archivo del plugin y traduce los elementos que estimes necesarios, por ejemplo All Items , Add New , Add New Item , etc. La próxima vez esto puedes hacerlo directamente editando las Labels en el WordPress Type Generator.

Los campos personalizados

Llegamos a un punto crítico.

Un tipo de contenido personalizado tiene poco sentido si no tiene también asociados algunos campos personalizados. En este ejemplo estaría bien contar con un campo para ingredientes, otro para instrucciones, tiempo de preparación, comensales, tipo de cocina, etc. A esto se le llama “Custom Fields”, se pueden crear a mano dentro de cada receta pero hay que crearlo cada vez y es muy engorroso.

Existe un plugin fantástico para hacer esto Advanced Custom Fields (ACF), está genial y te recomiendo tenerlo en tu caja de herramientas . Pero la idea de este tutorial es ir más alla y crear también los Campos Personalizados desde código, este es un sendero poco transitado pero que te recomiendo recorrer si quieres convertirte en un verdadero guerrero de WordPress.

Así que a partir de aquí tienes dos opciones, utilizar la vía rápida del plugin ACF o seguir aprendiendo a programar como un auténtico practicante de la disciplina.

¿Sigues conmigo? ¡Bravo! Este camino es duro pero te garantiza grandes satisfacciones.

Agregando meta boxes.

Los meta boxes son todas esas cajas de formularios que rodean normalmente el contenido de un artículo o de una página cuando estás utilizando el editor de WP. Aquí los vas a utilizar para colocar en ellos los elementos de formulario donde recogerás tus campos personalizados.

Como no podía ser menos WordPress tiene funciones para que puedas crear tus propias meta boxes. Dentro de ellas se puede colocar cualquier tipo de información: texto, imágenes, etc y también se pueden introducir campos de formulario para recoger valores.

Empieza agregando al plugin una función parar registrar una meta box con un par de campos personalizados, luego podrás añadir más. Dentro de esa función vas a llamar a la función add_meta_box de WordPress.

add_meta_box($id, $title, $callback, $screen, $context, $priority, $callback_args);

  • $id: identificador o “slug” del nuevo “meta box”.
  • $title: título que se mostrará en el “meta box”.
  • $callback: función que imprime el contenido de la “meta box”, se utiliza echo para generar la salida
  • $screen: representa la pantalla de administración en la que se mostrará esta “meta box”. En este caso debes poner “receta” para que quede asociado a este “Custom Post Type”.
  • $context y $priority: en este caso las configuras como “normal” y “high” respectivamente.

Verás que la función encargada de cargar el meta box (o los meta boxes si fueran varios) tiene un nombre un poco largo: kfp_receta_register_meta_boxes.

Lo he puesto así porque con la estructura que estamos usando para construir el plugin los nombres de función podrían entrar en conflicto con otros plugins. Imagina que has instalado otro plugin de recetas y el autor llama a su función “receta_register_meta_boxes”, en este caso ambos plugins dejarían de funcionar. Esta forma de nombrar funciones y variables es un estándar y consiste en agregar al principio el nombre o las siglas del desarrollador (en mi caso son las siglas de Kung Fu Press), seguido del nombre o alias del plugin (en esta caso “receta”) y luego viene el resto del nombre que quieras dar a la función. Si hubiéramos encapsulado el plugin en un objeto esto no sería necesario, veremos esta forma de trabajar en algún tutorial más avanzado.

Este es el código que tienes que añadir a tu plugin:

/\*\*
 \* Agrega los meta boxes para el Custom Post Type Receta
 \* https://developer.wordpress.org/reference/functions/add\_meta\_box/
 \*/
function kfp\_receta\_register\_meta\_boxes()
{
    add\_meta\_box('receta-info', 'Información', 'kfp\_receta\_output\_meta\_box', 'receta', 'normal', 'high');
}
​
/\*\*
 \* Genera el contenido que hay que mostrar dentro del meta box
 \* @param WP\_Post $post WordPress Post object
 \*/
function kfp\_receta\_output\_meta\_box($post)
{
}
​
add\_action('add\_meta\_boxes', 'kfp\_receta\_register\_meta\_boxes');
Enter fullscreen mode Exit fullscreen mode

Ahora puedes ir a tu Custom Post Type en el panel de administración y verás que cuando creas o editas un contenido de este tipo ahora aparece una meta box con el título “Información”.

A continuación tienes que rellenar el contenido de esa meta box para que sirva para algo. Para eso escribirás algo que genere una salida en pantalla dentro de la función “kfp_receta_output_meta_box”, utilizando la función echo de PHP.

/\*\*
 \* Genera el contenido que hay que mostrar dentro del meta box
 \* @param WP\_Post $post WordPress Post object
 \*/
function kfp\_receta\_output\_meta\_box($post)
{
 echo('\<label for="tiempo\_preparacion"\>' . \_\_('Tiempo de preparación', 'text\_domain') . '\</label\>');
    echo('\<input type="text" name="tiempo\_preparacion" id="tiempo\_preparacion" value="' . esc\_attr($tiempo\_preparacion) . '"\>');
 echo('\<p\>\<label for="comensales"\>' . \_\_('Comensales', 'text\_domain') . '\</label\>');
 echo('\<input type="date" name="comensales" id="fecha" value="' . esc\_attr($comensales) . '"\>');
}
Enter fullscreen mode Exit fullscreen mode

De nuevo te animo a probar el resultado en tu panel de administración para que veas que aparecen dos campos de formulario dentro de la meta box. En esta punto si intentas grabar alguna información ahí verás que no se guarda, disculpa que vaya pasito a paso pero quiero asegurarme que lo entiendes bien.

Ahora vas a añadir el código para que la información se grabe en la base de datos y para que se muestre en la meta box cada vez que abramos este registro.

Es importante comprobar que el usuario actual tiene permisos para grabar esta información y añadir también una cláusula de seguridad para evitar que alguien intente grabar información en esos campos si no viene de este formulario. Para esto último vas a usar la función wp_nonce_field que genera un campo oculto en el formulario, campo que luego comprobaremos antes de grabar la información.

/\*\*
 \* Genera el contenido que hay que mostrar dentro del meta box
 \* @param WP\_Post $post WordPress Post object
 \*/
function kfp\_receta\_output\_meta\_box($post)
{
    // Los campos se graban en la base de datos con un subrayado bajo como prefijo
    // WP indica así por defecto que son campos metas
 $tiempo\_preparacion = get\_post\_meta($post-\>ID, '\_tiempo\_preparacion', true);
    $comensales = get\_post\_meta($post-\>ID, '\_comensales', true);

 echo('\<label for="tiempo\_preparacion"\>' . \_\_('Tiempo de preparación', 'text\_domain') . '\</label\>');
    echo('\<input type="text" name="tiempo\_preparacion" id="tiempo\_preparacion" value="' . esc\_attr($tiempo\_preparacion) . '"\>');
 echo('\<p\>\<label for="comensales"\>' . \_\_('Comensales', 'text\_domain') . '\</label\>');
 echo('\<input type="number" name="comensales" id="comensales" value="' . esc\_attr($comensales) . '"\>');
}
​
/\*\*
 \* Graba los campos del formulario del meta box
 \* @param int $post\_id Post ID
 \* @return bool|int
 \*/
function kfp\_receta\_save\_meta\_boxes($post\_id)
{
    // Comprueba que el nonce es correcto para evitar ataques CSRF
    if ( !isset($\_POST['receta\_nonce']) || ! wp\_verify\_nonce( $\_POST['receta\_nonce'], 'graba\_receta') ) {
        return $post\_id;
   }
​
    // Comprueba que el tipo de post es receta
    if ('receta' != $\_POST['post\_type']) {
        return $post\_id;
   }
​
    // Comprueba que el usuario actual tiene permiso para editar esto
    if (!current\_user\_can('edit\_post', $post\_id)) {
        return $post\_id;
   }
​
    // Ahora puedes grabar los datos con tranquilidad
    // Observa que cuando vienen del formulario los campos meta no vienen con el prefijo subrayado bajo pero cuando los grabas en el post hay que poner el prefijo, igual que cuando los leías del post
    $tiempo\_preparacion = sanitize\_text\_field($\_POST['tiempo\_preparacion']);
    update\_post\_meta($post\_id, '\_tiempo\_preparacion', $tiempo\_preparacion);
 $comensales = sanitize\_text\_field($\_POST['comensales']);
 update\_post\_meta($post\_id, '\_comensales', $comensales);
    return true;
}
​
add\_action('save\_post', 'kfp\_receta\_save\_meta\_boxes');
Enter fullscreen mode Exit fullscreen mode

Con esto ya debe funcionar bien la grabación de los campos meta, prueba a rellenar los campos personalizados en tus recetas y al guardarla, si no hay ningún error, deben permanecer los valores que has introducido

Y por último habrá que mostrar esos campos que tanto esfuerzo han costado en el front end, para que puedan consultarlo tus visitantes. Esta es una solución un poco burda, pero no quiero que se alargue más el artículo metiendo conceptos relacionados con plantillas, que pondrás ver con más detenimiento en otros tutoriales. Así que lo vas a hacer también con código y desde el propio plugin.

Usarás el hook “the_content” que es el que se llama cada vez que se va a imprimir el contenido de cualquier entrada, página o post personalizado. Lo que vas a hacer es añadir al contenido principal del artículo los campos personalizados que te interesen.

function kfp\_receta\_add\_custom\_fields\_to\_content( $content ) 
{
 $custom\_fields = get\_post\_custom();
 $content .= "\<ul\>";
 if( isset( $custom\_fields['\_tiempo\_preparacion'] ) ) {
 $content .= '\<li\>Tiempo de preparación: '. $custom\_fields['\_tiempo\_preparacion'][0] . '\</li\>';
 }
 if( isset( $custom\_fields['\_comensales'] ) ) {
 $content .= '\<li\>Comensales: ' . $custom\_fields['\_comensales'][0] . '\</li\>';
 }
 $content .= '\</ul\>';
​
 return $content;
}
​
add\_filter( 'the\_content', 'kfp\_receta\_add\_custom\_fields\_to\_content' )
Enter fullscreen mode Exit fullscreen mode

Como mostrar a los visitantes tus tipos personalizados

Para esto hay mil métodos, creo que uno muy deseable es que las recetas aparezcan en la página de inicio, vas a decirle al plugin que cuando WP vaya a buscar los artículos para la página de inicio se traiga también las recetas.

_/\*\*  
 \* Agrega el tipo personalizado Receta a la página inicial de WP  
 \*/_ function get\_posts\_y\_recetas( $query ) {
 if ( is\_home() && $query-\>is\_main\_query() ) {
 $query-\>set( 'post\_type', array( 'post', 'receta' ) );
 }

 return $query;
}

add\_filter( 'pre\_get\_posts', 'get\_posts\_y\_recetas' )
Enter fullscreen mode Exit fullscreen mode

Carga ahora tu página de inicio y verás como tus posts y recetas aparecen publicados en ellas.

No te lo quedes dentro

¿Todo ha funcionado? Dímelo y te mando el cinturón amarillo desde ya.

¿Algo no te funciona? Házmelo saber en los comentario e intento ayudarte. Si ves algún fallo también te agradeceré mucho que me lo digas.

Si te ha gustado o te ha sido útil, te animo a compartirlo con otros a quien pueda interesarle, en las redes sociales, cantando el artículo mientras te duchas, gritándolo a los cuatro vientos o de cualquier otra manera que se te ocurra.

Y si quieres seguir haciendo cosas divertidas y útiles con WordPress acepto cualquier sugerencia para seguir escribiendo artículos.

Enlaces de referencia

Top comments (0)