-
Notifications
You must be signed in to change notification settings - Fork 8
/
gutenberg-blocks-sample.php
406 lines (338 loc) · 13.3 KB
/
gutenberg-blocks-sample.php
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
<?php
/**
* Plugin that add Gutenberg block samples
*
* @link https://github.com/eudesgit/gutenberg-sample-blocks
* @since 1.0.0
* @package Gutenberg_Block_Samples
*
* @wordpress-plugin
* Plugin Name: Gutenberg Block Samples
* Plugin URI: https://github.com/eudesgit/gutenberg-sample-blocks
* Description: Simple plugin that adds Gutenberg block samples for WP developers learning and boilerplate
* Version: 0.8.0
* Author: Eudes
* Author URI: https://github.com/eudesgit/
* License: Apache-2.0
* Text Domain: gutenberg-blocks-sample
*/
// If this file is called directly, abort.
if ( ! defined( 'WPINC' ) ) {
die;
}
const GBC_VERSION = '0.8.0';
class Gutenberg_Blocks_Sample {
/**
* The unique identifier of this plugin (slug).
*
* @since 1.0.0
* @access protected
* @var string $plugin_name The string used to uniquely identify this plugin.
*/
protected $plugin_name;
/**
* The array of actions registered with WordPress.
*
* @since 1.0.0
* @access protected
* @var array $actions The actions registered with WordPress to fire when the plugin loads.
*/
protected $actions;
/**
* Define the core functionality of the plugin.
*
* Set the plugin name and the plugin version that can be used throughout the plugin.
* Load the dependencies, define the locale, and set the hooks for the admin area and
* the public-facing side of the site.
*
* @since 1.0.0
*/
public function __construct() {
$this->plugin_name = 'gutenberg-blocks-sample';
$this->actions = [];
$this->filters = [];
// Register hooks
$this->hooks();
}
/**
* Getters
*/
public function get_plugin_name ( ) { return $this->plugin_name; }
/**
* Register all hooks
*
* @since 1.0.0
* @access private
*/
private function hooks ( ) {
$this->add_action('init', $this, 'register_simple_block_action');
$this->add_action('init', $this, 'register_editable_block_action');
$this->add_action('init', $this, 'register_inspected_block_action');
$this->add_action('init', $this, 'register_dynamic_block_action');
}
/**
* Registers the simple block JS script and its styles
*
* @since 1.0.0
* @return void
*/
public function register_simple_block_action ( ) {
$block_name = 'block-simple';
$block_namespace = 'gutenberg-blocks-sample/' . $block_name;
$script_slug = $this->plugin_name . '-' . $block_name;
$style_slug = $this->plugin_name . '-' . $block_name . '-style';
$editor_style_slug = $this->plugin_name . '-' . $block_name . '-editor-style';
// The JS block script
$script_file = $block_name . '/block.build.js';
wp_enqueue_script(
$script_slug,
plugin_dir_url(__FILE__) . $script_file,
[ // Dependencies that will have to be imported on the block JS file
'wp-blocks', // Required: contains registerBlockType function that creates a block
'wp-element', // Required: contains element function that handles HTML markup
'wp-i18n', // contains registerBlockType function that creates a block
],
plugin_dir_path(__FILE__) . $script_file
);
// The block style
// It will be loaded on the editor and on the site
wp_register_style(
$style_slug,
plugin_dir_url( __FILE__ ) . $block_name . '/css/style.css',
['wp-blocks'], // General style
GBC_VERSION
);
// The block style for the editor only
wp_register_style(
$editor_style_slug,
plugin_dir_url( __FILE__ ) . $block_name . '/css/editor.css',
['wp-edit-blocks'], // Style for the editor
GBC_VERSION
);
// Registering the block
register_block_type(
$block_namespace, // Block name with namespace
[
'style' => $style_slug, // General block style slug
'editor_style' => $editor_style_slug, // Editor block style slug
'editor_script' => $script_slug, // The block script slug
]
);
}
/**
* Registers the editable block JS script and its styles
*
* @since 1.0.0
* @return void
*/
public function register_editable_block_action ( ) {
$block_name = 'block-editable';
$block_namespace = 'gutenberg-blocks-sample/' . $block_name;
$script_slug = $this->plugin_name . '-' . $block_name;
$style_slug = $this->plugin_name . '-' . $block_name . '-style';
$editor_style_slug = $this->plugin_name . '-' . $block_name . '-editor-style';
// The JS block script
$script_file = $block_name . '/block.build.js';
wp_enqueue_script(
$script_slug,
plugin_dir_url(__FILE__) . $script_file,
[ // Dependencies that will have to be imported on the block JS file
'wp-blocks', // Required: contains registerBlockType function that creates a block
'wp-element', // Required: contains element function that handles HTML markup
'wp-editor', // Required: contains RichText component for editable inputs
'wp-i18n', // contains registerBlockType function that creates a block
],
filemtime(plugin_dir_path(__FILE__) . $script_file)
);
// The block style
// It will be loaded on the editor and on the site
wp_register_style(
$style_slug,
plugin_dir_url( __FILE__ ) . $block_name . '/css/style.css',
['wp-blocks'], // General style
GBC_VERSION
);
// The block style for the editor only
wp_register_style(
$editor_style_slug,
plugin_dir_url( __FILE__ ) . $block_name . '/css/editor.css',
['wp-edit-blocks'], // Style for the editor
GBC_VERSION
);
// Registering the block
register_block_type(
$block_namespace, // Block name with namespace
[
'style' => $style_slug, // General block style slug
'editor_style' => $editor_style_slug, // Editor block style slug
'editor_script' => $script_slug, // The block script slug
]
);
}
/**
* Registers the inspected block JS script and its styles
*
* @since 1.0.0
* @return void
*/
public function register_inspected_block_action ( ) {
$block_name = 'block-inspected';
$block_namespace = 'gutenberg-blocks-sample/' . $block_name;
$script_slug = $this->plugin_name . '-' . $block_name;
$style_slug = $this->plugin_name . '-' . $block_name . '-style';
$editor_style_slug = $this->plugin_name . '-' . $block_name . '-editor-style';
// The JS block script
wp_enqueue_script(
$script_slug,
plugin_dir_url( __FILE__ ) . $block_name . '/block.build.js',
['wp-blocks', 'wp-i18n', 'wp-element'], // Required scripts for the block
GBC_VERSION
);
// The block style
// It will be loaded on the editor and on the site
wp_register_style(
$style_slug,
plugin_dir_url( __FILE__ ) . $block_name . '/css/style.css',
['wp-blocks'], // General style
GBC_VERSION
);
// The block style for the editor only
wp_register_style(
$editor_style_slug,
plugin_dir_url( __FILE__ ) . $block_name . '/css/editor.css',
['wp-edit-blocks'], // Style for the editor
GBC_VERSION
);
// Registering the block
register_block_type(
$block_namespace, // Block name with namespace
[
'style' => $style_slug, // General block style slug
'editor_style' => $editor_style_slug, // Editor block style slug
'editor_script' => $script_slug, // The block script slug
]
);
}
/**
* Registers the dynamic server side block JS script and its styles
*
* @since 1.0.0
* @return void
*/
public function register_dynamic_block_action ( ) {
$block_name = 'block-dynamic';
$block_namespace = 'gutenberg-blocks-sample/' . $block_name;
$script_slug = $this->plugin_name . '-' . $block_name;
$style_slug = $this->plugin_name . '-' . $block_name . '-style';
$editor_style_slug = $this->plugin_name . '-' . $block_name . '-editor-style';
// The JS block script
wp_enqueue_script(
$script_slug,
plugin_dir_url( __FILE__ ) . $block_name . '/block.build.js',
['wp-blocks', 'wp-i18n', 'wp-element'], // Required scripts for the block
GBC_VERSION
);
// The block style
// It will be loaded on the editor and on the site
wp_register_style(
$style_slug,
plugin_dir_url( __FILE__ ) . $block_name . '/css/style.css',
['wp-blocks'], // General style
GBC_VERSION
);
// The block style for the editor only
wp_register_style(
$editor_style_slug,
plugin_dir_url( __FILE__ ) . $block_name . '/css/editor.css',
['wp-edit-blocks'], // Style for the editor
GBC_VERSION
);
// Registering the block
register_block_type(
$block_namespace, // Block name with namespace
[
'style' => $style_slug, // General block style slug
'editor_style' => $editor_style_slug, // Editor block style slug
'editor_script' => $script_slug, // The block script slug
'render_callback' => [$this, 'block_dynamic_render_cb'], // The render callback
]
);
}
/**
* CALLBACK
*
* Render callback for the dynamic block.
*
* Instead of rendering from the block's save(), this callback will render the front-end
*
* @since 1.0.0
* @param $att Attributes from the JS block
* @return string Rendered HTML
*/
public function block_dynamic_render_cb ( $att ) {
// Coming from RichText, each line is an array's element
$soma = $att['number1'][0] + $att['number2'][0];
$html = "<h1>$soma</h1>";
return $html;
}
/**
* Add a new action to the collection to be registered with WordPress.
*
* @since 1.0.0
* @param string $hook The name of the WordPress action that is being registered.
* @param object $component A reference to the instance of the object on which the action is defined.
* @param string $callback The name of the function definition on the $component.
* @param int $priority Optional. The priority at which the function should be fired. Default is 10.
* @param int $accepted_args Optional. The number of arguments that should be passed to the $callback. Default is 1.
*/
protected function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
$this->actions = $this->add( $this->actions, $hook, $component, $callback, $priority, $accepted_args );
}
/**
* A utility function that is used to register the actions and hooks into a single
* collection.
*
* @since 1.0.0
* @access private
* @param array $hooks The collection of hooks that is being registered (that is, actions or filters).
* @param string $hook The name of the WordPress filter that is being registered.
* @param object $component A reference to the instance of the object on which the filter is defined.
* @param string $callback The name of the function definition on the $component.
* @param int $priority The priority at which the function should be fired.
* @param int $accepted_args The number of arguments that should be passed to the $callback.
* @return array The collection of actions and filters registered with WordPress.
*/
private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {
$hooks[] = [
'hook' => $hook,
'component' => $component,
'callback' => $callback,
'priority' => $priority,
'accepted_args' => $accepted_args
];
return $hooks;
}
/**
* Run the loader to execute all of the hooks with WordPress.
*
* @since 1.0.0
*/
public function run() {
$this->run_adds();
}
/**
* Register the filters and actions with WordPress.
*
* @since 1.0.0
*/
public function run_adds() {
foreach ( $this->actions as $hook ) {
add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
}
}
}
/*
* BEGIN
*/
$gsb = new Gutenberg_Blocks_Sample();
$gsb->run();