mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-08-11 20:30:23 +00:00
Widgets: Extend the Text widget with TinyMCE.
Introduces rich text formatting: bold, italic, lists, links. Props westonruter, azaozz, timmydcrawford, obenland, melchoyce. See #35760. Fixes #35243. git-svn-id: https://develop.svn.wordpress.org/trunk@40631 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Weston Ruter
@@ -0,0 +1,249 @@
|
||||
<?php
|
||||
/**
|
||||
* Unit tests covering WP_Widget_Text functionality.
|
||||
*
|
||||
* @package WordPress
|
||||
* @subpackage widgets
|
||||
*/
|
||||
|
||||
/**
|
||||
* Test wp-includes/widgets/class-wp-widget-text.php
|
||||
*
|
||||
* @group widgets
|
||||
*/
|
||||
class Test_WP_Widget_Text extends WP_UnitTestCase {
|
||||
/**
|
||||
* Args passed to the widget_text filter.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $widget_text_args;
|
||||
|
||||
/**
|
||||
* Args passed to the widget_text_content filter.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $widget_text_content_args;
|
||||
|
||||
/**
|
||||
* Clean up global scope.
|
||||
*
|
||||
* @global WP_Scripts $wp_scripts
|
||||
* @global WP_Styles $wp_style
|
||||
*/
|
||||
function clean_up_global_scope() {
|
||||
global $wp_scripts, $wp_styles;
|
||||
parent::clean_up_global_scope();
|
||||
$wp_scripts = null;
|
||||
$wp_styles = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Test enqueue_admin_scripts method.
|
||||
*
|
||||
* @covers WP_Widget_Text::_register
|
||||
*/
|
||||
function test__register() {
|
||||
set_current_screen( 'widgets.php' );
|
||||
$widget = new WP_Widget_Text();
|
||||
$widget->_register();
|
||||
|
||||
$this->assertEquals( 10, has_action( 'admin_print_scripts-widgets.php', array( $widget, 'enqueue_admin_scripts' ) ) );
|
||||
$this->assertEquals( 10, has_action( 'admin_footer-widgets.php', array( $widget, 'render_control_template_scripts' ) ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Test widget method.
|
||||
*
|
||||
* @covers WP_Widget_Text::widget
|
||||
*/
|
||||
function test_widget() {
|
||||
$widget = new WP_Widget_Text();
|
||||
$text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n Praesent ut turpis consequat lorem volutpat bibendum vitae vitae ante.";
|
||||
|
||||
$args = array(
|
||||
'before_title' => '<h2>',
|
||||
'after_title' => "</h2>\n",
|
||||
'before_widget' => '<section>',
|
||||
'after_widget' => "</section>\n",
|
||||
);
|
||||
$instance = array(
|
||||
'title' => 'Foo',
|
||||
'text' => $text,
|
||||
'filter' => false,
|
||||
);
|
||||
|
||||
add_filter( 'widget_text_content', array( $this, 'filter_widget_text_content' ), 10, 3 );
|
||||
add_filter( 'widget_text', array( $this, 'filter_widget_text' ), 10, 3 );
|
||||
|
||||
// Test with filter=false.
|
||||
ob_start();
|
||||
$widget->widget( $args, $instance );
|
||||
$output = ob_get_clean();
|
||||
$this->assertNotContains( '<p>', $output );
|
||||
$this->assertNotContains( '<br />', $output );
|
||||
$this->assertEmpty( $this->widget_text_content_args );
|
||||
$this->assertNotEmpty( $this->widget_text_args );
|
||||
|
||||
// Test with filter=true.
|
||||
$instance['filter'] = true;
|
||||
ob_start();
|
||||
$widget->widget( $args, $instance );
|
||||
$output = ob_get_clean();
|
||||
$this->assertContains( '<p>', $output );
|
||||
$this->assertContains( '<br />', $output );
|
||||
$this->assertNotEmpty( $this->widget_text_args );
|
||||
$this->assertEquals( $instance['text'], $this->widget_text_args[0] );
|
||||
$this->assertEquals( $instance, $this->widget_text_args[1] );
|
||||
$this->assertEquals( $widget, $this->widget_text_args[2] );
|
||||
$this->assertEmpty( $this->widget_text_content_args );
|
||||
|
||||
// Test with filter=content, the upgraded widget.
|
||||
$instance['filter'] = 'content';
|
||||
ob_start();
|
||||
$widget->widget( $args, $instance );
|
||||
$output = ob_get_clean();
|
||||
$this->assertContains( '<p>', $output );
|
||||
$this->assertContains( '<br />', $output );
|
||||
$this->assertCount( 3, $this->widget_text_args );
|
||||
$this->assertEquals( $instance['text'], $this->widget_text_args[0] );
|
||||
$this->assertEquals( $instance, $this->widget_text_args[1] );
|
||||
$this->assertEquals( $widget, $this->widget_text_args[2] );
|
||||
$this->assertCount( 3, $this->widget_text_content_args );
|
||||
$this->assertEquals( wpautop( $instance['text'] ), $this->widget_text_content_args[0] );
|
||||
$this->assertEquals( $instance, $this->widget_text_content_args[1] );
|
||||
$this->assertEquals( $widget, $this->widget_text_content_args[2] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters the content of the Text widget.
|
||||
*
|
||||
* @param string $widget_text The widget content.
|
||||
* @param array $instance Array of settings for the current widget.
|
||||
* @param WP_Widget_Text $widget Current Text widget instance.
|
||||
* @return string Widget text.
|
||||
*/
|
||||
function filter_widget_text( $widget_text, $instance, $widget ) {
|
||||
$this->widget_text_args = func_get_args();
|
||||
|
||||
return $widget_text;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters the content of the Text widget to apply changes expected from the visual (TinyMCE) editor.
|
||||
*
|
||||
* @param string $widget_text The widget content.
|
||||
* @param array $instance Array of settings for the current widget.
|
||||
* @param WP_Widget_Text $widget Current Text widget instance.
|
||||
* @return string Widget content.
|
||||
*/
|
||||
function filter_widget_text_content( $widget_text, $instance, $widget ) {
|
||||
$this->widget_text_content_args = func_get_args();
|
||||
|
||||
return $widget_text;
|
||||
}
|
||||
|
||||
/**
|
||||
* Test update method.
|
||||
*
|
||||
* @covers WP_Widget_Text::update
|
||||
*/
|
||||
function test_update() {
|
||||
$widget = new WP_Widget_Text();
|
||||
$instance = array(
|
||||
'title' => "The\nTitle",
|
||||
'text' => "The\n\nText",
|
||||
'filter' => false,
|
||||
);
|
||||
|
||||
wp_set_current_user( $this->factory()->user->create( array(
|
||||
'role' => 'administrator',
|
||||
) ) );
|
||||
|
||||
// Should return valid instance.
|
||||
$expected = array(
|
||||
'title' => sanitize_text_field( $instance['title'] ),
|
||||
'text' => $instance['text'],
|
||||
'filter' => 'content',
|
||||
);
|
||||
$result = $widget->update( $instance, array() );
|
||||
$this->assertEquals( $result, $expected );
|
||||
$this->assertTrue( ! empty( $expected['filter'] ), 'Expected filter prop to be truthy, to handle case where 4.8 is downgraded to 4.7.' );
|
||||
|
||||
// Make sure KSES is applying as expected.
|
||||
add_filter( 'map_meta_cap', array( $this, 'grant_unfiltered_html_cap' ), 10, 2 );
|
||||
$this->assertTrue( current_user_can( 'unfiltered_html' ) );
|
||||
$instance['text'] = '<script>alert( "Howdy!" );</script>';
|
||||
$expected['text'] = $instance['text'];
|
||||
$result = $widget->update( $instance, array() );
|
||||
$this->assertEquals( $result, $expected );
|
||||
|
||||
remove_filter( 'map_meta_cap', array( $this, 'grant_unfiltered_html_cap' ) );
|
||||
add_filter( 'map_meta_cap', array( $this, 'revoke_unfiltered_html_cap' ), 10, 2 );
|
||||
$this->assertFalse( current_user_can( 'unfiltered_html' ) );
|
||||
$instance['text'] = '<script>alert( "Howdy!" );</script>';
|
||||
$expected['text'] = wp_kses_post( $instance['text'] );
|
||||
$result = $widget->update( $instance, array() );
|
||||
$this->assertEquals( $result, $expected );
|
||||
remove_filter( 'map_meta_cap', array( $this, 'revoke_unfiltered_html_cap' ), 10, 2 );
|
||||
}
|
||||
|
||||
/**
|
||||
* Grant unfiltered_html cap via map_meta_cap.
|
||||
*
|
||||
* @param array $caps Returns the user's actual capabilities.
|
||||
* @param string $cap Capability name.
|
||||
* @return array Caps.
|
||||
*/
|
||||
function grant_unfiltered_html_cap( $caps, $cap ) {
|
||||
if ( 'unfiltered_html' === $cap ) {
|
||||
$caps = array_diff( $caps, array( 'do_not_allow' ) );
|
||||
$caps[] = 'unfiltered_html';
|
||||
}
|
||||
return $caps;
|
||||
}
|
||||
|
||||
/**
|
||||
* Revoke unfiltered_html cap via map_meta_cap.
|
||||
*
|
||||
* @param array $caps Returns the user's actual capabilities.
|
||||
* @param string $cap Capability name.
|
||||
* @return array Caps.
|
||||
*/
|
||||
function revoke_unfiltered_html_cap( $caps, $cap ) {
|
||||
if ( 'unfiltered_html' === $cap ) {
|
||||
$caps = array_diff( $caps, array( 'unfiltered_html' ) );
|
||||
$caps[] = 'do_not_allow';
|
||||
}
|
||||
return $caps;
|
||||
}
|
||||
|
||||
/**
|
||||
* Test enqueue_admin_scripts method.
|
||||
*
|
||||
* @covers WP_Widget_Text::enqueue_admin_scripts
|
||||
*/
|
||||
function test_enqueue_admin_scripts() {
|
||||
set_current_screen( 'widgets.php' );
|
||||
$widget = new WP_Widget_Text();
|
||||
$widget->enqueue_admin_scripts();
|
||||
|
||||
$this->assertTrue( wp_script_is( 'text-widgets' ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Test render_control_template_scripts method.
|
||||
*
|
||||
* @covers WP_Widget_Text::render_control_template_scripts
|
||||
*/
|
||||
function test_render_control_template_scripts() {
|
||||
$widget = new WP_Widget_Text();
|
||||
|
||||
ob_start();
|
||||
$widget->render_control_template_scripts();
|
||||
$output = ob_get_clean();
|
||||
|
||||
$this->assertContains( '<script type="text/html" id="tmpl-widget-text-control-fields">', $output );
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user