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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
<?php
namespace Automattic\WooCommerce\Blocks\Patterns;
use Automattic\WooCommerce\Admin\Features\Features;
/**
* PatternRegistry class.
*
* @internal
*/
class PatternRegistry {
const SLUG_REGEX = '/^[A-z0-9\/_-]+$/';
const COMMA_SEPARATED_REGEX = '/[\s,]+/';
/**
* Returns pattern slugs with their localized labels for categorization.
*
* Each key represents a unique pattern slug, while the value is the localized label.
*
* @return array<string, string>
*/
private function get_category_labels() {
return [
'woo-commerce' => __( 'WooCommerce', 'woocommerce' ),
'intro' => __( 'Intro', 'woocommerce' ),
'featured-selling' => __( 'Featured Selling', 'woocommerce' ),
'about' => __( 'About', 'woocommerce' ),
'social-media' => __( 'Social Media', 'woocommerce' ),
'services' => __( 'Services', 'woocommerce' ),
'reviews' => __( 'Reviews', 'woocommerce' ),
];
}
/**
* Register a block pattern.
*
* @param string $source The pattern source.
* @param array $pattern_data The pattern data.
* @param array $dictionary The patterns' dictionary.
*
* @return void
*/
public function register_block_pattern( $source, $pattern_data, $dictionary ) {
if ( empty( $pattern_data['slug'] ) ) {
_doing_it_wrong(
'register_block_patterns',
esc_html(
sprintf(
/* translators: %s: file name. */
__( 'Could not register pattern "%s" as a block pattern ("Slug" field missing)', 'woocommerce' ),
$source
)
),
'6.0.0'
);
return;
}
if ( ! preg_match( self::SLUG_REGEX, $pattern_data['slug'] ) ) {
_doing_it_wrong(
'register_block_patterns',
esc_html(
sprintf(
/* translators: %1s: file name; %2s: slug value found. */
__( 'Could not register pattern "%1$s" as a block pattern (invalid slug "%2$s")', 'woocommerce' ),
$source,
$pattern_data['slug']
)
),
'6.0.0'
);
return;
}
if ( \WP_Block_Patterns_Registry::get_instance()->is_registered( $pattern_data['slug'] ) ) {
return;
}
if ( isset( $pattern_data['featureFlag'] ) && '' !== $pattern_data['featureFlag'] && ! Features::is_enabled( $pattern_data['featureFlag'] ) ) {
return;
}
// Title is a required property.
if ( ! isset( $pattern_data['title'] ) || ! $pattern_data['title'] ) {
_doing_it_wrong(
'register_block_patterns',
esc_html(
sprintf(
/* translators: %1s: file name; %2s: slug value found. */
__( 'Could not register pattern "%s" as a block pattern ("Title" field missing)', 'woocommerce' ),
$source
)
),
'6.0.0'
);
return;
}
// For properties of type array, parse data as comma-separated.
foreach ( array( 'categories', 'keywords', 'blockTypes' ) as $property ) {
if ( ! empty( $pattern_data[ $property ] ) ) {
if ( is_array( $pattern_data[ $property ] ) ) {
$pattern_data[ $property ] = array_values(
array_map(
function ( $property ) {
return $property['title'];
},
$pattern_data[ $property ]
)
);
} else {
$pattern_data[ $property ] = array_filter(
preg_split(
self::COMMA_SEPARATED_REGEX,
(string) $pattern_data[ $property ]
)
);
}
} else {
unset( $pattern_data[ $property ] );
}
}
// Parse properties of type int.
foreach ( array( 'viewportWidth' ) as $property ) {
if ( ! empty( $pattern_data[ $property ] ) ) {
$pattern_data[ $property ] = (int) $pattern_data[ $property ];
} else {
unset( $pattern_data[ $property ] );
}
}
// Parse properties of type bool.
foreach ( array( 'inserter' ) as $property ) {
if ( ! empty( $pattern_data[ $property ] ) ) {
$pattern_data[ $property ] = in_array(
strtolower( $pattern_data[ $property ] ),
array( 'yes', 'true' ),
true
);
} else {
unset( $pattern_data[ $property ] );
}
}
// phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.LowLevelTranslationFunction
$pattern_data['title'] = translate_with_gettext_context( $pattern_data['title'], 'Pattern title', 'woocommerce' );
if ( ! empty( $pattern_data['description'] ) ) {
// phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.LowLevelTranslationFunction
$pattern_data['description'] = translate_with_gettext_context( $pattern_data['description'], 'Pattern description', 'woocommerce' );
}
$pattern_data_from_dictionary = $this->get_pattern_from_dictionary( $dictionary, $pattern_data['slug'] );
if ( file_exists( $source ) ) {
// The actual pattern content is the output of the file.
ob_start();
/*
For patterns that can have AI-generated content, we need to get its content from the dictionary and pass
it to the pattern file through the "$content" and "$images" variables.
This is to avoid having to access the dictionary for each pattern when it's registered or inserted.
Before the "$content" and "$images" variables were populated in each pattern. Since the pattern
registration happens in the init hook, the dictionary was being access one for each pattern and
for each page load. This way we only do it once on registration.
For more context: https://github.com/woocommerce/woocommerce-blocks/pull/11733
*/
$content = array();
$images = array();
if ( ! is_null( $pattern_data_from_dictionary ) ) {
$content = $pattern_data_from_dictionary['content'];
$images = $pattern_data_from_dictionary['images'] ?? array();
}
include $source;
$pattern_data['content'] = ob_get_clean();
if ( ! $pattern_data['content'] ) {
return;
}
}
$category_labels = $this->get_category_labels();
if ( ! empty( $pattern_data['categories'] ) ) {
foreach ( $pattern_data['categories'] as $key => $category ) {
$category_slug = _wp_to_kebab_case( $category );
$pattern_data['categories'][ $key ] = $category_slug;
$label = $category_labels[ $category_slug ] ?? self::kebab_to_capital_case( $category_slug );
register_block_pattern_category(
$category_slug,
array(
'label' => $label,
),
);
}
}
register_block_pattern( $pattern_data['slug'], $pattern_data );
}
/**
* Filter the patterns dictionary to get the pattern data corresponding to the pattern slug.
*
* @param array $dictionary The patterns' dictionary.
* @param string $slug The pattern slug.
*
* @return array|null
*/
private function get_pattern_from_dictionary( $dictionary, $slug ) {
foreach ( $dictionary as $pattern_dictionary ) {
if ( isset( $pattern_dictionary['slug'] ) && $pattern_dictionary['slug'] === $slug ) {
return $pattern_dictionary;
}
}
return null;
}
/**
* Convert a kebab-case string to capital case.
*
* @param string $value The kebab-case string.
*
* @return string
*/
private static function kebab_to_capital_case( $value ) {
$string = str_replace( '-', ' ', $value );
$string = ucwords( $string );
return $string;
}
}
|