2015-09-01 09:49:21 -04:00
< ? php
/**
2015-09-22 11:04:26 -04:00
* Widget API : WP_Widget_Text class
2015-09-01 09:49:21 -04:00
*
* @ package WordPress
* @ subpackage Widgets
2015-09-22 11:04:26 -04:00
* @ since 4.4 . 0
*/
/**
* Core class used to implement a Text widget .
*
* @ since 2.8 . 0
*
* @ see WP_Widget
2015-09-01 09:49:21 -04:00
*/
class WP_Widget_Text extends WP_Widget {
2017-07-11 18:47:43 -04:00
/**
* Whether or not the widget has been registered yet .
*
* @ since 4.8 . 1
* @ var bool
*/
protected $registered = false ;
2015-09-26 20:27:26 -04:00
/**
* Sets up a new Text widget instance .
*
* @ since 2.8 . 0
* @ access public
*/
2015-09-01 09:49:21 -04:00
public function __construct () {
2016-03-21 17:59:29 -04:00
$widget_ops = array (
'classname' => 'widget_text' ,
2017-06-09 19:54:42 -04:00
'description' => __ ( 'Arbitrary text.' ),
2016-03-21 17:59:29 -04:00
'customize_selective_refresh' => true ,
);
2017-05-11 14:55:43 -04:00
$control_ops = array (
'width' => 400 ,
'height' => 350 ,
);
2016-03-21 17:59:29 -04:00
parent :: __construct ( 'text' , __ ( 'Text' ), $widget_ops , $control_ops );
2015-09-01 09:49:21 -04:00
}
2017-05-11 14:55:43 -04:00
/**
* Add hooks for enqueueing assets when registering all widget instances of this widget class .
*
2017-07-11 18:47:43 -04:00
* @ param integer $number Optional . The unique order number of this widget instance
* compared to other instances of the same class . Default - 1.
2017-05-11 14:55:43 -04:00
*/
2017-07-11 18:47:43 -04:00
public function _register_one ( $number = - 1 ) {
parent :: _register_one ( $number );
if ( $this -> registered ) {
return ;
}
$this -> registered = true ;
2017-05-11 14:55:43 -04:00
// Note that the widgets component in the customizer will also do the 'admin_print_scripts-widgets.php' action in WP_Customize_Widgets::print_scripts().
add_action ( 'admin_print_scripts-widgets.php' , array ( $this , 'enqueue_admin_scripts' ) );
// Note that the widgets component in the customizer will also do the 'admin_footer-widgets.php' action in WP_Customize_Widgets::print_footer_scripts().
add_action ( 'admin_footer-widgets.php' , array ( $this , 'render_control_template_scripts' ) );
}
2017-07-14 13:09:43 -04:00
/**
* Determines whether a given instance is legacy and should bypass using TinyMCE .
*
* @ since 4.8 . 1
*
* @ param array $instance {
* Instance data .
*
* @ type string $text Content .
* @ type bool | string $filter Whether autop or content filters should apply .
* @ type bool $legacy Whether widget is in legacy mode .
* }
* @ return bool Whether Text widget instance contains legacy data .
*/
public function is_legacy_instance ( $instance ) {
2017-07-24 18:46:42 -04:00
// Legacy mode when not in visual mode.
if ( isset ( $instance [ 'visual' ] ) ) {
return ! $instance [ 'visual' ];
2017-07-14 13:09:43 -04:00
}
2017-07-24 18:46:42 -04:00
// Or, the widget has been added/updated in 4.8.0 then filter prop is 'content' and it is no longer legacy.
2017-07-14 13:09:43 -04:00
if ( isset ( $instance [ 'filter' ] ) && 'content' === $instance [ 'filter' ] ) {
return false ;
}
// If the text is empty, then nothing is preventing migration to TinyMCE.
if ( empty ( $instance [ 'text' ] ) ) {
return false ;
}
$wpautop = ! empty ( $instance [ 'filter' ] );
2017-07-18 00:17:43 -04:00
$has_line_breaks = ( false !== strpos ( trim ( $instance [ 'text' ] ), " \n " ) );
2017-07-14 13:09:43 -04:00
// If auto-paragraphs are not enabled and there are line breaks, then ensure legacy mode.
if ( ! $wpautop && $has_line_breaks ) {
return true ;
}
// If an HTML comment is present, assume legacy mode.
if ( false !== strpos ( $instance [ 'text' ], '<!--' ) ) {
return true ;
}
// In the rare case that DOMDocument is not available we cannot reliably sniff content and so we assume legacy.
if ( ! class_exists ( 'DOMDocument' ) ) {
// @codeCoverageIgnoreStart
return true ;
// @codeCoverageIgnoreEnd
}
$doc = new DOMDocument ();
$doc -> loadHTML ( sprintf (
'<html><head><meta charset="%s"></head><body>%s</body></html>' ,
esc_attr ( get_bloginfo ( 'charset' ) ),
$instance [ 'text' ]
) );
$body = $doc -> getElementsByTagName ( 'body' ) -> item ( 0 );
// See $allowedposttags.
$safe_elements_attributes = array (
'strong' => array (),
'em' => array (),
'b' => array (),
'i' => array (),
'u' => array (),
's' => array (),
'ul' => array (),
'ol' => array (),
'li' => array (),
'hr' => array (),
'abbr' => array (),
'acronym' => array (),
'code' => array (),
'dfn' => array (),
'a' => array (
'href' => true ,
),
'img' => array (
'src' => true ,
'alt' => true ,
),
);
$safe_empty_elements = array ( 'img' , 'hr' , 'iframe' );
foreach ( $body -> getElementsByTagName ( '*' ) as $element ) {
/** @var DOMElement $element */
$tag_name = strtolower ( $element -> nodeName );
// If the element is not safe, then the instance is legacy.
if ( ! isset ( $safe_elements_attributes [ $tag_name ] ) ) {
return true ;
}
// If the element is not safely empty and it has empty contents, then legacy mode.
if ( ! in_array ( $tag_name , $safe_empty_elements , true ) && '' === trim ( $element -> textContent ) ) {
return true ;
}
// If an attribute is not recognized as safe, then the instance is legacy.
foreach ( $element -> attributes as $attribute ) {
/** @var DOMAttr $attribute */
$attribute_name = strtolower ( $attribute -> nodeName );
if ( ! isset ( $safe_elements_attributes [ $tag_name ][ $attribute_name ] ) ) {
return true ;
}
}
}
// Otherwise, the text contains no elements/attributes that TinyMCE could drop, and therefore the widget does not need legacy mode.
return false ;
}
2015-09-01 09:49:21 -04:00
/**
2015-09-26 20:27:26 -04:00
* Outputs the content for the current Text widget instance .
2015-09-25 15:24:24 -04:00
*
* @ since 2.8 . 0
* @ access public
*
* @ param array $args Display arguments including 'before_title' , 'after_title' ,
* 'before_widget' , and 'after_widget' .
2015-09-26 20:27:26 -04:00
* @ param array $instance Settings for the current Text widget instance .
2015-09-01 09:49:21 -04:00
*/
public function widget ( $args , $instance ) {
2015-09-25 15:24:24 -04:00
2015-09-08 18:17:26 -04:00
/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
2015-09-01 09:49:21 -04:00
$title = apply_filters ( 'widget_title' , empty ( $instance [ 'title' ] ) ? '' : $instance [ 'title' ], $instance , $this -> id_base );
2017-05-15 18:36:41 -04:00
$text = ! empty ( $instance [ 'text' ] ) ? $instance [ 'text' ] : '' ;
2017-07-24 18:46:42 -04:00
$is_visual_text_widget = ( ! empty ( $instance [ 'visual' ] ) && ! empty ( $instance [ 'filter' ] ) );
// In 4.8.0 only, visual Text widgets get filter=content, without visual prop; upgrade instance props just-in-time.
if ( ! $is_visual_text_widget ) {
$is_visual_text_widget = ( isset ( $instance [ 'filter' ] ) && 'content' === $instance [ 'filter' ] );
}
if ( $is_visual_text_widget ) {
$instance [ 'filter' ] = true ;
$instance [ 'visual' ] = true ;
}
2017-07-14 13:09:43 -04:00
/*
* Just - in - time temporarily upgrade Visual Text widget shortcode handling
* ( with support added by plugin ) from the widget_text filter to
* widget_text_content : 11 to prevent wpautop from corrupting HTML output
* added by the shortcode .
*/
$widget_text_do_shortcode_priority = has_filter ( 'widget_text' , 'do_shortcode' );
$should_upgrade_shortcode_handling = ( $is_visual_text_widget && false !== $widget_text_do_shortcode_priority );
if ( $should_upgrade_shortcode_handling ) {
remove_filter ( 'widget_text' , 'do_shortcode' , $widget_text_do_shortcode_priority );
add_filter ( 'widget_text_content' , 'do_shortcode' , 11 );
}
2015-09-25 15:21:24 -04:00
2015-09-01 09:49:21 -04:00
/**
2016-05-22 14:06:28 -04:00
* Filters the content of the Text widget .
2015-09-01 09:49:21 -04:00
*
* @ since 2.3 . 0
2015-09-25 15:21:24 -04:00
* @ since 4.4 . 0 Added the `$this` parameter .
2017-07-18 18:11:44 -04:00
* @ since 4.8 . 1 The `$this` param may now be a `WP_Widget_Custom_HTML` object in addition to a `WP_Widget_Text` object .
2015-09-01 09:49:21 -04:00
*
2017-07-18 18:11:44 -04:00
* @ param string $text The widget content .
* @ param array $instance Array of settings for the current widget .
* @ param WP_Widget_Text | WP_Widget_Custom_HTML $this Current Text widget instance .
2015-09-01 09:49:21 -04:00
*/
2017-05-15 18:36:41 -04:00
$text = apply_filters ( 'widget_text' , $text , $instance , $this );
2015-09-25 15:21:24 -04:00
2017-07-24 18:46:42 -04:00
if ( $is_visual_text_widget ) {
/**
* Filters the content of the Text widget to apply changes expected from the visual ( TinyMCE ) editor .
*
* By default a subset of the_content filters are applied , including wpautop and wptexturize .
*
* @ since 4.8 . 0
*
* @ param string $text The widget content .
* @ param array $instance Array of settings for the current widget .
* @ param WP_Widget_Text $this Current Text widget instance .
*/
$text = apply_filters ( 'widget_text_content' , $text , $instance , $this );
} elseif ( ! empty ( $instance [ 'filter' ] ) ) {
$text = wpautop ( $text ); // Back-compat for instances prior to 4.8.
2017-05-11 14:55:43 -04:00
}
2017-07-14 13:09:43 -04:00
// Undo temporary upgrade of the plugin-supplied shortcode handling.
if ( $should_upgrade_shortcode_handling ) {
remove_filter ( 'widget_text_content' , 'do_shortcode' , 11 );
add_filter ( 'widget_text' , 'do_shortcode' , $widget_text_do_shortcode_priority );
}
2015-09-01 09:49:21 -04:00
echo $args [ 'before_widget' ];
if ( ! empty ( $title ) ) {
echo $args [ 'before_title' ] . $title . $args [ 'after_title' ];
2017-05-11 14:55:43 -04:00
}
?>
< div class = " textwidget " >< ? php echo $text ; ?> </div>
2015-09-01 09:49:21 -04:00
< ? php
echo $args [ 'after_widget' ];
}
/**
2015-09-26 20:27:26 -04:00
* Handles updating settings for the current Text widget instance .
*
* @ since 2.8 . 0
* @ access public
*
* @ param array $new_instance New settings for this instance as input by the user via
* WP_Widget :: form () .
* @ param array $old_instance Old settings for this instance .
* @ return array Settings to save or bool false to cancel saving .
2015-09-01 09:49:21 -04:00
*/
public function update ( $new_instance , $old_instance ) {
2017-07-24 18:46:42 -04:00
$new_instance = wp_parse_args ( $new_instance , array (
'title' => '' ,
'text' => '' ,
'filter' => false , // For back-compat.
'visual' => null , // Must be explicitly defined.
) );
2015-09-01 09:49:21 -04:00
$instance = $old_instance ;
2017-07-24 18:46:42 -04:00
2015-09-01 09:49:21 -04:00
$instance [ 'title' ] = sanitize_text_field ( $new_instance [ 'title' ] );
2016-02-22 20:02:26 -05:00
if ( current_user_can ( 'unfiltered_html' ) ) {
$instance [ 'text' ] = $new_instance [ 'text' ];
} else {
$instance [ 'text' ] = wp_kses_post ( $new_instance [ 'text' ] );
}
2017-05-11 14:55:43 -04:00
2017-07-24 18:46:42 -04:00
$instance [ 'filter' ] = ! empty ( $new_instance [ 'filter' ] );
// Upgrade 4.8.0 format.
if ( isset ( $old_instance [ 'filter' ] ) && 'content' === $old_instance [ 'filter' ] ) {
$instance [ 'visual' ] = true ;
}
if ( 'content' === $new_instance [ 'filter' ] ) {
$instance [ 'visual' ] = true ;
}
if ( isset ( $new_instance [ 'visual' ] ) ) {
$instance [ 'visual' ] = ! empty ( $new_instance [ 'visual' ] );
}
// Filter is always true in visual mode.
if ( ! empty ( $instance [ 'visual' ] ) ) {
$instance [ 'filter' ] = true ;
2017-07-14 13:09:43 -04:00
}
2017-05-11 14:55:43 -04:00
2015-09-01 09:49:21 -04:00
return $instance ;
}
2017-05-11 14:55:43 -04:00
/**
* Loads the required scripts and styles for the widget control .
*
* @ since 4.8 . 0
* @ access public
*/
public function enqueue_admin_scripts () {
wp_enqueue_editor ();
wp_enqueue_script ( 'text-widgets' );
}
2015-09-01 09:49:21 -04:00
/**
2015-09-26 20:27:26 -04:00
* Outputs the Text widget settings form .
*
* @ since 2.8 . 0
2017-05-11 14:55:43 -04:00
* @ since 4.8 . 0 Form only contains hidden inputs which are synced with JS template .
2017-07-14 13:09:43 -04:00
* @ since 4.8 . 1 Restored original form to be displayed when in legacy mode .
2015-09-26 20:27:26 -04:00
* @ access public
2017-05-11 14:55:43 -04:00
* @ see WP_Widget_Visual_Text :: render_control_template_scripts ()
2015-09-26 20:27:26 -04:00
*
* @ param array $instance Current settings .
2017-05-11 14:55:43 -04:00
* @ return void
2015-09-01 09:49:21 -04:00
*/
public function form ( $instance ) {
2017-05-11 14:55:43 -04:00
$instance = wp_parse_args (
( array ) $instance ,
array (
'title' => '' ,
'text' => '' ,
)
);
2015-09-01 09:49:21 -04:00
?>
2017-07-14 13:09:43 -04:00
< ? php if ( ! $this -> is_legacy_instance ( $instance ) ) : ?>
< input id = " <?php echo $this->get_field_id ( 'title' ); ?> " name = " <?php echo $this->get_field_name ( 'title' ); ?> " class = " title " type = " hidden " value = " <?php echo esc_attr( $instance['title'] ); ?> " >
< input id = " <?php echo $this->get_field_id ( 'text' ); ?> " name = " <?php echo $this->get_field_name ( 'text' ); ?> " class = " text " type = " hidden " value = " <?php echo esc_attr( $instance['text'] ); ?> " >
2017-07-24 18:46:42 -04:00
< input id = " <?php echo $this->get_field_id ( 'filter' ); ?> " name = " <?php echo $this->get_field_name ( 'filter' ); ?> " class = " filter " type = " hidden " value = " on " >
< input id = " <?php echo $this->get_field_id ( 'visual' ); ?> " name = " <?php echo $this->get_field_name ( 'visual' ); ?> " class = " visual " type = " hidden " value = " on " >
2017-07-14 13:09:43 -04:00
< ? php else : ?>
2017-07-24 18:46:42 -04:00
< input id = " <?php echo $this->get_field_id ( 'visual' ); ?> " name = " <?php echo $this->get_field_name ( 'visual' ); ?> " class = " visual " type = " hidden " value = " " >
2017-07-14 13:09:43 -04:00
< 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( $instance['title'] ); ?> " />
</ p >
< div class = " notice inline notice-info notice-alt " >
2017-07-18 00:17:43 -04:00
< p >< ? php _e ( 'This widget may contain code that may work better in the new “Custom HTML” widget. How about trying that widget instead?' ); ?> </p>
2017-07-14 13:09:43 -04:00
</ div >
< p >
< label for = " <?php echo $this->get_field_id ( 'text' ); ?> " >< ? php _e ( 'Content:' ); ?> </label>
< textarea class = " widefat " rows = " 16 " cols = " 20 " id = " <?php echo $this->get_field_id ( 'text' ); ?> " name = " <?php echo $this->get_field_name ( 'text' ); ?> " >< ? php echo esc_textarea ( $instance [ 'text' ] ); ?> </textarea>
</ p >
< p >
< input id = " <?php echo $this->get_field_id ( 'filter' ); ?> " name = " <?php echo $this->get_field_name ( 'filter' ); ?> " type = " checkbox " < ? php checked ( ! empty ( $instance [ 'filter' ] ) ); ?> /> <label for="<?php echo $this->get_field_id( 'filter' ); ?>"><?php _e( 'Automatically add paragraphs' ); ?></label>
</ p >
2017-05-11 14:55:43 -04:00
< ? php
2017-07-14 13:09:43 -04:00
endif ;
2017-05-11 14:55:43 -04:00
}
2015-09-01 09:49:21 -04:00
2017-05-11 14:55:43 -04:00
/**
* Render form template scripts .
*
* @ since 4.8 . 0
* @ access public
*/
public function render_control_template_scripts () {
2017-07-14 13:09:43 -04:00
$dismissed_pointers = explode ( ',' , ( string ) get_user_meta ( get_current_user_id (), 'dismissed_wp_pointers' , true ) );
2017-05-11 14:55:43 -04:00
?>
< script type = " text/html " id = " tmpl-widget-text-control-fields " >
< # var elementIdPrefix = 'el' + String( Math.random() ).replace( /\D/g, '' ) + '_' #>
< p >
< label for = " { { elementIdPrefix }}title " >< ? php esc_html_e ( 'Title:' ); ?> </label>
< input id = " { { elementIdPrefix }}title " type = " text " class = " widefat title " >
</ p >
2017-07-14 13:09:43 -04:00
< ? php if ( ! in_array ( 'text_widget_custom_html' , $dismissed_pointers , true ) ) : ?>
< div hidden class = " wp-pointer custom-html-widget-pointer wp-pointer-top " >
< div class = " wp-pointer-content " >
< h3 >< ? php _e ( 'New Custom HTML Widget' ); ?> </h3>
< ? php if ( is_customize_preview () ) : ?>
< p >< ? php _e ( 'Hey, did you hear we have a “Custom HTML” widget now? You can find it by pressing the “<a class="add-widget" href="#">Add a Widget</a>” button and searching for “HTML”. Check it out to add some custom code to your site!' ); ?> </p>
< ? php else : ?>
< p >< ? php _e ( 'Hey, did you hear we have a “Custom HTML” widget now? You can find it by scanning the list of available widgets on this screen. Check it out to add some custom code to your site!' ); ?> </p>
< ? php endif ; ?>
< div class = " wp-pointer-buttons " >
< a class = " close " href = " # " >< ? php _e ( 'Dismiss' ); ?> </a>
</ div >
</ div >
< div class = " wp-pointer-arrow " >
< div class = " wp-pointer-arrow-inner " ></ div >
</ div >
</ div >
< ? php endif ; ?>
< ? php if ( ! in_array ( 'text_widget_paste_html' , $dismissed_pointers , true ) ) : ?>
< div hidden class = " wp-pointer paste-html-pointer wp-pointer-top " >
< div class = " wp-pointer-content " >
< h3 >< ? php _e ( 'Did you just paste HTML?' ); ?> </h3>
< p >< ? php _e ( 'Hey there, looks like you just pasted HTML into the “Visual” tab of the Text widget. You may want to paste your code into the “Text” tab instead. Alternately, try out the new “Custom HTML” widget!' ); ?> </p>
< div class = " wp-pointer-buttons " >
< a class = " close " href = " # " >< ? php _e ( 'Dismiss' ); ?> </a>
</ div >
</ div >
< div class = " wp-pointer-arrow " >
< div class = " wp-pointer-arrow-inner " ></ div >
</ div >
</ div >
< ? php endif ; ?>
2017-05-11 14:55:43 -04:00
< p >
< label for = " { { elementIdPrefix }}text " class = " screen-reader-text " >< ? php esc_html_e ( 'Content:' ); ?> </label>
2017-05-15 20:11:41 -04:00
< textarea id = " { { elementIdPrefix }}text " class = " widefat text wp-editor-area " style = " height: 200px " rows = " 16 " cols = " 20 " ></ textarea >
2017-05-11 14:55:43 -04:00
</ p >
</ script >
2015-09-26 20:27:26 -04:00
< ? php
2015-09-01 09:49:21 -04:00
}
}
