apply_filters( 'widget_text', string $text, array $instance, WP_Widget_Text|WP_Widget_Custom_HTML $widget )

Filters the content of the Text widget.

Contents

Parameters Parameters

$text

(string) The widget content.

$instance

(array) Array of settings for the current widget.

$widget

(WP_Widget_Text|WP_Widget_Custom_HTML) Current text or HTML widget instance.

Top ↑

More Information More Information

May also apply to some third party widgets as well. This filter hook can be used to replace any text within sidebar widgets.

Top ↑

Source Source

File: wp-includes/widgets/class-wp-widget-text.php

View on Trac

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/widgets/class-wp-widget-custom-html.php: WP_Widget_Custom_HTML::widget()

Outputs the content for the current Custom HTML widget instance.
wp-includes/widgets/class-wp-widget-text.php: WP_Widget_Text::widget()

Outputs the content for the current Text widget instance.

Top ↑

Changelog Changelog

Changelog
Version Description
4.8.1 The $widget param may now be a WP_Widget_Custom_HTML object in addition to a WP_Widget_Text object.
4.4.0 Added the $widget parameter.
2.3.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by stevenlinx —

    Example migrated from Codex:

    The following performs a string replace on the content of the Text widget.

    add_filter('widget_text', 'exam_plug_text_replace');

function exam_plug_text_replace($text, $instance, $this) {
    $search = 'welcome admin';
    $replace = 'welcome adam';
    $text = str_replace($search, $replace, $text);

    return $text;
}

You must log in before being able to contribute a note or feedback.