convert-blocks-to-json

Convert your WP blocks to JSON.

Download

Download from WordPress plugin repository.

You can also get the latest version from any of our release tags.

Why Convert Blocks to JSON?

This plugin offers a powerful solution for importing and exporting WordPress blocks in JSON format, making it easy to move posts across different WP websites. It is also beneficial for WP engineers who are adopting a Headless CMS approach and would like a way to be able to fetch data from the front-end using tools like React, Vue & so on.

It's simple, yet very powerful!

convert-blocks-to-json-mov.mp4

Hooks

cbtj_rest_export

This custom hook (filter) provides the ability to customise the REST response obtained:

add_filter( 'cbtj_rest_export', [ $this, 'custom_rest_export' ], 10, 2 );

public function custom_rest_export( $response, $post_id ): array {
    $response['content'] = wp_parse_args(
        [
            'name'    => 'custom/post-meta-block',
            'content' => 'Lorem ipsum dolor sit amet...',
            'meta'    => [
                'address'   => get_post_meta( $post_id, 'address', true ),
                'telephone' => get_post_meta( $post_id, 'telephone', true ),
                'country'   => get_post_meta( $post_id, 'country', true ),
            ],
        ],
        $response['content']
    );

    return (array) $response;
}

Parameters

• response {mixed[]} REST Response.
• post_id {int} Post ID.

cbtj_rest_import

This custom hook (filter) provides the ability to customise the REST import. For e.g To import only paragraphs, you can do:

add_filter( 'cbtj_rest_import', [ $this, 'custom_rest_import' ], 10, 2 );

public function custom_rest_import( $import, $post_id ): array {
    return array_filter(
        $import,
        function( $block ) {
            return ( 'core/paragraph' === ( $block['name'] ?? '' ) );
        }
    );
}

Parameters

• import {mixed[]} REST Import. By default this is an array of Blocks.
• post_id {int} Post ID.

cbtj_rest_namespace

This custom hook (filter) provides users the ability to customize the default REST namespace. For e.g.

add_filter( 'cbtj_rest_namespace', [ $this, 'custom_namespace' ] );

public function custom_namespace( $namespace ): array {
    return 'my-custom-namespace/v1';
}

Parameters

• namespace {string} REST Namespace. By default, this is a string which contains the Route namespace.

---

Contribute

Contributions are welcome and will be fully credited. To contribute, please fork this repo and raise a PR (Pull Request) against the master branch.

Pre-requisites

You should have the following tools before proceeding to the next steps:

• Composer
• Yarn
• Docker

To enable you start development, please run:

yarn start

This should spin up a local WP env instance for you to work with at:

http://cbtj.localhost:5478

You should now have a functioning local WP env to work with. To login to the wp-admin backend, please username as admin & password as password.

Awesome! - Thanks for being interested in contributing your time and code to this project!