El siguiente archivo que vamos a crear es widgets.php que generará un widget para mostrar diferentes tipos de contenido, como citas estados, etc.

 

WIDGETS.PHP

Creamos el archivo inc/widgets.php y añadimos el siguiente código:

  1. <?php
  2.  
  3. /**
  4.  * Makes a custom Widget for displaying Aside, Link, Status, and Quote Posts available with New Theme
  5.  *
  6.  * Learn more: http://codex.wordpress.org/Widgets_API#Developing_Widgets
  7.  *
  8.  * @package WordPress
  9.  * @subpackage Nwe_Theme
  10.  */
  11. class New_Theme_Ephemera_Widget extends WP_Widget {
  12.  
  13. }

Creamos la clase New_Theme_Ephemera_Widget que nos permitirá crear el widget.

Dentro de la clase añadimos los siguientes métodos.

  1. <?php
  2.  
  3. /**
  4. * Constructor
  5. *
  6. * @return void
  7. **/
  8. function New_Theme_Ephemera_Widget() {
  9. $widget_ops = array( 'classname' => 'widget_newtheme_ephemera', 'description' => __( 'Use this widget to list your recent Aside, Status, Quote, and Link posts', 'newtheme' ) );
  10. $this->WP_Widget( 'widget_newtheme_ephemera', __( 'New Theme Ephemera', 'newtheme' ), $widget_ops );
  11. $this->alt_option_name = 'widget_newtheme_ephemera';
  12.  
  13. add_action( 'save_post', array(&$this, 'flush_widget_cache' ) );
  14. add_action( 'deleted_post', array(&$this, 'flush_widget_cache' ) );
  15. add_action( 'switch_theme', array(&$this, 'flush_widget_cache' ) );
  16. }

Este método es el constructor del widget, le indica a WordPress la clase que utilizará, la desripción y el nombre del widget. Además se añaden varias acciones para volver a generar la cache cuando se guarde o elimine un post o cuando se cambie de tema.

  1. <?php
  2.  
  3. /**
  4. * Outputs the HTML for this widget.
  5. *
  6. * @param array An array of standard parameters for widgets in this theme
  7. * @param array An array of settings for this widget instance
  8. * @return void Echoes it's output
  9. **/
  10. function widget( $args, $instance ) {
  11. $cache = wp_cache_get( 'widget_newtheme_ephemera', 'widget' );
  12.  
  13. if ( !is_array( $cache ) )
  14. $cache = array();
  15.  
  16. if ( ! isset( $args['widget_id'] ) )
  17. $args['widget_id'] = null;
  18.  
  19. if ( isset( $cache[$args['widget_id']] ) ) {
  20. echo $cache[$args['widget_id']];
  21. return;
  22. }
  23.  
  24. extract( $args, EXTR_SKIP );
  25.  
  26. $title = apply_filters( 'widget_title', empty( $instance['title'] ) ? __( 'Ephemera', 'newtheme' ) : $instance['title'], $instance, $this->id_base);
  27.  
  28. if ( ! isset( $instance['number'] ) )
  29. $instance['number'] = '10';
  30.  
  31. if ( ! $number = absint( $instance['number'] ) )
  32. $number = 10;
  33.  
  34. $ephemera_args = array(
  35. 'order' => 'DESC',
  36. 'posts_per_page' => $number,
  37. 'no_found_rows' => true,
  38. 'post_status' => 'publish',
  39. 'post__not_in' => get_option( 'sticky_posts' ),
  40. 'tax_query' => array(
  41. 'taxonomy' => 'post_format',
  42. 'terms' => array( 'post-format-aside', 'post-format-link', 'post-format-status', 'post-format-quote' ),
  43. 'field' => 'slug',
  44. 'operator' => 'IN',
  45. ),
  46. ),
  47. );
  48. $ephemera = new WP_Query( $ephemera_args );
  49.  
  50. if ( $ephemera->have_posts() ) :
  51. echo $before_widget;
  52. echo $before_title;
  53. echo $title; // Can set this with a widget option, or omit altogether
  54. echo $after_title;
  55. ?>
  56. <ol>
  57. <?php while ( $ephemera->have_posts() ) : $ephemera->the_post(); ?>
  58.  
  59. <?php if ( 'link' != get_post_format() ) : ?>
  60.  
  61. <li class="widget-entry-title">
  62. <a href="<?php echo esc_url( get_permalink() ); ?>" title="<?php printf( esc_attr__( 'Permalink to %s', 'newtheme' ), the_title_attribute( 'echo=0' ) ); ?>" rel="bookmark"><?php the_title(); ?></a>
  63. <span class="comments-link">
  64. <?php comments_popup_link( __( '0 <span class="reply">comments &rarr;</span>', 'newtheme' ), __( '1 <span class="reply">comment &rarr;</span>', 'newtheme' ), __( '% <span class="reply">comments &rarr;</span>', 'newtheme' ) ); ?>
  65. </span>
  66. </li>
  67.  
  68. <?php else : ?>
  69.  
  70. <li class="widget-entry-title">
  71. <?php
  72. // Grab first link from the post content. If none found, use the post permalink as fallback.
  73. $link_url = newtheme_url_grabber();
  74.  
  75. if ( empty( $link_url ) )
  76. $link_url = get_permalink();
  77. ?>
  78. <a href="<?php echo esc_url( $link_url ); ?>" title="<?php printf( esc_attr__( 'Link to %s', 'newtheme' ), the_title_attribute( 'echo=0' ) ); ?>" rel="bookmark"><?php the_title(); ?>&nbsp;<span>&rarr;</span></a>
  79. <span class="comments-link">
  80. <?php comments_popup_link( __( '0 <span class="reply">comments &rarr;</span>', 'newtheme' ), __( '1 <span class="reply">comment &rarr;</span>', 'newtheme' ), __( '% <span class="reply">comments &rarr;</span>', 'newtheme' ) ); ?>
  81. </span>
  82. </li>
  83.  
  84. <?php endif; ?>
  85.  
  86. <?php endwhile; ?>
  87. </ol>
  88. <?php
  89.  
  90. echo $after_widget;
  91.  
  92. // Reset the post globals as this query will have stomped on it
  93. wp_reset_postdata();
  94.  
  95. // end check for ephemeral posts
  96. endif;
  97.  
  98. $cache[$args['widget_id']] = ob_get_flush();
  99. wp_cache_set( 'widget_newtheme_ephemera', $cache, 'widget' );
  100. }

Este método es un poco largo, así que voy a dividirlo y explicar el código.

  1. <?php
  2.  
  3. $cache = wp_cache_get( 'widget_newtheme_ephemera', 'widget' );
  4.  
  5. if ( !is_array( $cache ) )
  6. $cache = array();
  7.  
  8. if ( ! isset( $args['widget_id'] ) )
  9. $args['widget_id'] = null;
  10.  
  11. if ( isset( $cache[$args['widget_id']] ) ) {
  12. echo $cache[$args['widget_id']];
  13. return;
  14. }

Primero recuperamos los datos del widget desde la caché de WordPress.

Comprobamos que en caso de que no sea un array le damos el valor de un array vacío.

Comprobamos también que $args[‘widget_id’] no esta establecido y le damos el valor null.

Por último comprobamos que la caché disponga de algún contenido para el widget, si es así se muestra ese contenido y se devuelve un return para que php no siga ejecutando el método.

  1. <?php
  2.  
  3. extract( $args, EXTR_SKIP );
  4.  
  5. $title = apply_filters( 'widget_title', empty( $instance['title'] ) ? __( 'Ephemera', 'newtheme' ) : $instance['title'], $instance, $this->id_base);
  6.  
  7. if ( ! isset( $instance['number'] ) )
  8. $instance['number'] = '10';
  9.  
  10. if ( ! $number = absint( $instance['number'] ) )
  11. $number = 10;
  12.  
  13. $ephemera_args = array(
  14. 'order' => 'DESC',
  15. 'posts_per_page' => $number,
  16. 'no_found_rows' => true,
  17. 'post_status' => 'publish',
  18. 'post__not_in' => get_option( 'sticky_posts' ),
  19. 'tax_query' => array(
  20. 'taxonomy' => 'post_format',
  21. 'terms' => array( 'post-format-aside', 'post-format-link', 'post-format-status', 'post-format-quote' ),
  22. 'field' => 'slug',
  23. 'operator' => 'IN',
  24. ),
  25. ),
  26. );
  27. $ephemera = new WP_Query( $ephemera_args );

En el caso de que no haya contenido en la caché de WordPress, el método continuará ejecutandose.

En este extracto de código vemos como primero se abre el buffer de php utilizando la función ob_start(). Esta función permite que en vez de mostrar cualquier contenido que le siguiente, lo almacena en buffer para después poder mostrarlo donde corresponda con ob_get_flush().

A continuación se recupera el título y el número de post a mostrar.

Se crea un array con los parámetros para ejecutar una consulta SQL.

Por último se crea una nueva instancia de WP_Query() que devolverá los registros encontrados en la base de datos.

  1. <?php
  2.  
  3. if ( $ephemera->have_posts() ) :
  4. echo $before_widget;
  5. echo $before_title;
  6. echo $title; // Can set this with a widget option, or omit altogether
  7. echo $after_title;
  8. ?>
  9. <ol>
  10. <?php while ( $ephemera->have_posts() ) : $ephemera->the_post(); ?>
  11.  
  12. <?php if ( 'link' != get_post_format() ) : ?>
  13.  
  14. <li class="widget-entry-title">
  15. <a href="<?php echo esc_url( get_permalink() ); ?>" title="<?php printf( esc_attr__( 'Permalink to %s', 'newtheme' ), the_title_attribute( 'echo=0' ) ); ?>" rel="bookmark"><?php the_title(); ?></a>
  16. <span class="comments-link">
  17. <?php comments_popup_link( __( '0 <span class="reply">comments &rarr;</span>', 'newtheme' ), __( '1 <span class="reply">comment &rarr;</span>', 'newtheme' ), __( '% <span class="reply">comments &rarr;</span>', 'newtheme' ) ); ?>
  18. </span>
  19. </li>
  20.  
  21. <?php else : ?>
  22.  
  23. <li class="widget-entry-title">
  24. <?php
  25. // Grab first link from the post content. If none found, use the post permalink as fallback.
  26. $link_url = newtheme_url_grabber();
  27.  
  28. if ( empty( $link_url ) )
  29. $link_url = get_permalink();
  30. ?>
  31. <a href="<?php echo esc_url( $link_url ); ?>" title="<?php printf( esc_attr__( 'Link to %s', 'newtheme' ), the_title_attribute( 'echo=0' ) ); ?>" rel="bookmark"><?php the_title(); ?>&nbsp;<span>&rarr;</span></a>
  32. <span class="comments-link">
  33. <?php comments_popup_link( __( '0 <span class="reply">comments &rarr;</span>', 'newtheme' ), __( '1 <span class="reply">comment &rarr;</span>', 'newtheme' ), __( '% <span class="reply">comments &rarr;</span>', 'newtheme' ) ); ?>
  34. </span>
  35. </li>
  36.  
  37. <?php endif; ?>
  38.  
  39. <?php endwhile; ?>
  40. </ol>
  41. <?php
  42.  
  43. echo $after_widget;
  44.  
  45. // Reset the post globals as this query will have stomped on it
  46. wp_reset_postdata();
  47.  
  48. // end check for ephemeral posts
  49. endif;

Se comprueba si existen post para mostrar y si es que sí se muestran diferentes valores antes de iniciar el búcle que dará formato al contenido.

Se muestra cualquier contenido posterior al widget, se reincian los post globales que esta consulta haya podido pisar.

  1. <?php
  2.  
  3. $cache[$args['widget_id']] = ob_get_flush();
  4. wp_cache_set( 'widget_newtheme_ephemera', $cache, 'widget' );

Por último se guardan los datos del buffer en la caché de WordPress.

  1. <?php
  2.  
  3. /**
  4. * Deals with the settings when they are saved by the admin. Here is
  5. * where any validation should be dealt with.
  6. **/
  7. function update( $new_instance, $old_instance ) {
  8. $instance = $old_instance;
  9. $instance['title'] = strip_tags( $new_instance['title'] );
  10. $instance['number'] = (int) $new_instance['number'];
  11. $this->flush_widget_cache();
  12.  
  13. $alloptions = wp_cache_get( 'alloptions', 'options' );
  14. if ( isset( $alloptions['widget_newtheme_ephemera'] ) )
  15. delete_option( 'widget_newtheme_ephemera' );
  16.  
  17. return $instance;
  18. }

Este método permite verificar que los datos que ha introducido el administrador sean correctos y se guarden en la caché para futuros usos.

  1. <?php
  2.  
  3. function flush_widget_cache() {
  4. wp_cache_delete( 'widget_newtheme_ephemera', 'widget' );
  5. }

Este método elimina el widget de la caché de WordPress.

  1. <?php
  2.  
  3. /**
  4. * Displays the form for this widget on the Widgets page of the WP Admin area.
  5. **/
  6. function form( $instance ) {
  7. $title = isset( $instance['title']) ? esc_attr( $instance['title'] ) : '';
  8. $number = isset( $instance['number'] ) ? absint( $instance['number'] ) : 10;
  9. ?>
  10. <p><label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php _e( 'Title:', 'newtheme' ); ?></label>
  11. <input class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" /></p>
  12.  
  13. <p><label for="<?php echo esc_attr( $this->get_field_id( 'number' ) ); ?>"><?php _e( 'Number of posts to show:', 'newtheme' ); ?></label>
  14. <input id="<?php echo esc_attr( $this->get_field_id( 'number' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'number' ) ); ?>" type="text" value="<?php echo esc_attr( $number ); ?>" size="3" /></p>
  15. <?php
  16. }

Este último método crea el formulario donde el administrador podrá modificar el widget.