Issue #864: Native WordPress widget support, including subclasses #870
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <?php | ||
| /** | ||
| * Class AMP_Widget_Archives | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Class AMP_Widget_Archives | ||
| * | ||
| * @package AMP | ||
| */ | ||
| class AMP_Widget_Archives extends WP_Widget_Archives { | ||
|
|
||
| /** | ||
| * Echoes the markup of the widget. | ||
| * | ||
| * @todo filter $output, to strip the onchange attribute | ||
| * @see https://github.com/Automattic/amp-wp/issues/864 | ||
| * @param array $args Widget display data. | ||
| * @param array $instance Data for widget. | ||
| * @return void. | ||
| */ | ||
| public function widget( $args, $instance ) { | ||
| ob_start(); | ||
| parent::widget( $args, $instance ); | ||
| $output = ob_get_clean(); | ||
| echo AMP_Theme_Support::filter_the_content( $output ); // WPCS: XSS ok. | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <?php | ||
| /** | ||
| * Class AMP_Widget_Categories | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Class AMP_Widget_Categories | ||
| * | ||
| * @package AMP | ||
| */ | ||
| class AMP_Widget_Categories extends WP_Widget_Categories { | ||
|
|
||
| /** | ||
| * Echoes the markup of the widget. | ||
| * | ||
| * @todo filter $output, to strip the <script> tag. | ||
| * @see https://github.com/Automattic/amp-wp/issues/864 | ||
| * @param array $args Widget display data. | ||
| * @param array $instance Data for widget. | ||
| * @return void. | ||
| */ | ||
| public function widget( $args, $instance ) { | ||
| ob_start(); | ||
| parent::widget( $args, $instance ); | ||
| $output = ob_get_clean(); | ||
| echo AMP_Theme_Support::filter_the_content( $output ); // WPCS: XSS ok. | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <?php | ||
| /** | ||
| * Class AMP_Widget_Media_Audio | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Class AMP_Widget_Media_Audio | ||
| * | ||
| * @package AMP | ||
| */ | ||
| class AMP_Widget_Media_Audio extends WP_Widget_Media_Audio { | ||
|
|
||
| /** | ||
| * Echoes the markup of the widget. | ||
| * | ||
| * @todo filter $output, to convert <audio> to <amp-audio>. | ||
| * @see https://github.com/Automattic/amp-wp/issues/864 | ||
| * @param array $instance Data for widget. | ||
| * @return void. | ||
| */ | ||
| public function render_media( $instance ) { | ||
| ob_start(); | ||
| parent::render_media( $instance ); | ||
| $output = ob_get_clean(); | ||
| echo AMP_Theme_Support::filter_the_content( $output ); // WPCS: XSS ok. | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <?php | ||
| /** | ||
| * Class AMP_Widget_Media_Gallery | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Class AMP_Widget_Media_Gallery | ||
| * | ||
| * @package AMP | ||
| */ | ||
| class AMP_Widget_Media_Gallery extends WP_Widget_Media_Gallery { | ||
|
|
||
| /** | ||
| * Echoes the markup of the widget. | ||
| * | ||
| * @todo filter $output, to convert <imp> to <amp-img> and remove the <style>. | ||
| * @see https://github.com/Automattic/amp-wp/issues/864 | ||
| * @param array $instance Data for widget. | ||
| * @return void. | ||
| */ | ||
| public function render_media( $instance ) { | ||
| ob_start(); | ||
| parent::render_media( $instance ); | ||
| $output = ob_get_clean(); | ||
| echo AMP_Theme_Support::filter_the_content( $output ); // WPCS: XSS ok. | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <?php | ||
| /** | ||
| * Class AMP_Widget_Media_Image | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Class AMP_Widget_Media_Image | ||
| * | ||
| * @package AMP | ||
| */ | ||
| class AMP_Widget_Media_Image extends WP_Widget_Media_Image { | ||
|
|
||
| /** | ||
| * Echoes the markup of the widget. | ||
| * | ||
| * @todo filter $output, to convert <imp> to <amp-img> and remove the 'style' attribute. | ||
| * @see https://github.com/Automattic/amp-wp/issues/864 | ||
| * @param array $instance Data for widget. | ||
| * @return void. | ||
| */ | ||
| public function render_media( $instance ) { | ||
| ob_start(); | ||
| parent::render_media( $instance ); | ||
| $output = ob_get_clean(); | ||
| echo AMP_Theme_Support::filter_the_content( $output ); // WPCS: XSS ok. | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <?php | ||
| /** | ||
| * Class AMP_Widget_Media_Video | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Class AMP_Widget_Media_Video | ||
| * | ||
| * @package AMP | ||
| */ | ||
| class AMP_Widget_Media_Video extends WP_Widget_Media_Video { | ||
|
|
||
| /** | ||
| * Echoes the markup of the widget. | ||
| * | ||
| * @todo filter $output, to convert <video> to <amp-video> and remove the 'style' attribute. | ||
| * @see https://github.com/Automattic/amp-wp/issues/864 | ||
| * @param array $instance Data for widget. | ||
| * @return void. | ||
| */ | ||
| public function render_media( $instance ) { | ||
| ob_start(); | ||
| parent::render_media( $instance ); | ||
| $output = ob_get_clean(); | ||
| echo AMP_Theme_Support::filter_the_content( $output ); // WPCS: XSS ok. | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <?php | ||
| /** | ||
| * Class AMP_Widget_Recent_Comments | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Class AMP_Widget_Recent_Comments | ||
| * | ||
| * @package AMP | ||
| */ | ||
| class AMP_Widget_Recent_Comments extends WP_Widget_Recent_Comments { | ||
|
|
||
| /** | ||
| * Instantiates the widget, and prevents inline styling. | ||
| */ | ||
| public function __construct() { | ||
| parent::__construct(); | ||
| add_filter( 'show_recent_comments_widget_style', '__return_false' ); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <?php | ||
| /** | ||
| * Class AMP_Widget_RSS | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Class AMP_Widget_RSS | ||
| * | ||
| * @package AMP | ||
| */ | ||
| class AMP_Widget_RSS extends WP_Widget_RSS { | ||
|
|
||
| /** | ||
| * Echoes the markup of the widget. | ||
| * | ||
| * @todo filter $output, to convert <img> to <amp-img>. | ||
| * @see https://github.com/Automattic/amp-wp/issues/864 | ||
| * @param array $args Widget display data. | ||
| * @param array $instance Data for widget. | ||
| * @return void. | ||
| */ | ||
| public function widget( $args, $instance ) { | ||
| ob_start(); | ||
| parent::widget( $args, $instance ); | ||
| $output = ob_get_clean(); | ||
| echo AMP_Theme_Support::filter_the_content( $output ); // WPCS: XSS ok. | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| <?php | ||
| /** | ||
| * Register widgets, and add actions. | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Register the widgets. | ||
| */ | ||
| class AMP_Widgets { | ||
|
|
||
| /** | ||
| * Add the actions. | ||
| * | ||
| * @return void. | ||
| */ | ||
| public function init() { | ||
| add_action( 'widgets_init', array( $this, 'register_widgets' ) ); | ||
| } | ||
|
|
||
| /** | ||
| * Add the filters. | ||
| * | ||
| * @return void. | ||
| */ | ||
| public function register_widgets() { | ||
| $widgets = self::get_widgets(); | ||
| foreach ( $widgets as $native_wp_widget => $amp_widget ) { | ||
| unregister_widget( $native_wp_widget ); | ||
| register_widget( $amp_widget ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get the widgets to unregister and register. | ||
| * | ||
| * @return array $widgets An associative array, with the previous WP widget mapped to the new AMP widget. | ||
| */ | ||
| public function get_widgets() { | ||
| return array( | ||
| 'WP_Widget_Archives' => 'AMP_Widget_Archives', | ||
| 'WP_Widget_Categories' => 'AMP_Widget_Categories', | ||
| 'WP_Widget_Media_Audio' => 'AMP_Widget_Media_Audio', | ||
| 'WP_Widget_Media_Gallery' => 'AMP_Widget_Media_Gallery', | ||
| 'WP_Widget_Media_Image' => 'AMP_Widget_Media_Image', | ||
| 'WP_Widget_Media_Video' => 'AMP_Widget_Media_Video', | ||
|
There was a problem hiding this comment. I can see Travis is failing due to these media widgets not existing in 4.7. So I suggest before returning this array to loop over the keys and remove any for which There was a problem hiding this comment. Hi @weston, |
||
| 'WP_Widget_Recent_Comments' => 'AMP_Widget_Recent_Comments', | ||
| 'WP_Widget_RSS' => 'AMP_Widget_RSS', | ||
| ); | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| <?php | ||
| /** | ||
| * Tests for class AMP_Widget_Archives. | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Tests for class AMP_Widget_Archives. | ||
| * | ||
| * @package AMP | ||
| */ | ||
| class Test_AMP_Widget_Archives extends WP_UnitTestCase { | ||
|
|
||
| /** | ||
| * Instance of the widget. | ||
| * | ||
| * @var object | ||
| */ | ||
| public $instance; | ||
|
|
||
| /** | ||
| * Setup. | ||
| * | ||
| * @inheritdoc | ||
| */ | ||
| public function setUp() { | ||
| parent::setUp(); | ||
| AMP_Theme_Support::init(); | ||
| $amp_widgets = new AMP_Widgets(); | ||
| $amp_widgets->register_widgets(); | ||
| $this->instance = new AMP_Widget_Archives(); | ||
| } | ||
|
|
||
| /** | ||
| * Test construct(). | ||
| * | ||
| * @see AMP_Widget_Archives::__construct(). | ||
| */ | ||
| public function test_construct() { | ||
| global $wp_widget_factory; | ||
| $amp_archives = $wp_widget_factory->widgets['AMP_Widget_Archives']; | ||
| $this->assertEquals( 'AMP_Widget_Archives', get_class( $amp_archives ) ); | ||
| $this->assertEquals( 'archives', $amp_archives->id_base ); | ||
| $this->assertEquals( 'Archives', $amp_archives->name ); | ||
| $this->assertEquals( 'widget_archive', $amp_archives->widget_options['classname'] ); | ||
| $this->assertEquals( true, $amp_archives->widget_options['customize_selective_refresh'] ); | ||
| $this->assertEquals( 'A monthly archive of your site’s Posts.', $amp_archives->widget_options['description'] ); | ||
| } | ||
|
|
||
| /** | ||
| * Test widget(). | ||
| * | ||
| * @see AMP_Widget_Archives::widget(). | ||
| */ | ||
| public function test_widget() { | ||
| $arguments = array( | ||
| 'before_widget' => '<div>', | ||
| 'after_widget' => '</div>', | ||
| 'before_title' => '<h2>', | ||
| 'after_title' => '</h2>', | ||
| ); | ||
| $instance = array( | ||
| 'title' => 'Test Archives Widget', | ||
| 'dropdown' => 1, | ||
| ); | ||
| ob_start(); | ||
| $this->instance->widget( $arguments, $instance ); | ||
| $output = ob_get_clean(); | ||
|
|
||
| $this->assertFalse( strpos( $output, 'onchange=' ) ); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kienstra Here we need to handle the dropdown behavior. I think this should strip out the
scripttag here via regex:And then what it needs to do is inject two additional things:
idattribute to the<form>with a random value, or an auto-incremented one:widget-categories-dropdown-%d, e.g.widget-categories-dropdown-123onattribute onto the<select>element likeon="change:widget-categories-dropdown-123.submit".Reference: https://www.ampproject.org/docs/reference/components/amp-form#input-events
👉 N.B. WordPress 4.9 first introduced the
<form>element here: WordPress/wordpress-develop@b7c70caSo if no
<form>is present, then it should wrap the<select>with one.On second thought, instead of output-buffering the output and modifying it, just copy the existing logic from
\WP_Widget_Categories::widget()in WP 4.9 and modify it here to be valid AMP.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Applied Suggestion
Thanks For The Explanation
Hi @westonruter,
Thanks for your great explanation of how to make the dropdown work with AMP. How does this commit look?
It mainly copies
\WP_Widget_Categories::widget()from 4.9, and makes the changes you suggested.It's worked locally, with valid AMP. There are still Travis errors that I need to fix, not directly related to the commit.