Gutenberg withInstanceId. When to use it?

WordPress Development Asked by at least three characters on July 25, 2020

The WordPress block API for Gutenberg has a withInstanceId package.

They say,

Some components need to generate a unique id for each instance. This
could serve as suffixes to element ID’s for example. Wrapping a
component with withInstanceId provides a unique instanceId to serve
this purpose.

and show an example:

 * WordPress dependencies
import { withInstanceId } from '@wordpress/compose';

function MyCustomElement( { instanceId } ) {
    return (
        <div id={ `my-custom-element-${ instanceId }` }>

export default withInstanceId( MyCustomElement );

It seems like it is just being used for html ids? As to not have duplicate id names? Is there any other usage for it? If i just export my component using export default withInstanceId( MyCustomElement ) will the entire component have a unique id?

2 Answers

The generated id is added to the component's props. So it can be accessed through this.props.instanceId inside the component.

In the example you posted it is being used to assign a unique id attribute to the html element. However it can be used for custom logic inside react. Just as an example, you can assign each component an id and then save its data to the redux store, that way when you need to access the data from an element inside the store you can use its id to find it.

Correct answer by Alvaro on July 25, 2020

You could use clientId to uniquely identify the block. clientId is available in props.

Something like this..

export function EditBlock({clientId, setAttributes} ) {
  // save clientId in attributes to make it available in Save
  return (
        <div id={ `my-custom-element-${ clientId }` }>

No need for HOC.

Answered by Meera on July 25, 2020

Add your own answers!

Ask a Question

Get help from others!

© 2024 All rights reserved. Sites we Love: PCI Database, UKBizDB, Menu Kuliner, Sharing RPP