widget_title │ хук-фильтр │ WP 2.6.0

Позволяет изменить заголовок виджета во фронтенде.

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

add_filter( 'widget_title', 'wp_kama_widget_title_filter', 10, 3 );

/**
 * Function for `widget_title` filter-hook.
 * 
 * @param string $title    The widget title.
 * @param array  $instance Array of settings for the current widget.
 * @param mixed  $id_base  The widget ID.
 *
 * @return string
 */
function wp_kama_widget_title_filter( $title, $instance, $id_base ){

	// filter...
	return $title;
}

$title(строка)

Заголовок виджета.

$instance(массив)

Настройки текущего виджета. Например, виджет "Рубрики" в зависимости от настроек может содержать следующие данные:

Array
(
	[title] => Рубрики
	[count] => 0
	[hierarchical] => 1
	[dropdown] => 1
)

$id_base(строка)

ID виджета, который указывается в конструкторе класса виджета. Например виджет "Рубрики" имеет id = categories, а у виджета "Свежие записи" id = recent-posts.

Примеры

#1 Изменим заголовок только у виджетов "Рубрики".

Сделаем всё тоже самое, что и в первом примере, но только для виджетов "Рубрики".

/**
 * Изменяет заголовок у всех виджетов "Рубрики".
 *
 * @param string $title
 * @param array  $instance
 * @param string $id_base
 *
 * @return string
 */
function filter_widget_categories_title( $title, $instance, $id_base ) {
	if ( 'categories' == $id_base ) {
		$title = "<span class='my-custom-class'>$title</span>";
	}

	return $title;
}

add_filter( 'widget_title', 'filter_widget_categories_title', 10, 3 );

#2 Изменим заголовок у всех виджетов.

Обернем заголовок у всех виджетов в тег span с произвольным CSS классом.

/**
 * Изменяет заголовок всех виджетов.
 *
 * @param string $title
 *
 * @return string
 */
function filter_all_widget_title( $title ) {
	return "<span class='my-custom-class'>$title</span>";
}

add_filter( 'widget_title', 'filter_all_widget_title' );

#3 Изменим заголовок у всех виджетов "Рубрики" в виде выпадающего списка.

/**
 * Изменяет заголовок у всех виджетов "Рубрики" в виде выпадающего списка.
 *
 * @param string $title
 * @param array  $instance
 * @param string $id_base
 *
 * @return string
 */
function filter_widget_categories_title( $title, $instance, $id_base ) {
	if ( 'categories' == $id_base && ! empty( $instance['hierarchical'] ) ) {
		$title .= ' в виде выпадающего списка';
	}

	return $title;
}

add_filter( 'widget_title', 'filter_widget_categories_title', 10, 3 );

Список изменений

С версии 2.6.0

Введена.

Где вызывается хук

WP_Widget_Pages::widget()

widget_title

widget_pages_args

navigation_widgets_format

WP_Widget_Calendar::widget()

widget_title

WP_Widget_Text::widget()

widget_title

widget_text

widget_text_content

WP_Widget_Search::widget()

widget_title

WP_Widget_RSS::widget()

widget_title

rss_widget_feed_link

navigation_widgets_format

WP_Widget_Categories::widget()

widget_title

widget_categories_dropdown_args

navigation_widgets_format

widget_categories_args

WP_Nav_Menu_Widget::widget()

widget_title

navigation_widgets_format

widget_nav_menu_args

WP_Widget_Recent_Comments::widget()

widget_title

widget_comments_args

navigation_widgets_format

WP_Widget_Tag_Cloud::widget()

widget_tag_cloud_args

widget_title

navigation_widgets_format

WP_Widget_Meta::widget()

widget_title

navigation_widgets_format

widget_meta_poweredby

WP_Widget_Archives::widget()

widget_title

widget_archives_dropdown_args

navigation_widgets_format

widget_archives_args

WP_Widget_Custom_HTML::widget()

widget_title

widget_text

widget_custom_html_content

WP_Widget_Media::widget()

widget_title

widget_(id_base)_instance

WP_Widget_Recent_Posts::widget()

widget_title

widget_posts_args

navigation_widgets_format

wp-includes/widgets/class-wp-widget-pages.php 56

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-calendar.php 54

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-text.php 233

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-search.php 47

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-rss.php 87

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-categories.php 52

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

wp-includes/widgets/class-wp-nav-menu-widget.php 54

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-recent-comments.php 90

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-tag-cloud.php 89

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-meta.php 50

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-archives.php 48

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-custom-html.php 136

$title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-media.php 240

$title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base );

wp-includes/widgets/class-wp-widget-recent-posts.php 53

$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

Где используется хук в WordPress

wp-includes/default-filters.php 155

add_filter( $filter, 'wptexturize' );

wp-includes/default-filters.php 156

add_filter( $filter, 'convert_chars' );

wp-includes/default-filters.php 157

add_filter( $filter, 'esc_html' );