-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBlock_Pattern_Command.php
More file actions
277 lines (258 loc) · 6.92 KB
/
Block_Pattern_Command.php
File metadata and controls
277 lines (258 loc) · 6.92 KB
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<?php
namespace WP_CLI\Block;
use WP_CLI;
use WP_CLI\Formatter;
use WP_CLI_Command;
use WP_Block_Patterns_Registry;
/**
* Retrieves details on registered block patterns.
*
* Get information on WordPress' built-in and custom block patterns from the
* WP_Block_Patterns_Registry.
*
* ## EXAMPLES
*
* # List all registered block patterns
* $ wp block pattern list
*
* # Get details about a specific pattern
* $ wp block pattern get core/query-standard-posts --format=json
*
* # List patterns in a specific category
* $ wp block pattern list --category=featured
*
* @package wp-cli
*/
class Block_Pattern_Command extends WP_CLI_Command {
/**
* Default fields to display.
*
* @var array
*/
private $fields = [
'name',
'title',
'description',
'categories',
];
/**
* Lists registered block patterns.
*
* ## OPTIONS
*
* [--category=<category>]
* : Filter by pattern category.
*
* [--search=<search>]
* : Search patterns by title or keywords.
*
* [--inserter]
* : Only show patterns visible in the inserter.
*
* [--field=<field>]
* : Prints the value of a single field for each pattern.
*
* [--fields=<fields>]
* : Limit the output to specific pattern fields.
*
* [--format=<format>]
* : Render output in a particular format.
* ---
* default: table
* options:
* - table
* - csv
* - json
* - count
* - yaml
* - ids
* ---
*
* ## AVAILABLE FIELDS
*
* These fields will be displayed by default for each pattern:
*
* * name
* * title
* * description
* * categories
*
* These fields are optionally available:
*
* * content
* * keywords
* * blockTypes
* * postTypes
* * templateTypes
* * inserter
* * viewportWidth
*
* ## EXAMPLES
*
* # List all registered patterns
* $ wp block pattern list
*
* # List patterns in the 'buttons' category
* $ wp block pattern list --category=buttons
*
* # Search for hero patterns
* $ wp block pattern list --search=hero
*
* # Export all patterns to JSON
* $ wp block pattern list --format=json > patterns.json
*
* @subcommand list
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function list_( $args, $assoc_args ) {
$registry = WP_Block_Patterns_Registry::get_instance();
$patterns = $registry->get_all_registered();
// Filter by category.
if ( ! empty( $assoc_args['category'] ) ) {
$category = $assoc_args['category'];
$patterns = array_filter(
$patterns,
function ( $pattern ) use ( $category ) {
return isset( $pattern['categories'] ) && in_array( $category, $pattern['categories'], true );
}
);
unset( $assoc_args['category'] );
}
// Filter by search term.
if ( ! empty( $assoc_args['search'] ) ) {
$search = strtolower( $assoc_args['search'] );
$patterns = array_filter(
$patterns,
function ( $pattern ) use ( $search ) {
// Search in title.
if ( isset( $pattern['title'] ) && strpos( strtolower( $pattern['title'] ), $search ) !== false ) {
return true;
}
// Search in keywords.
if ( isset( $pattern['keywords'] ) && is_array( $pattern['keywords'] ) ) {
foreach ( $pattern['keywords'] as $keyword ) {
/**
* @var string $keyword
*/
if ( strpos( strtolower( $keyword ), $search ) !== false ) {
return true;
}
}
}
return false;
}
);
unset( $assoc_args['search'] );
}
// Filter by inserter visibility.
if ( isset( $assoc_args['inserter'] ) ) {
$patterns = array_filter(
$patterns,
function ( $pattern ) {
return ! isset( $pattern['inserter'] ) || false !== $pattern['inserter'];
}
);
unset( $assoc_args['inserter'] );
}
$formatter = $this->get_formatter( $assoc_args );
if ( 'ids' === $formatter->format ) {
$ids = wp_list_pluck( $patterns, 'name' );
echo implode( ' ', $ids );
return;
}
$items = array_map( [ $this, 'pattern_to_array' ], $patterns );
$formatter->display_items( $items );
}
/**
* Gets details about a registered block pattern.
*
* ## OPTIONS
*
* <name>
* : Pattern name including namespace (e.g., 'core/query-standard-posts').
*
* [--field=<field>]
* : Instead of returning the whole pattern, returns the value of a single field.
*
* [--fields=<fields>]
* : Limit the output to specific fields. Defaults to all fields.
*
* [--format=<format>]
* : Render output in a particular format.
* ---
* default: table
* options:
* - table
* - csv
* - json
* - yaml
* ---
*
* ## EXAMPLES
*
* # Get a pattern's content
* $ wp block pattern get core/query-standard-posts --field=content
*
* # Get full pattern details as JSON
* $ wp block pattern get my-theme/hero --format=json
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function get( $args, $assoc_args ) {
$registry = WP_Block_Patterns_Registry::get_instance();
$pattern = $registry->get_registered( $args[0] );
if ( ! $pattern ) {
WP_CLI::error( "Block pattern '{$args[0]}' is not registered." );
}
if ( empty( $assoc_args['fields'] ) ) {
$assoc_args['fields'] = array_merge(
$this->fields,
[
'content',
'keywords',
'blockTypes',
'postTypes',
'templateTypes',
'inserter',
'viewportWidth',
]
);
}
$formatter = $this->get_formatter( $assoc_args );
$data = $this->pattern_to_array( $pattern );
$formatter->display_item( $data );
}
/**
* Converts a pattern array to a standardized associative array.
*
* @param array $pattern Pattern array from registry.
* @return array
*/
private function pattern_to_array( $pattern ) {
return [
'name' => isset( $pattern['name'] ) ? $pattern['name'] : '',
'title' => isset( $pattern['title'] ) ? $pattern['title'] : '',
'description' => isset( $pattern['description'] ) ? $pattern['description'] : '',
'categories' => isset( $pattern['categories'] ) ? $pattern['categories'] : [],
'content' => isset( $pattern['content'] ) ? $pattern['content'] : '',
'keywords' => isset( $pattern['keywords'] ) ? $pattern['keywords'] : [],
'blockTypes' => isset( $pattern['blockTypes'] ) ? $pattern['blockTypes'] : [],
'postTypes' => isset( $pattern['postTypes'] ) ? $pattern['postTypes'] : [],
'templateTypes' => isset( $pattern['templateTypes'] ) ? $pattern['templateTypes'] : [],
'inserter' => isset( $pattern['inserter'] ) ? $pattern['inserter'] : true,
'viewportWidth' => isset( $pattern['viewportWidth'] ) ? $pattern['viewportWidth'] : null,
];
}
/**
* Gets the formatter instance.
*
* @param array $assoc_args Associative arguments.
* @return Formatter
*/
private function get_formatter( &$assoc_args ) {
return new Formatter( $assoc_args, $this->fields, 'block-pattern' );
}
}