WordPress как на ладони
Новые WordPress шаблоны Хостинг, VPS/VDS и отдельные сервера только на SSD дисках. 7 дней бесплатного тестирования.

WP_Widget_Archives{} WP 2.8.0

Класс ядра для реализации виджета "Архивы".

Виджет регистрируется с помощью функции register_widget():

register_widget( 'WP_Widget_Archives' );

Наряду с классическим выводом виджета в сайдбаре, виджет также можно вывести с помощью функции the_widget() в любом месте шаблона:

<?php the_widget( 'WP_Widget_Archives' ); ?>

Наследуется от класса WP_Widget().

Внешний вид виджета "Архивы" в админке
при размещении в области виджетов

Внешний вид зависит от темы, но как правило виджет в лицевой части сайта выглядит так:

Хуки из класса:
Возвращает

Ничего (null).

Использование

$WP_Widget_Archives = new WP_Widget_Archives();
// use class methods

Методы

__construct()
Устанавливает экземпляр виджета.
form($instance)
Выводит форму с вводом настроек виджета (в админке).
update($new_instance, $old_instance)
Управляет обновлением настроек виджета.
widget($args, $instance)
Выводит контент виджета (в лицевой части сайта).

Содержимое, которое виджет "Архивы" генерирует в лицевой части сайта, формируется с помощью функции wp_get_archives(). Из этого следует, что все параметры, которые принимает эта функция, можно передать на хуках-фильтрах widget_archives_dropdown_args и widget_archives_args для кастомизации.

Примеры

#1 Виджет архивов товаров WooCommerce

Если не нужен дефолтный виджет "Архивы", который по умолчанию отображает архивы записей, то можно с помощью хук-фильтров отображать архивы товаров WooCommerce. Внешний вид будет такой же, как и у записей, только при выборе месяца (по умолчанию) пользователь будет переходить на архив товаров, опубликованных в этом месяце.

add_filter( 'widget_archives_dropdown_args', 'wc_widget_archives_args' ); // Для выпадающего списка
add_filter( 'widget_archives_args', 'wc_widget_archives_args' ); // Для маркерованного списка

function wc_widget_archives_args( $args ) {
	$args['post_type'] = 'product';

	return $args;
}

#2 Виджет архивов по дням

Если на сайте записи часто публикуются, то можно вывести архивы по дням и ограничить по количеству выводимых дней.

add_filter( 'widget_archives_dropdown_args', 'widget_archives_days' );

function wc_add_widget_archives_dropdown_args( $args ) {
	$args['type']  = 'daily';
	$args['limit'] = 5;

	return $args;
}

#3 Создаем улучшенный виджет архивов

В лицевой части сайта выпадающий или маркерованный список формируется с помощью функции wp_get_archives(), которая может принимать больше параметров, чем можно указать в стандартном виджете "Архивы". Создадим свой виджет "Улучшенные архивы" на основе виджета "Архивы", где предусмотрим выбор:

  • какой тип архива (по годам, по месяцам, по неделям и так далее);
  • сколько ссылок отображать;
  • создавать ссылки на архивы какого типа записи.

<?php

add_action( 'widgets_init', 'register_widget_archives_advanced' );

function register_widget_archives_advanced() {

	class WP_Widget_Archives_Advanced extends WP_Widget_Archives {

		public $default = [ 'type' => 'monthly', 'limit' => '', 'post_type' => 'post', ];

		public function __construct() {
			$widget_ops = [
				'description' => 'Улучшенный виджет с архивами.',
			];

			WP_Widget::__construct( 'archives_advanced', 'Улучшенные архивы', $widget_ops );
		}

		// html форма настроек виджета в Админ-панели
		public function form( $instance ) {
			parent::form( $instance );

			$instance = wp_parse_args( (array) $instance, $this->default );

			$options = [
				'monthly'    => 'По месяцам',
				'yearly'     => 'По годам',
				'daily'      => 'По дням',
				'weekly'     => 'По неделям',
				'postbypost' => 'По постам (сорт. по дате)',
				'alpha'      => 'По постам (сорт. по заголовку)',
			];
			?>
			<p>
				<label for="<?php echo $this->get_field_id( 'type' ); ?>">Тип архива</label>
				<select name="<?php echo $this->get_field_name( 'type' ); ?>"
						id="<?php echo $this->get_field_id( 'type' ); ?>"
						class="widefat"
				>
					<?php foreach ( $options as $value => $text ): ?>
						<option value="<?php echo esc_attr( $value ); ?>"<?php selected( $instance['type'], $value ); ?>>
							<?php echo esc_html( $text ); ?>
						</option>
					<?php endforeach; ?>
				</select>
			</p>

			<p>
				<label for="<?php echo $this->get_field_id( 'limit' ); ?>">Количество ссылок на архивы</label>
				<input type="number"
					   name="<?php echo $this->get_field_name( 'limit' ); ?>"
					   id="<?php echo $this->get_field_id( 'limit' ); ?>"
					   class="widefat"
					   value="<?php echo isset( $instance['limit'] ) ? esc_attr( $instance['limit'] ) : ''; ?>"
				>
				<small>Оставьте поле пустым, чтобы отобразить все ссылки</small>
			</p>

			<p>
				<label for="<?php echo $this->get_field_id( 'post_type' ); ?>">Тип записи</label>
				<select name="<?php echo $this->get_field_name( 'post_type' ); ?>"
						id="<?php echo $this->get_field_id( 'post_type' ); ?>"
						class="widefat"
				>
					<?php foreach ( get_post_types( [ 'public' => true, ], 'objects' ) as $post_type ): ?>
						<option
								value="<?php echo esc_attr( $post_type->name ); ?>"
							<?php selected( $instance['post_type'], $post_type->name ); ?>
						>
							<?php echo esc_html( $post_type->label ); ?>
						</option>
					<?php endforeach; ?>
				</select>
			</p>
			<?php
		}

		// Сохранение настроек виджета
		public function update( $new_instance, $old_instance ) {
			$new_instance = wp_parse_args( (array) $new_instance, $this->default );

			$instance              = parent::update( $new_instance, $old_instance );
			$instance['type']      = sanitize_key( $new_instance['type'] );
			$instance['limit']     = $new_instance['limit'] > 0 ? (int) $new_instance['limit'] : '';
			$instance['post_type'] = sanitize_key( $new_instance['post_type'] );

			return $instance;
		}

		// Вывод виджета в лицевой части сайта
		public function widget( $args, $instance ) {
			add_filter( 'widget_archives_dropdown_args', [ $this, 'add_args' ], 10, 2 );
			add_filter( 'widget_archives_args', [ $this, 'add_args' ], 10, 2 );

			parent::widget( $args, $instance );

			remove_filter( 'widget_archives_dropdown_args', [ $this, 'add_args' ] );
			remove_filter( 'widget_archives_args', [ $this, 'add_args' ] );
		}

		public function add_args( $args, $instance ) {
			return wp_parse_args( $instance, $args );
		}
	}

	register_widget( 'WP_Widget_Archives_Advanced' );
}

Код WP_Widget_Archives: wp-includes/widgets/class-wp-widget-archives.php VER 4.9.8

<?php
class WP_Widget_Archives extends WP_Widget {

	/**
	 * Sets up a new Archives widget instance.
	 *
	 * @since 2.8.0
	 */
	public function __construct() {
		$widget_ops = array(
			'classname' => 'widget_archive',
			'description' => __( 'A monthly archive of your site&#8217;s Posts.' ),
			'customize_selective_refresh' => true,
		);
		parent::__construct('archives', __('Archives'), $widget_ops);
	}

	/**
	 * Outputs the content for the current Archives widget instance.
	 *
	 * @since 2.8.0
	 *
	 * @param array $args     Display arguments including 'before_title', 'after_title',
	 *                        'before_widget', and 'after_widget'.
	 * @param array $instance Settings for the current Archives widget instance.
	 */
	public function widget( $args, $instance ) {
		$title = ! empty( $instance['title'] ) ? $instance['title'] : __( 'Archives' );

		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
		$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

		$c = ! empty( $instance['count'] ) ? '1' : '0';
		$d = ! empty( $instance['dropdown'] ) ? '1' : '0';

		echo $args['before_widget'];

		if ( $title ) {
			echo $args['before_title'] . $title . $args['after_title'];
		}

		if ( $d ) {
			$dropdown_id = "{$this->id_base}-dropdown-{$this->number}";
			?>
		<label class="screen-reader-text" for="<?php echo esc_attr( $dropdown_id ); ?>"><?php echo $title; ?></label>
		<select id="<?php echo esc_attr( $dropdown_id ); ?>" name="archive-dropdown" onchange='document.location.href=this.options[this.selectedIndex].value;'>
			<?php
			/**
			 * Filters the arguments for the Archives widget drop-down.
			 *
			 * @since 2.8.0
			 * @since 4.9.0 Added the `$instance` parameter.
			 *
			 * @see wp_get_archives()
			 *
			 * @param array $args     An array of Archives widget drop-down arguments.
			 * @param array $instance Settings for the current Archives widget instance.
			 */
			$dropdown_args = apply_filters( 'widget_archives_dropdown_args', array(
				'type'            => 'monthly',
				'format'          => 'option',
				'show_post_count' => $c
			), $instance );

			switch ( $dropdown_args['type'] ) {
				case 'yearly':
					$label = __( 'Select Year' );
					break;
				case 'monthly':
					$label = __( 'Select Month' );
					break;
				case 'daily':
					$label = __( 'Select Day' );
					break;
				case 'weekly':
					$label = __( 'Select Week' );
					break;
				default:
					$label = __( 'Select Post' );
					break;
			}
			?>

			<option value=""><?php echo esc_attr( $label ); ?></option>
			<?php wp_get_archives( $dropdown_args ); ?>

		</select>
		<?php } else { ?>
		<ul>
		<?php
		/**
		 * Filters the arguments for the Archives widget.
		 *
		 * @since 2.8.0
		 * @since 4.9.0 Added the `$instance` parameter.
		 *
		 * @see wp_get_archives()
		 *
		 * @param array $args     An array of Archives option arguments.
		 * @param array $instance Array of settings for the current widget.
		 */
		wp_get_archives( apply_filters( 'widget_archives_args', array(
			'type'            => 'monthly',
			'show_post_count' => $c
		), $instance ) );
		?>
		</ul>
		<?php
		}

		echo $args['after_widget'];
	}

	/**
	 * Handles updating settings for the current Archives widget instance.
	 *
	 * @since 2.8.0
	 *
	 * @param array $new_instance New settings for this instance as input by the user via
	 *                            WP_Widget_Archives::form().
	 * @param array $old_instance Old settings for this instance.
	 * @return array Updated settings to save.
	 */
	public function update( $new_instance, $old_instance ) {
		$instance = $old_instance;
		$new_instance = wp_parse_args( (array) $new_instance, array( 'title' => '', 'count' => 0, 'dropdown' => '') );
		$instance['title'] = sanitize_text_field( $new_instance['title'] );
		$instance['count'] = $new_instance['count'] ? 1 : 0;
		$instance['dropdown'] = $new_instance['dropdown'] ? 1 : 0;

		return $instance;
	}

	/**
	 * Outputs the settings form for the Archives widget.
	 *
	 * @since 2.8.0
	 *
	 * @param array $instance Current settings.
	 */
	public function form( $instance ) {
		$instance = wp_parse_args( (array) $instance, array( 'title' => '', 'count' => 0, 'dropdown' => '') );
		$title = sanitize_text_field( $instance['title'] );
		?>
		<p><label for="<?php echo $this->get_field_id('title'); ?>"><?php _e('Title:'); ?></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($title); ?>" /></p>
		<p>
			<input class="checkbox" type="checkbox"<?php checked( $instance['dropdown'] ); ?> id="<?php echo $this->get_field_id('dropdown'); ?>" name="<?php echo $this->get_field_name('dropdown'); ?>" /> <label for="<?php echo $this->get_field_id('dropdown'); ?>"><?php _e('Display as dropdown'); ?></label>
			<br/>
			<input class="checkbox" type="checkbox"<?php checked( $instance['count'] ); ?> id="<?php echo $this->get_field_id('count'); ?>" name="<?php echo $this->get_field_name('count'); ?>" /> <label for="<?php echo $this->get_field_id('count'); ?>"><?php _e('Show post counts'); ?></label>
		</p>
		<?php
	}
}

Cвязанные функции

Из метки: archive (архивы записей)

Еще из метки: sidebar (widget Виджет)

Еще из раздела: Классы

campusboy 3053youtube.com/c/wpplus
Создатель YouTube канала wp-plus, на котором делюсь своим опытом. Активный пользователь wp-kama.ru. WordPress-разработчик. Разработка сайтов и лендингов. Доработка существующих проектов. Сопровождение ресурсов.
Комментариев нет
    Здравствуйте, !     Войти . Зарегистрироваться