W artykule „Zliczanie liczby wyświetleń postów bez użycia pluginu w WordPressie” opisałem w jaki sposób można zliczać liczbę odsłon danego artykułu przechowując ją w metadanych wpisu. Informacje te można wykorzystać na różne sposoby. Możemy oczywiście po prostu wyświetlić na stronie liczbę odsłon. Ale możemy również na podstawie tych danych zbudować widget „Najpopularniejsze posty”. W tym artykule pokażę krok po kroku jak się za to zabrać.

Na początku przechodzimy do katalogu szablonu, którego używamy na blogu (np. twentyfifteen) i dla lepszego porządku tworzymy w nim podkatalog o nazwie np. widgets (oczywiście jeśli go nie ma). Następnie w nowo utworzonym folderze tworzymy nowy plik PHP, w którym będziemy budować nasz widget. Może on mieć dowolną nazwę ja wybrałem najpopularniejsze-posty-widget.php. Teraz pozostało otworzyć nowo utworzony przez nas plik w edytorze tekstu i przystąpić do pracy.
Zgodnie z dokumentacją developer.wordpress.org/themes/functionality/widgets tworzenie naszego widgetu rozpoczynamy od wklejenia w pliku najpopularniejsze-posty-widget.php takiego kodu:
<?php
class My_Widget extends WP_Widget {
/**
* Sets up the widgets name etc
*/
public function __construct() {
// widget actual processes
}
/**
* Outputs the content of the widget
*
* @param array $args
* @param array $instance
*/
public function widget( $args, $instance ) {
// outputs the content of the widget
}
/**
* Outputs the options form on admin
*
* @param array $instance The widget options
*/
public function form( $instance ) {
// outputs the options form on admin
}
/**
* Processing widget options on save
*
* @param array $new_instance The new options
* @param array $old_instance The previous options
*/
public function update( $new_instance, $old_instance ) {
// processes widget options to be saved
}
}
?>To jest szkielet widgetu na którym będziemy dalej pracować.
Na początku zmieniamy nazwę klasy z My_Widget na powiedzmy najpopularniejszePostyWidget:
class najpopularniejszePostyWidget extends WP_Widget {Utworzona przez nas nowa klasa jest oczywiście rozszerzeniem klasy systemowej WP_Widget.
Kiedy uporaliśmy się z powyższym punktem przyszła pora aby zająć się konstruktorem. Musimy tam ustawić najważniejsze parametry naszego widgetu takie jak: $widget_id, $widget_name oraz $widget_opt. Gotowy kod będzie wyglądał tak:
public function __construct() {
$widget_id = 'najpoularniejszePosty';
$widget_name = __('Widget z najpopularniejszymi postami', 'najpopularniejszePosty');
$widget_opt = array('description' => 'Ten widget wyświetla najpouplarniejsze posty na blogu.');
parent::__construct($widget_id, $widget_name, $widget_opt);
}W tym momencie tworzony przez nas widget działa już poprawnie ale nic nie robi. Aby „zobaczyć” go w panelu administracyjnym WordPress’a musimy przejść do pliku functions.php używanego szablonu i zarejestrować nowy widget:
function najpopularniejszePosty_init()
{
require get_template_directory() . '/widgets/najpopularniejsze-posty-widget.php';
register_widget( 'najpopularniejszePostyWidget' ); //nazwa utworzonej klasy
}
add_action( 'widgets_init', 'najpopularniejszePosty_init' ); //nazwa wyżej utworzonej funkcjiW zakładce Widgety będziemy mieli teraz taką opcję:

A po przeciągnięciu widgetu „Widget z najpopularniejszymi postami” na wybrany sidebar ukaże się nam coś takiego:

Jak widać na screenie z poprzedniej strony nie możemy na razie ustawić, żadnych opcji wyświetlania najpopularniejszych wpisów, nawet tytułu widgetu. Pora więc to zmienić. Odpowiedzialna za to jest funkcja form(). Będziemy w niej musieli napisać cały formularz do obsługi tworzonego przez nas widgetu.
Na początku ustawiamy opcje domyślne takie jak wyświetlanie początku wpisu, liczby odsłon, ikony wpisu oraz oczywiście domyślny tytuł:
/**
* Outputs the options form on admin
*
* @param array $instance The widget options
*/
public function form( $instance ) {
//set default options
$my_defaults = array(
'number' => 5,
'title' => 'Najpouplarniejsze posty',
'show_count' => false, //pokarz liczbę wyświetleń
'show_excerpt' => false, //pokarz początek wpisu
'show_thumbnail' => false //pokarz ikonę wpisu
);
//Refill options stored in the database with the default options.
$instance = wp_parse_args( (array) $instance, $my_defaults );
}Kolejnym krokiem jest stworzenie formularza. Nie będę się tutaj rozwodził nad kodem, po prostu piszemy zwykły formularz w HTMLu i PHP (jeżeli ktoś ma jakieś pytania to odsyłam do komentarzy):
<p>
<!-- Widgets name !-->
<label for="<?php echo $this->get_field_id('title'); ?>"><?php _e( 'Tytuł:' ); ?></label>
<input class="widefat" id="<?php echo $this->get_field_id('title'); ?>" name="<?php echo $this->get_field_name('title'); ?>" type="text" value="<?php echo esc_attr($instance['title']); ?>" />
</p>
<p>
<!-- Number of posts to show !-->
<label for="<?php echo $this->get_field_id( 'number' ); ?>"><?php _e( 'Liczba wyświetlanych postów:' ); ?></label>
<input id="<?php echo $this->get_field_id( 'number' ); ?>" name="<?php echo $this->get_field_name( 'number' ); ?>" type="text" value="<?php echo $instance['number']; ?>" size="3" />
</p>
<p>
<!-- Show view counts !-->
<input class="checkbox" type="checkbox" name="<?php echo $this->get_field_name('show_count'); ?>" id="<?php echo $this->get_field_id('show_count'); ?>" value="true" <?php checked(true, $instance['show_count']);?> />
<label for="<?php echo $this->get_field_id('show_count'); ?>"> <?php _e( 'Wyświetl liczbę wyświetleń' ); ?></label><br />
</p>
<p>
<!-- Show excerpt !-->
<input class="checkbox" type="checkbox" name="<?php echo $this->get_field_name('show_excerpt'); ?>" id="<?php echo $this->get_field_id('show_excerpt'); ?>" value="true" <?php checked(true, $instance['show_excerpt']);?> />
<label for="<?php echo $this->get_field_id('show_excerpt'); ?>"> <?php _e( 'Wyświetl początek wpisu' ); ?></label><br />
</p>
<p>
<!-- Show thumbnail !-->
<input class="checkbox" type="checkbox" name="<?php echo $this->get_field_name('show_thumbnail'); ?>" id="<?php echo $this->get_field_id('show_thumbnail'); ?>" value="true" <?php checked(true, $instance['show_thumbnail']);?> />
<label for="<?php echo $this->get_field_id('show_thumbnail'); ?>"> <?php _e( 'Wyświetl ikonę wpisu' ); ?></label><br />
</p>Cała funkcja form():
/**
* Outputs the options form on admin
*
* @param array $instance The widget options
*/
public function form( $instance ) {
//set default options
$my_defaults = array(
'number' => 5,
'title' => 'Najpouplarniejsze posty',
'show_count' => false, //pokarz liczbę wyświetleń
'show_excerpt' => false, //pokarz początek wpisu
'show_thumbnail' => false //pokarz ikonę wpisu
);
//Refill options stored in the database with the default options.
$instance = wp_parse_args( (array) $instance, $my_defaults );
?>
<p>
<!-- Widgets name !-->
<label for="<?php echo $this->get_field_id('title'); ?>"><?php _e( 'Tytuł:' ); ?></label>
<input class="widefat" id="<?php echo $this->get_field_id('title'); ?>" name="<?php echo $this->get_field_name('title'); ?>" type="text" value="<?php echo esc_attr($instance['title']); ?>" />
</p>
<p>
<!-- Number of posts to show !-->
<label for="<?php echo $this->get_field_id( 'number' ); ?>"><?php _e( 'Liczba wyświetlanych postów:' ); ?></label>
<input id="<?php echo $this->get_field_id( 'number' ); ?>" name="<?php echo $this->get_field_name( 'number' ); ?>" type="text" value="<?php echo $instance['number']; ?>" size="3" />
</p>
<p>
<!-- Show view counts !-->
<input class="checkbox" type="checkbox" name="<?php echo $this->get_field_name('show_count'); ?>" id="<?php echo $this->get_field_id('show_count'); ?>" value="true" <?php checked(true, $instance['show_count']);?> />
<label for="<?php echo $this->get_field_id('show_count'); ?>"> <?php _e( 'Wyświetl liczbę wyświetleń' ); ?></label><br />
</p>
<p>
<!-- Show excerpt !-->
<input class="checkbox" type="checkbox" name="<?php echo $this->get_field_name('show_excerpt'); ?>" id="<?php echo $this->get_field_id('show_excerpt'); ?>" value="true" <?php checked(true, $instance['show_excerpt']);?> />
<label for="<?php echo $this->get_field_id('show_excerpt'); ?>"> <?php _e( 'Wyświetl początek wpisu' ); ?></label><br />
</p>
<p>
<!-- Show thumbnail !-->
<input class="checkbox" type="checkbox" name="<?php echo $this->get_field_name('show_thumbnail'); ?>" id="<?php echo $this->get_field_id('show_thumbnail'); ?>" value="true" <?php checked(true, $instance['show_thumbnail']);?> />
<label for="<?php echo $this->get_field_id('show_thumbnail'); ?>"> <?php _e( 'Wyświetl ikonę wpisu' ); ?></label><br />
</p>
<?php
}Teraz możemy znowu przejść do panelu administracyjnego WordPress’a. Kiedy odświeżymy stronę z widgetami zobaczymy, że pojawił się formularz do personalizacji wyglądu naszego widgetu:

Żeby nasze dane wprowadzone w formularzu utworzonym na poprzedniej stronie dało się zaktualizować należy wprowadzić drobne modyfikacje w funkcji update():
/**
* Processing widget options on save
*
* @param array $new_instance The new options
* @param array $old_instance The previous options
*/
public function update( $new_instance, $old_instance ) {
$instance = $old_instance;
//Widgets name
$instance['title'] = strip_tags($new_instance['title']);
//Number of posts to show
$instance['number'] = absint($new_instance['number']);
//Show view counts
$instance['show_count'] = isset($new_instance['show_count']);
//Show excerpt
$instance['show_excerpt'] = isset($new_instance['show_excerpt']);
//Show thumbnail
$instance['show_thumbnail'] = isset($new_instance['show_thumbnail']);
return $instance;
}Teraz możemy przejść do ostatniego elementu czyli funkcji widget(), która odpowiedzialna jest za wyświetlanie odpowiednich danych bezpośrednio na stronie WWW.
Zanim zabierzemy się za tworzenie tej części widgetu przypominam, że najpierw należy zmodyfikować odpowiednio szablon, tak aby w metadanych były zliczane odsłony danego artykułu. Instrukcja jak to zrobić znajduje się w moim poprzednim wpisie „Zliczanie liczby wyświetleń postów bez użycia pluginu w WordPressie„.
Jeśli wszystko jest już przygotowane możemy przejść do kodu:
public function widget( $args, $instance ) {
$title = apply_filters('widget_title', $instance['title']);
if (empty($title))
{
$title = __('Najpopularniejsze posty', 'najpoularniejszePosty');
}
echo $args['before_widget'];
echo $args['before_title'] . esc_html($title) . $args['after_title'];
$arg = array(
'posts_per_page' => $instance['number'], //liczba postów do wyświetlenia
'meta_key' => 'post_views_count', //liczba odsłon
'orderby' => 'meta_value_num' //sortowanie
);
$popular_posts = get_posts($arg);
global $post;
?>
<?php
}Powyżej ustawiliśmy domyślny tytuł widgetu w przypadku skasowania danych z odpowiedniego pola formularza personalizacyjnego, został również przygotowany nagłówek wyświetlający tytuł widgetu na stronie oraz w zmiennej $popular_posts zapisaliśmy najpopularniejsze posty posortowane według liczby odsłon.
W kolejnym kroku napiszemy pętlę foreach za pomocą której wyświetlimy nasze posty:
<div class="posts">
<?php foreach($popular_posts as $post) : ?>
<?php setup_postdata( $post ); ?>
<div class="articles">
<article>
<?php if ($instance['show_thumbnail'] == TRUE && has_post_thumbnail()): ?>
<div class="post-head">
<?php the_post_thumbnail('medium'); ?>
</div>
<?php endif; ?>
<div>
<h3 class="post-title"><a href="<?php the_permalink(); ?>">
<?php the_title(); ?></a>
<?php if( $instance['show_count'] == TRUE ) : ?>
<span>
<?php
echo "Wyświetlenia: " . get_post_meta($post->ID, 'post_views_count', true);
?>
</span>
<?php
endif; ?>
</h3>
<?php if( $instance['show_excerpt'] == TRUE ) : ?>
<?php echo get_the_excerpt(); ?>
<?php endif; ?>
</div>
</article>
</div>
<?php endforeach; ?>
</div>Jak widać w kodzie zamieściliśmy również instrukcje warunkowe (IF) gdzie sprawdzamy opcje wyświetlania jakie zostały wybrane przez użytkownika i w zależności od wybranych ustawień decydujemy czy dany element ma zostać pokazany.
Oczywiście kod HTML można sobie sformatować według własnych preferencji.
Widget „Najpopularniejsze posty” jest już gotowy do użycia.
Cały kod z pliku najpopularniejsze-posty-widget.php:
<?php
class najpopularniejszePostyWidget extends WP_Widget {
/**
* Sets up the widgets name etc
*/
public function __construct() {
$widget_id = 'najpoularniejszePosty';
$widget_name = __('Widget z najpopularniejszymi postami', 'najpopularniejszePosty');
$widget_opt = array('description' => 'Ten widget wyświetla najpouplarniejsze posty na blogu.');
parent::__construct($widget_id, $widget_name, $widget_opt);
}
/**
* Outputs the content of the widget
*
* @param array $args
* @param array $instance
*/
public function widget( $args, $instance ) {
$title = apply_filters('widget_title', $instance['title']);
if (empty($title))
{
$title = __('Most popular posts', 'najpoularniejszePosty');
}
echo $args['before_widget'];
echo $args['before_title'] . esc_html($title) . $args['after_title'];
$arg = array(
'posts_per_page' => $instance['number'],
'meta_key' => 'post_views_count',
'orderby' => 'meta_value_num'
);
$popular_posts = get_posts($arg);
global $post;
?>
<div class="posts">
<?php foreach($popular_posts as $post) : ?>
<?php setup_postdata( $post ); ?>
<div class="my-articles">
<article>
<?php if ($instance['show_thumbnail'] == TRUE && has_post_thumbnail()): ?>
<div class="post-head">
<?php the_post_thumbnail('medium'); ?>
</div>
<?php endif; ?>
<div>
<h3 class="post-title"><a href="<?php the_permalink(); ?>">
<?php the_title(); ?></a>
<?php if( $instance['show_count'] == TRUE ) : ?>
<span>
<?php
echo "Wyświetlenia: " . get_post_meta($post->ID, 'post_views_count', true);
?>
</span>
<?php
endif; ?>
</h3>
<?php if( $instance['show_excerpt'] == TRUE ) : ?>
<?php echo get_the_excerpt(); ?>
<?php endif; ?>
</div>
</article>
</div>
<?php endforeach; ?>
</div>
<?php
}
/**
* Outputs the options form on admin
*
* @param array $instance The widget options
*/
public function form( $instance ) {
//set default options
$my_defaults = array(
'number' => 5,
'title' => 'Najpouplarniejsze posty',
'show_count' => false, //pokarz liczbę wyświetleń
'show_excerpt' => false, //pokarz początek wpisu
'show_thumbnail' => false //pokarz ikonę wpisu
);
//Refill options stored in the database with the default options.
$instance = wp_parse_args( (array) $instance, $my_defaults );
?>
<p>
<!-- Widgets name !-->
<label for="<?php echo $this->get_field_id('title'); ?>"><?php _e( 'Tytuł:' ); ?></label>
<input class="widefat" id="<?php echo $this->get_field_id('title'); ?>" name="<?php echo $this->get_field_name('title'); ?>" type="text" value="<?php echo esc_attr($instance['title']); ?>" />
</p>
<p>
<!-- Number of posts to show !-->
<label for="<?php echo $this->get_field_id( 'number' ); ?>"><?php _e( 'Liczba wyświetlanych postów:' ); ?></label>
<input id="<?php echo $this->get_field_id( 'number' ); ?>" name="<?php echo $this->get_field_name( 'number' ); ?>" type="text" value="<?php echo $instance['number']; ?>" size="3" />
</p>
<p>
<!-- Show view counts !-->
<input class="checkbox" type="checkbox" name="<?php echo $this->get_field_name('show_count'); ?>" id="<?php echo $this->get_field_id('show_count'); ?>" value="true" <?php checked(true, $instance['show_count']);?> />
<label for="<?php echo $this->get_field_id('show_count'); ?>"> <?php _e( 'Wyświetl liczbę wyświetleń' ); ?></label><br />
</p>
<p>
<!-- Show excerpt !-->
<input class="checkbox" type="checkbox" name="<?php echo $this->get_field_name('show_excerpt'); ?>" id="<?php echo $this->get_field_id('show_excerpt'); ?>" value="true" <?php checked(true, $instance['show_excerpt']);?> />
<label for="<?php echo $this->get_field_id('show_excerpt'); ?>"> <?php _e( 'Wyświetl początek wpisu' ); ?></label><br />
</p>
<p>
<!-- Show thumbnail !-->
<input class="checkbox" type="checkbox" name="<?php echo $this->get_field_name('show_thumbnail'); ?>" id="<?php echo $this->get_field_id('show_thumbnail'); ?>" value="true" <?php checked(true, $instance['show_thumbnail']);?> />
<label for="<?php echo $this->get_field_id('show_thumbnail'); ?>"> <?php _e( 'Wyświetl ikonę wpisu' ); ?></label><br />
</p>
<?php
}
/**
* Processing widget options on save
*
* @param array $new_instance The new options
* @param array $old_instance The previous options
*/
public function update( $new_instance, $old_instance ) {
$instance = $old_instance;
//Widgets name
$instance['title'] = strip_tags($new_instance['title']);
//Number of posts to show
$instance['number'] = absint($new_instance['number']);
//Show view counts
$instance['show_count'] = isset($new_instance['show_count']);
//Show excerpt
$instance['show_excerpt'] = isset($new_instance['show_excerpt']);
//Show thumbnail
$instance['show_thumbnail'] = isset($new_instance['show_thumbnail']);
return $instance;
}
}
?>Przykładowy efekt:




// brak komentarzy — bądź pierwszy