PHP API for registering blocks with Block Lab #434

lukecarbis · 2019-09-23T02:53:01Z

I've implemented the following functions, which enable to ability to register blocks programatically:

block_lab_add_block( $block_name, $block_config )

and

block_lab_add_field( $block_name, $field_name, $field_config )

Both are well documented in their respective doc blocks, if you'd like to learn more about these functions and how to use them.

They need to run during the block_lab_add_blocks action hook.

Here's some example code I have been testing with:

// One huge long array with lots defined.
block_lab_add_block(
	'one-fish',
	array(
		'title'    => 'One Fish',
		'category' => 'common',
		'icon'     => 'waves',
		'excluded' => array( 'page' ),
		'keywords' => array( 'sad', 'glad', 'bad' ),
		'fields'   => array(
			'thin' => array(
				'label'   => 'Thin',
				'control' => 'toggle',
				'width'   => '25',
				'default' => true,
			),
			'fat' => array(
				'label'   => 'Fat',
				'control' => 'toggle',
				'width'   => '25',
				'default' => false,
			),
			'hat'  => array(
				'label'   => 'Hat',
				'control' => 'select',
				'width'   => '50',
				'options' => array(
					array(
						'label' => 'Yellow',
						'value' => 'yellow',
					),
					array(
						'label' => 'Red',
						'value' => 'red',
					),
					array(
						'label' => 'Blue',
						'value' => 'blue',
					),
				),
			),
		),
	)
);

// A more minimalist approach.
block_lab_add_block( 'two-fish', array( 'icon' => 'waves' ) );
block_lab_add_field( 'two-fish', 'hello-there-ned-how-do-you-do' );
block_lab_add_field( 'two-fish', 'tell-me-tell-me-what-is-new', array( 'placeholder' => 'My hat is old, my teeth are gold.' ) );

Closes #400.

…tions

kienstra · 2019-09-23T22:55:44Z

Hi @lukecarbis,
Nice, this will be really useful.

If it's alright, tomorrow is probably the earliest I could review this.

kienstra

Looks Good, Question About Adding Method To Loader

Hi @lukecarbis,
This looks good, it's a big win for the plugin.

What do you think about moving the logic from the add_filter() calls into a new method in the Loader class?

This and #435 depend on the Loader class, but before, it wasn't really available in any other file.

#440 moves it into block_lab()->loader, and makes most of the method protected.

Either way, hope you're doing great, and look forward to talking tomorrow.

kienstra · 2019-09-24T18:01:48Z

php/helpers.php

+		$block_config['keywords'] = array();
+	}
+
+	if ( ! isset( $block_config['fields'] ) ) {


wp_parse_args() might make this a little easier

Address in e547cc3.

kienstra · 2019-09-30T04:47:49Z

php/helpers.php

+		$block_config['fields'] = array();
+	}
+
+	add_filter(


The logic in the callback looks good.

What do you think about adding a public function to class Loader like:

block_lab()->loader->add_block( $block_config );

Then, it could store the registered blocks in a protected property of Loader.

That could have most of the logic in this callback, but this particular add_filter() call wouldn't be needed.

The apply_filters( 'block_lab_blocks' ) call in Loader would still be useful, as would this block_lab_add_block() function.

Addressed in 5b98f71.

kienstra · 2019-09-30T04:52:02Z

php/helpers.php

+		$field_config['settings'] = array();
+	}
+
+	add_filter(


Like the comment above, what do you think about turning this add_filter() call into something like:

block_lab()->loader->add_field( $block_name, $field_config );

...or whatever method name.

It could then add fields to blocks added via the possible function above: block_lab()->loader->add_block( $block_config );

Ah, that wouldn't be able to add fields to existing blocks created with /wp-admin > Block Lab > Add New.

Would that be a common use case, to add a block via via /wp-admin > Block Lab > Add New, then later add a field to it with block_lab_add_field() ?

I don't think it would be a very common use case, no.

Addressed in 5b98f71.

Nice, that looks good. Thanks for pushing it.

…JSON

lukecarbis · 2019-10-13T02:40:50Z

@kienstra Thanks for you're review! Great to have your eyes on it, great suggestions.

I've made some changes to address your comments. Could you please take another look?

kienstra · 2019-10-13T17:37:27Z

Hi @lukecarbis, this looks really good. I think the logic is good to go 😄

Would you mind if I pushed some unit tests to this branch just for completeness? For example, I was thinking of suggesting we eventually change to array() to the [] syntax, and it'd be good to have as much coverage as possible if we ever make that change.

lukecarbis · 2019-10-16T00:10:41Z

Please feel free to push unit tests.

kienstra · 2019-10-16T04:28:07Z

Thanks, Luke!

Add assertions that these methods work. Also, make a slight change to add_field().

@param

The conflicts were trivial. For test-class-loader.php, I retained both edits. It class-abstract-template.php, I used the edits from the develop branch. They were only to the @param tag in a DocBlock.

Test a case where there is not 'type' passed, where it should add the type if the control exists.

…n Travis This might not work well in Travis, depending on how the version work together, like the phpunit version.

This tests using the second argument, with a long name.

This is similar to block_lab_add_block(), and uses Mockery.

kienstra · 2019-10-19T23:32:30Z

composer.json

@@ -9,6 +9,7 @@
    },
    "require-dev": {
        "brain/monkey": "^2",
+        "mockery/mockery": "^1.2.4",


This allows mocking entire classes, like Loader. It doesn't look like Brain Monkey can mock classes.

kienstra · 2019-10-19T23:47:58Z

Using the PHP API example above, the block:

Looks as expected in the Edit component
Saves its values as expected
Looks as expected in the <ServerSideRender> component and on the front end

kienstra

Great work!

Hi @lukecarbis,
This looks really good.

The API worked as expected, and I think it's ready to merge when you're ready.

kienstra · 2019-10-20T19:15:26Z

php/blocks/class-loader.php

 	 * @param array $field_config The config of the field to add.
 	 */
 	public function add_field( $block_name, $field_config ) {
 		if ( ! isset( $this->blocks[ "block-lab/{$block_name}" ] ) ) {
 			return;
 		}
 		if ( ! isset( $field_config['name'] ) ) {
-			return $blocks;
+			return;


Is it alright that I made this change? Maybe something else was intended.

No, nothing else intended. Good pickup.

lukecarbis added 4 commits September 23, 2019 11:12

Add block_lab_add_block helper function

d2bccc4

Add block_lab_add_field helper function

7b6106b

Remove test code

e1982b4

Use more descriptive argument names in block registration helper func…

10a44f9

…tions

lukecarbis requested review from RobStino and kienstra September 23, 2019 02:53

kienstra reviewed Sep 30, 2019

View reviewed changes

kienstra mentioned this pull request Sep 30, 2019

Experiment with moving Loader class into a property of Plugin, making most methods protected #440

Merged

lukecarbis added 7 commits October 13, 2019 09:11

Merge branch 'develop' into feature/php-api

301baab

Use wp_parse_args for default block and field config

e547cc3

Store an array of blocks in the loader class, instead of a string of …

ea42556

…JSON

Merge branch 'develop' into feature/php-api

fddc514

Move field type default to the field class

6c26b66

Change action name to add_block instead of register_block

c4e93c6

Move block registration logic to the Loader

5b98f71

kienstra added 6 commits October 19, 2019 13:31

Add unit tests for add_field() and add_block()

aed43f4

Add assertions that these methods work. Also, make a slight change to add_field().

Merge in develop, resolve conflicts

0da5c4b

The conflicts were trivial. For test-class-loader.php, I retained both edits. It class-abstract-template.php, I used the edits from the develop branch. They were only to the @param tag in a DocBlock.

Add a few assertions for Field::from_array()

9f33310

Test a case where there is not 'type' passed, where it should add the type if the control exists.

Add a short test for block_lab_add_block() to see how Mockery works i…

dad1818

…n Travis This might not work well in Travis, depending on how the version work together, like the phpunit version.

Add another assertion for block_lab_add_block()

074f61d

This tests using the second argument, with a long name.

Add a test for block_lab_add_field()

2cfd4ad

This is similar to block_lab_add_block(), and uses Mockery.

kienstra reviewed Oct 19, 2019

View reviewed changes

kienstra approved these changes Oct 19, 2019

View reviewed changes

kienstra reviewed Oct 20, 2019

View reviewed changes

lukecarbis merged commit 8306071 into develop Oct 22, 2019

lukecarbis deleted the feature/php-api branch October 22, 2019 11:44

lukecarbis mentioned this pull request Oct 28, 2019

Version bump to 1.5.0 #455

Merged

kienstra mentioned this pull request Dec 17, 2019

Block builder API #400

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PHP API for registering blocks with Block Lab #434

PHP API for registering blocks with Block Lab #434

lukecarbis commented Sep 23, 2019 •

edited

Loading

kienstra commented Sep 23, 2019

kienstra left a comment

kienstra Sep 24, 2019

lukecarbis Oct 13, 2019

kienstra Sep 30, 2019 •

edited

Loading

lukecarbis Oct 13, 2019

kienstra Sep 30, 2019 •

edited

Loading

kienstra Sep 30, 2019 •

edited

Loading

lukecarbis Oct 12, 2019

lukecarbis Oct 13, 2019

kienstra Oct 13, 2019

lukecarbis commented Oct 13, 2019

kienstra commented Oct 13, 2019

lukecarbis commented Oct 16, 2019

kienstra commented Oct 16, 2019

kienstra Oct 19, 2019

kienstra commented Oct 19, 2019

kienstra left a comment

kienstra Oct 20, 2019

lukecarbis Oct 22, 2019 •

edited

Loading

PHP API for registering blocks with Block Lab #434

PHP API for registering blocks with Block Lab #434

Conversation

lukecarbis commented Sep 23, 2019 • edited Loading

kienstra commented Sep 23, 2019

kienstra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kienstra Sep 30, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kienstra Sep 30, 2019 • edited Loading

Choose a reason for hiding this comment

kienstra Sep 30, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukecarbis commented Oct 13, 2019

kienstra commented Oct 13, 2019

lukecarbis commented Oct 16, 2019

kienstra commented Oct 16, 2019

Choose a reason for hiding this comment

kienstra commented Oct 19, 2019

kienstra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukecarbis Oct 22, 2019 • edited Loading

Choose a reason for hiding this comment

lukecarbis commented Sep 23, 2019 •

edited

Loading

kienstra Sep 30, 2019 •

edited

Loading

kienstra Sep 30, 2019 •

edited

Loading

kienstra Sep 30, 2019 •

edited

Loading

lukecarbis Oct 22, 2019 •

edited

Loading