1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
<?php
/**
* Class ObsoleteBlockAttributeRemover.
*
* @package AmpProject\AmpWP
*/
namespace AmpProject\AmpWP;
use AmpProject\AmpWP\Infrastructure\Delayed;
use AmpProject\AmpWP\Infrastructure\Registerable;
use AmpProject\AmpWP\Infrastructure\Service;
use WP_REST_Response;
/**
* Removes obsolete data-amp-* attributes from block markup in post content.
*
* These HTML attributes serve as processing instructions to control how the sanitizers handle converting HTML to AMP.
* For each HTML attribute there is also a block attribute, so if there is a data-amp-carousel HTML attribute then there
* is also an ampCarousel block attribute. The block attributes were originally mirrored onto the HTML attributes because
* the 'render_block' filter was not available in Gutenberg (or WordPress Core) when this was first implemented; now that
* this filter is available, there is no need to duplicate/mirror the attributes, and so they are injected into the
* root HTML element via `AMP_Core_Block_Handler::filter_rendered_block()`. In hindsight, instead of having the data
* mirrored between block attributes and HTML attributes, the block attributes should have perhaps used an 'attribute'
* as the block attribute 'source'. Then again, that may have complicated things yet further to migrate away from using
* these data attributes. A key reason for why these HTML data-* attributes are bad is that they cause block validation
* errors. If someone creates a Gallery block and enables a carousel, then if they go and deactivate the AMP plugin,
* this block will then show as having a block validation error. If, however, we restrict the block attributes to only
* be in the block comment, then no block validation errors occur. Also, since the 'render_block' filter is now
* available, the reason for storing these block attributes as data-amp-* HTML attributes in post_content is now obsolete.
*
* @see AMP_Core_Block_Handler::filter_rendered_block()
* @see AMP_Gallery_Block_Sanitizer
* @link https://github.com/ampproject/amp-wp/pull/4775
*
* @package AmpProject\AmpWP
* @since 2.0
* @internal
*/
final class ObsoleteBlockAttributeRemover implements Service, Registerable, Delayed {
/**
* Obsolete attributes.
*
* @var string[]
*/
const OBSOLETE_ATTRIBUTES = [
'data-amp-carousel',
'data-amp-layout',
'data-amp-lightbox',
'data-amp-noloading',
];
/**
* Get registration action.
*
* @return string
*/
public static function get_registration_action() {
return 'rest_api_init';
}
/**
* Register the service with the system.
*
* @return void
*/
public function register() {
foreach ( get_post_types_by_support( 'editor' ) as $post_type ) {
add_filter( "rest_prepare_{$post_type}", [ $this, 'filter_rest_prepare_post' ] );
}
}
/**
* Get obsolete attribute regular expression to match the obsolete attribute key/value pair in an HTML start tag..
*
* @return string Regular expression pattern.
*/
protected function get_obsolete_attribute_pattern() {
static $pattern = null;
if ( ! $pattern ) {
$pattern = sprintf( '/\s(%s)="[^"]*+"/', implode( '|', self::OBSOLETE_ATTRIBUTES ) );
}
return $pattern;
}
/**
* Filter post response object to purge obsolete attributes from the raw content.
*
* @param WP_REST_Response $response Response.
* @return WP_REST_Response Response.
*/
public function filter_rest_prepare_post( WP_REST_Response $response ) {
if ( isset( $response->data['content']['raw'] ) ) {
$response->data['content']['raw'] = preg_replace_callback(
'#(?P<block_comment>(?><!--\s*+wp:\w+.*?-->)\s*+)(?P<start_tag><[a-z][a-z0-9_:-]*+\s[^>]*+>)#s',
function ( $matches ) {
return $matches['block_comment'] . preg_replace( $this->get_obsolete_attribute_pattern(), '', $matches['start_tag'] );
},
$response->data['content']['raw']
);
}
return $response;
}
}
|