非推奨（Deprecation）

属性セットの変更

時には、古い属性を名前変更または修正するために属性セットを更新する必要があります。

例

const { registerBlockType } = wp.blocks;
registerBlockType( 'gutenberg/block-with-deprecated-version', {
   // ... other block properties go here
   attributes: {
   content: {
   type: 'string',
   default: 'some random value',
   },
   },
   save( props ) {
   return <div>{ props.attributes.content }</div>;
   },
   deprecated: [
   {
   attributes: {
   text: {
   type: 'string',
   default: 'some random value',
   },
   },
   migrate( { text } ) {
   return {
   content: text,
   };
   },
   save( props ) {
   return <p>{ props.attributes.text }</p>;
   },
   },
   ],
} );

上記の例では、pの代わりにdivを使用するようにブロックのマークアップを更新し、text属性をcontentに名前変更しました。

innerBlocksの変更

ブロックを移行する際にinnerBlocksを追加または削除する必要がある状況が存在するかもしれません。

例: ブロックがタイトル属性を段落innerBlockに移行したい場合。

例

const { registerBlockType } = wp.blocks;
registerBlockType( 'gutenberg/block-with-deprecated-version', {
   // ... block properties go here
   save( props ) {
   return <p>{ props.attributes.title }</p>;
   },
   deprecated: [
   {
   attributes: {
   title: {
   type: 'string',
   source: 'html',
   selector: 'p',
   },
   },
   migrate( attributes, innerBlocks ) {
   const { title, ...restAttributes } = attributes;
   return [
   restAttributes,
   [
   createBlock( 'core/paragraph', {
   content: attributes.title,
   fontSize: 'large',
   } ),
   ...innerBlocks,
   ],
   ];
   },
   save( props ) {
   return <p>{ props.attributes.title }</p>;
   },
   },
   ],
} );

上記の例では、タイトル属性の代わりにタイトルを持つ段落innerBlockを使用するようにブロックを更新しました。

上記はブロックの非推奨の例です。より多くの実際の例については、コアブロックライブラリで非推奨を確認してください。コアブロックはリリースごとに更新されており、シンプルな非推奨と複雑な非推奨が含まれています。