-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBlock_Style_Command.php
More file actions
221 lines (204 loc) · 5.23 KB
/
Block_Style_Command.php
File metadata and controls
221 lines (204 loc) · 5.23 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
<?php
namespace WP_CLI\Block;
use WP_CLI;
use WP_CLI\Formatter;
use WP_CLI_Command;
use WP_Block_Styles_Registry;
/**
* Retrieves details on registered block styles.
*
* Get information on block style variations from the WP_Block_Styles_Registry.
*
* ## EXAMPLES
*
* # List all registered block styles
* $ wp block style list
*
* # List styles for a specific block
* $ wp block style list --block=core/button
*
* # Get details about a specific style
* $ wp block style get core/button outline
*
* @package wp-cli
*/
class Block_Style_Command extends WP_CLI_Command {
/**
* Default fields to display.
*
* @var array
*/
private $fields = [
'block_name',
'name',
'label',
'is_default',
];
/**
* Lists registered block styles.
*
* ## OPTIONS
*
* [--block=<block>]
* : Filter by block type name (e.g., 'core/button').
*
* [--field=<field>]
* : Prints the value of a single field for each style.
*
* [--fields=<fields>]
* : Limit the output to specific style fields.
*
* [--format=<format>]
* : Render output in a particular format.
* ---
* default: table
* options:
* - table
* - csv
* - json
* - count
* - yaml
* ---
*
* ## AVAILABLE FIELDS
*
* These fields will be displayed by default for each style:
*
* * block_name
* * name
* * label
* * is_default
*
* These fields are optionally available:
*
* * style_handle
* * inline_style
*
* ## EXAMPLES
*
* # List all block styles
* $ wp block style list
*
* # List styles for the button block
* $ wp block style list --block=core/button
*
* # List all styles as JSON
* $ wp block style list --format=json
*
* @subcommand list
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function list_( $args, $assoc_args ) {
$registry = WP_Block_Styles_Registry::get_instance();
$items = [];
// Filter by specific block or get all.
if ( ! empty( $assoc_args['block'] ) ) {
$block_name = $assoc_args['block'];
$styles = $registry->get_registered_styles_for_block( $block_name );
foreach ( $styles as $style_name => $style ) {
$items[] = $this->style_to_array( $block_name, $style_name, $style );
}
unset( $assoc_args['block'] );
} else {
// Get all registered styles for all blocks.
$all_styles = $registry->get_all_registered();
foreach ( $all_styles as $block_name => $styles ) {
foreach ( $styles as $style_name => $style ) {
$items[] = $this->style_to_array( $block_name, $style_name, $style );
}
}
}
$formatter = $this->get_formatter( $assoc_args );
$formatter->display_items( $items );
}
/**
* Gets details about a registered block style.
*
* ## OPTIONS
*
* <block>
* : Block type name (e.g., 'core/button').
*
* <style>
* : Style name (e.g., 'outline').
*
* [--field=<field>]
* : Instead of returning the whole style, 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 the outline style for buttons
* $ wp block style get core/button outline
*
* # Get as JSON
* $ wp block style get core/button outline --format=json
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function get( $args, $assoc_args ) {
$block_name = $args[0];
$style_name = $args[1];
$registry = WP_Block_Styles_Registry::get_instance();
$styles = $registry->get_registered_styles_for_block( $block_name );
if ( ! isset( $styles[ $style_name ] ) ) {
WP_CLI::error( "Block style '{$style_name}' for block '{$block_name}' is not registered." );
}
$style = $styles[ $style_name ];
if ( empty( $assoc_args['fields'] ) ) {
$assoc_args['fields'] = array_merge(
$this->fields,
[
'style_handle',
'inline_style',
]
);
}
$formatter = $this->get_formatter( $assoc_args );
$data = $this->style_to_array( $block_name, $style_name, $style );
$formatter->display_item( $data );
}
/**
* Converts a style array to a standardized associative array.
*
* @param string $block_name Block type name.
* @param string $style_name Style name.
* @param array $style Style array from registry.
* @return array
*/
private function style_to_array( $block_name, $style_name, $style ) {
return [
'block_name' => $block_name,
'name' => $style_name,
'label' => isset( $style['label'] ) ? $style['label'] : '',
'is_default' => isset( $style['is_default'] ) ? $style['is_default'] : false,
'style_handle' => isset( $style['style_handle'] ) ? $style['style_handle'] : '',
'inline_style' => isset( $style['inline_style'] ) ? $style['inline_style'] : '',
];
}
/**
* 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-style' );
}
}