Question 165153 in Wordpress Question posted in
The official Wordpress documentation can be found here.

Does WordPress Block.json return correct paths?

I’ve created a custom block plugin with @wordpress/create-block (https://developer.wordpress.org/block-editor/reference-guides/packages/packages-create-block/)

It works as a plugin, but when i move it into the theme, the "editorScript" in the block.json file, returns the wrong path.

themeDirectory/blocks/mycustomblock/block.json

{
    "name": "create-block/mycustomblock",
    "title": "Mycustomblock",
    "description": "Example block written with ESNext standard and JSX support – build step required.",
    "category": "text",
    "icon": "smiley",
    "supports": {
        "html": false
    },
    "attributes":{
        "backgroundColor": {
            "type": "string",
            "default": "red"
        }
    },
    "editorScript": "file:./build/index.js"
}

Returned path from editorScript:

404 | http://localhost:8888/wordpress-test/wp-content/plugins/Users/jonrose/Dropbox/htdocs/wordpress-test/wp-content/themes/mytheme/blocks/mycustomblock/build/index.js?ver=4f45658ee3212a45c5d5367f6fbdfeba

If i register the script inside the register_block_type function it works fine

wp_register_script( 'mycustomblock-js', get_template_directory_uri() . '/blocks/mycustomblock/build/index.js', array( 'wp-blocks' ));

    register_block_type( __DIR__, array(
        'editor_script' => 'mycustomblock-js'
    ) );
Tags:

2

Answers


  1. 0

    Registering a block type with block.json uses register_block_script_handle under the hood to register all relevant block scripts. That function uses plugins_url to generate URLs if the script uses the file:<path> pattern.

    Passing in an already existing handle (e.g., mycustomblock-js) works because register_block_script_handle sees it’s not file:<path> and just uses that handle (and corresponding URL) as-is.

    Login or Signup to reply.
  2. 0

    edavis is correct and that plugins_url() method is called when enqueing the editorScript, editorStyle, and style paths.

    Although you can pass other arguments to register_block_type to declare what you need I do like the idea of just keeping a simple block.json file. To make this work within a theme I used a filter hook for plugins_url to fix up the URL if it detects the theme path is included in the URL.

    add_filter( 'plugins_url', function ( $url, $path, $plugin ) {
    if ( strpos( $url, get_template_directory() ) !== false ) {
        $url = str_replace( 'wp-content/plugins' . get_home_path(), '', $url );
    }

    return $url;
}, 10, 3 );
    Login or Signup to reply.
Please signup or login to give your own answer.

Back To Top
Search