Package Reference - @wordpress/blocks - 《WordPress開発者リソース》日本語

インストール
API
Contributing to this package

インストール

モジュールをインストールします

npm install @wordpress/blocks --save

このパッケージは、あなたのコードがES2015+環境で実行されることを前提としています。このような言語機能やAPIのサポートが限られているか、まったくない環境を使用している場合は、コードに@wordpress/babel-preset-defaultで提供されるポリフィルを含める必要があります。

API

cloneBlock

ブロックオブジェクトを指定すると、そのブロックオブジェクトのコピーを返し、新しい属性をマージしたり、内部ブロックを置き換えたりすることができます。

パラメータ

block Object: ブロックインスタンス。
mergeAttributes Object: ブロック属性。
newInnerBlocks ?Array: ネストされたブロック。

戻り値

Object: 複製されたブロック。

createBlock

タイプと属性を指定すると、ブロックオブジェクトを返します。

パラメータ

name string: ブロック名。
attributes Object: ブロック属性。
innerBlocks ?Array: ネストされたブロック。

戻り値

Object: ブロックオブジェクト。

createBlocksFromInnerBlocksTemplate

InnerBlocksテンプレートまたはブロックオブジェクトの配列を指定すると、それらから作成されたブロックの配列を返します。InnerBlocksをブロックとして持つ場合は、再帰的に続行するために適切な形式に変換します。

パラメータ

innerBlocksOrTemplate Array: ネストされたブロックまたはInnerBlocksテンプレート。

戻り値

Object[]: ブロックオブジェクトの配列。

doBlocksMatchTemplate

ブロック名を比較して、ブロックのリストがテンプレートと一致するかどうかを確認します。

パラメータ

blocks Array: ブロックリスト。
template Array: ブロックテンプレート。

戻り値

boolean: ブロックのリストがテンプレートと一致するかどうか。

findTransform

変換の配列を指定すると、述語関数が真の値を返す最も優先度の高い変換を返します。優先度の高い変換は、優先度値が低いもの（つまり、優先度順で最初）です。変換セットが空であるか、述語関数がすべてのエントリに対して偽の値を返す場合はnullを返します。

パラメータ

transforms Object[]: 検索する変換。
predicate Function: 一致する変換でtrueを返す関数。

戻り値

?Object: 最も優先度の高い変換候補。

getBlockAttributes

指定されたタイプの登録されたブロックノードのブロック属性を返します。

パラメータ

blockTypeOrName string|Object: ブロックタイプまたは名前。
innerHTML string|Node: 生のブロックコンテンツ。
attributes ?Object: 既知のブロック属性（区切り文字から）。

戻り値

Object: すべてのブロック属性。

getBlockAttributesNamesByRole


*パラメータ*  
- name `````string`````: ブロック属性の名前。 
- role `````string`````: ブロック属性の役割。
*戻り値*  
- `````string[]`````: 提供された役割を持つ属性名。
 <a name="getblockbindingssource"></a>
### getBlockBindingsSource
名前によって登録されたブロックバインディングソースを返します。  
*パラメータ*  
- name `````string`````: ブロックバインディングソース名。
*戻り値*  
- `````?Object`````: ブロックバインディングソース。
*変更履歴*  
`````6.7.0````` WordPressコアに導入されました。  
 <a name="getblockbindingssources"></a>
### getBlockBindingsSources
すべての登録されたブロックバインディングソースを返します。  
*戻り値*  
- `````Array`````: ブロックバインディングソース。
*変更履歴*  
`````6.7.0````` WordPressコアに導入されました。  
 <a name="getblockcontent"></a>
### getBlockContent
ブロックオブジェクトを指定すると、ブロックの内部HTMLマークアップを返します。  
*パラメータ*  
- block `````Object`````: ブロックインスタンス。
*戻り値*  
- `````string`````: HTML。
 <a name="getblockdefaultclassname"></a>
### getBlockDefaultClassName
ブロックの名前からデフォルトのクラス名を返します。  
*パラメータ*  
- blockName `````string`````: ブロック名。
*戻り値*  
- `````string`````: ブロックのデフォルトクラス。
 <a name="getblockfromexample"></a>
### getBlockFromExample
例のAPIからブロックオブジェクトを作成します。  
*パラメータ*  
- name `````string`````: 
- example `````Object`````:
*戻り値*  
- `````Object`````: ブロック。
 <a name="getblockmenudefaultclassname"></a>
### getBlockMenuDefaultClassName
ブロックの名前からデフォルトのメニューアイテムクラス名を返します。  
*パラメータ*  
- blockName `````string`````: ブロック名。
*戻り値*  
- `````string`````: ブロックのデフォルトメニューアイテムクラス。
 <a name="getblocksupport"></a>
### getBlockSupport
定義されている場合、機能のブロックサポート値を返します。  
*パラメータ*  
- nameOrType `````(string|Object)`````: ブロック名またはタイプオブジェクト 
- feature `````string`````: 取得する機能 
- defaultSupports `````*`````: 明示的に定義されていない場合に返すデフォルト値
*戻り値*  
- `````?*`````: ブロックサポート値
 <a name="getblocktransforms"></a>
### getBlockTransforms
指定された変換方向の通常のブロック変換を返します。特定のブロック名のためにオプションで、変換がない場合は空の配列を返します。ブロック名が提供されていない場合は、すべてのブロックの変換を返します。通常の変換オブジェクトには、`````blockName`````がプロパティとして含まれます。  
*パラメータ*  
- direction `````string`````: 変換方向（「to」、「from」）。 
- blockTypeOrName `````string|Object`````: ブロックタイプまたは名前。
*戻り値*  
- `````Array`````: 方向のブロック変換。
 <a name="getblocktype"></a>
### getBlockType
登録されたブロックタイプを返します。  
*パラメータ*  
- name `````string`````: ブロック名。
*戻り値*  
- `````?Object`````: ブロックタイプ。
 <a name="getblocktypes"></a>
### getBlockTypes
すべての登録されたブロックを返します。  
*戻り値*  
- `````Array`````: ブロック設定。
 <a name="getchildblocknames"></a>
### getChildBlockNames
指定されたブロックの子ブロックの配列を返します。  
*パラメータ*  
- blockName `````string`````: ブロックの名前（例：「latest-posts」）。
*戻り値*  
- `````Array`````: 子ブロック名の配列。
 <a name="getdefaultblockname"></a>
### getDefaultBlockName
デフォルトのブロック名を取得します。  
*戻り値*  
- `````?string`````: ブロック名。
 <a name="getfreeformcontenthandlername"></a>
### getFreeformContentHandlerName
非ブロックコンテンツを処理するブロックの名前を取得します。定義されていない場合はundefinedを返します。  
*戻り値*  
- `````?string`````: ブロック名。
 <a name="getgroupingblockname"></a>
### getGroupingBlockName
グループ化インタラクションを処理するために使用されるブロックの名前を取得します。  
*戻り値*  
- `````?string`````: ブロック名。
 <a name="getphrasingcontentschema"></a>
### getPhrasingContentSchema
未文書の宣言。  
 <a name="getpossibleblocktransformations"></a>
### getPossibleBlockTransformations
引数として受け取ったブロックのセットが変換できるブロックタイプの配列を返します。  
*パラメータ*  
- blocks `````Array`````: ブロックの配列。
*戻り値*  
- `````Array`````: 引数としてのブロックが変換できるブロックタイプ。
 <a name="getsavecontent"></a>
### getSaveContent
保存レンダリング実装と属性を含むブロックタイプを指定すると、保存される静的マークアップを返します。  
*パラメータ*  
- blockTypeOrName `````string|Object`````: ブロックタイプまたは名前。 
- attributes `````Object`````: ブロック属性。 
- innerBlocks `````?Array`````: ネストされたブロック。
*戻り値*  
- `````string`````: 保存コンテンツ。
 <a name="getsaveelement"></a>
### getSaveElement
保存レンダリング実装と属性を含むブロックタイプを指定すると、保存される強化された要素または生のHTMLが期待される場合は文字列を返します。  
*パラメータ*  
- blockTypeOrName `````string|Object`````: ブロックタイプまたは名前。 
- attributes `````Object`````: ブロック属性。 
- innerBlocks `````?Array`````: ネストされたブロック。
*戻り値*  
- `````Object|string`````: 保存要素または生のHTML文字列。
 <a name="getunregisteredtypehandlername"></a>
### getUnregisteredTypeHandlerName
未登録のブロックタイプを処理するブロックの名前を取得します。定義されていない場合はundefinedを返します。  
*戻り値*  
- `````?string`````: ブロック名。
 <a name="hasblocksupport"></a>
### hasBlockSupport
ブロックが機能のサポートを定義している場合はtrueを返し、そうでない場合はfalseを返します。  
*パラメータ*  
- nameOrType `````(string|Object)`````: ブロック名またはタイプオブジェクト。 
- feature `````string`````: テストする機能。 
- defaultSupports `````boolean`````: 明示的に定義されていない場合に機能がデフォルトでサポートされているかどうか。
*戻り値*  
- `````boolean`````: ブロックが機能をサポートしているかどうか。
 <a name="haschildblocks"></a>
### hasChildBlocks
ブロックに子ブロックがあるかどうかを示すブール値を返します。  
*パラメータ*  
- blockName `````string`````: ブロックの名前（例：「latest-posts」）。
*戻り値*  
- `````boolean`````: ブロックが子ブロックを含む場合はtrue、そうでない場合はfalse。
 <a name="haschildblockswithinsertersupport"></a>
### hasChildBlocksWithInserterSupport
ブロックにインサータサポートを持つ子ブロックが少なくとも1つあるかどうかを示すブール値を返します。  
*パラメータ*  
- blockName `````string`````: ブロックタイプ名。
*戻り値*  
- `````boolean`````: ブロックがインサータサポートを持つ子ブロックを少なくとも1つ含む場合はtrue、そうでない場合はfalse。
 <a name="isreusableblock"></a>
### isReusableBlock
指定されたブロックが再利用可能なブロックであるかどうかを判断します。これは、APIを介して保存されたグローバルブロックを指すために使用される特別なブロックタイプです。  
*パラメータ*  
- blockOrType `````Object`````: テストするブロックまたはブロックタイプ。
*戻り値*  
- `````boolean`````: 指定されたブロックが再利用可能なブロックであるかどうか。
 <a name="istemplatepart"></a>
### isTemplatePart
指定されたブロックがテンプレートパートであるかどうかを判断します。これは、再利用可能なデザイン要素からページテンプレートを構成することを可能にする特別なブロックタイプです。  
*パラメータ*  
- blockOrType `````Object`````: テストするブロックまたはブロックタイプ。
*戻り値*  
- `````boolean`````: 指定されたブロックがテンプレートパートであるかどうか。
 <a name="isunmodifiedblock"></a>
### isUnmodifiedBlock
ブロックの属性がデフォルトの属性と等しいかどうかを判断します。これは、ブロックが未変更であることを意味します。  
*パラメータ*  
- block `````WPBlock`````: ブロックオブジェクト
*戻り値*  
- `````boolean`````: ブロックが未変更のブロックであるかどうか。
 <a name="isunmodifieddefaultblock"></a>
### isUnmodifiedDefaultBlock
ブロックがデフォルトのブロックであり、その属性がデフォルトの属性と等しいかどうかを判断します。これは、ブロックが未変更であることを意味します。  
*パラメータ*  
- block `````WPBlock`````: ブロックオブジェクト
*戻り値*  
- `````boolean`````: ブロックが未変更のデフォルトブロックであるかどうか。
 <a name="isvalidblockcontent"></a>
### isValidBlockContent
> **非推奨** データ損失を避けるためにvalidateBlockを使用してください。   
入力コンテンツに対して解析されたブロックが有効である場合はtrueを返します。ブロックは、仮定された属性でシリアル化されたときに、コンテンツが元の値と一致する場合、有効と見なされます。  
無効な場合は、開発環境でコンソールにログを記録します。  
*パラメータ*  
- blockTypeOrName `````string|Object`````: ブロックタイプ。 
- attributes `````Object`````: 解析されたブロック属性。 
- originalBlockContent `````string`````: 元のブロックコンテンツ。
*戻り値*  
- `````boolean`````: ブロックが有効かどうか。
 <a name="isvalidicon"></a>
### isValidIcon
パラメータが有効なアイコンであるかどうかをチェックする関数。  
*パラメータ*  
- icon `````*`````: チェックされるパラメータ。
*戻り値*  
- `````boolean`````: パラメータが有効なアイコンである場合はtrue、そうでない場合はfalse。
 <a name="normalizeiconobject"></a>
### normalizeIconObject
ブロックが登録中に設定したアイコンを受け取り、コードベースで可能なアイコン構造に依存できるように正規化された新しいアイコンオブジェクトを返す関数。  
*パラメータ*  
- icon `````WPBlockTypeIconRender`````: ブロックタイプアイコンのレンダリング動作; Dashiconスラグ、要素、またはコンポーネントのいずれか。
*戻り値*  
- `````WPBlockTypeIconDescriptor`````: アイコンを説明するオブジェクト。
 <a name="parse"></a>
### parse
Gutenberg文法仕様に基づく最適化されたトークン駆動のパーサーを利用して、ブロック区切り文字によって提供される通常のリズムを活用し、一般的なHTMLドキュメントを入力として受け取り、ブロックリストの配列表現を返します。  
これは、入力ドキュメントを一度線形にスキャンする再帰的下降パーサーです。直接再帰するのではなく、スタックオーバーフローを防ぐためにトランポリンメカニズムを利用します。この初期パスは、ドキュメント内でシリアル化されたブロックを分離して孤立させることに主に関心があり、ブロック内のコンテンツには明示的に関心がありません。  
*関連*  
- [https://developer.wordpress.org/block-editor/packages/packages-block-serialization-default-parser/](https://developer.wordpress.org/block-editor/packages/packages-block-serialization-default-parser/)
*パラメータ*  
- content `````string`````: 投稿コンテンツ。 
- options `````ParseOptions`````: ブロック解析を処理するための追加オプション。
*戻り値*  
- `````Array`````: ブロックリスト。
 <a name="parsewithattributeschema"></a>
### parseWithAttributeSchema
ブロックの生のコンテンツと属性のスキーマを指定すると、そのソースに応じて属性の値を返します。  
*パラメータ*  
- innerHTML `````string|Node`````: ブロックの生のコンテンツ。 
- attributeSchema `````Object`````: 属性のスキーマ。
*戻り値*  
- `````*`````: 属性値。
 <a name="pastehandler"></a>
### pasteHandler
HTML文字列を既知のブロックに変換します。他のすべてを削除します。  
*パラメータ*  
- options `````Object`````: 
- options.HTML `````[string]`````: 変換するHTML。 
- options.plainText `````[string]`````: プレーンテキストバージョン。 
- options.mode `````[string]`````: コンテンツをブロックまたはインラインコンテンツとして処理します。 _ ‘AUTO’: 渡されたコンテンツに基づいて決定します。 _ ‘INLINE’: 常にインラインコンテンツとして処理し、文字列を返します。 * ‘BLOCKS’: 常にブロックとして処理し、ブロックの配列を返します。 
- options.tagName `````[Array]`````: コンテンツが挿入されるタグ。
*戻り値*  
- `````Array|string`````: ブロックのリストまたは文字列、`````handlerMode`````に応じて。
 <a name="privateapis"></a>
### privateApis
未文書の宣言。  
 <a name="rawhandler"></a>
### rawHandler
HTML文字列を既知のブロックに変換します。  
*パラメータ*  
- $1 `````Object`````: 
- $1.HTML `````string`````: 変換するHTML。
*戻り値*  
- `````Array`````: ブロックのリスト。
 <a name="registerblockbindingssource"></a>
### registerBlockBindingsSource
その動作を定義するオブジェクトを持つ新しいブロックバインディングソースを登録します。登録されると、そのソースはサポートされているブロック属性に接続できるようになります。  
*使用法*  
``````bash
import { _x } from '@wordpress/i18n';
import { registerBlockBindingsSource } from '@wordpress/blocks';
registerBlockBindingsSource( {
   name: 'plugin/my-custom-source',
   label: _x( 'My Custom Source', 'block bindings source' ),
   usesContext: [ 'postType' ],
   getValues: getSourceValues,
   setValues: updateMyCustomValuesInBatch,
   canUserEditValue: () => true,
} );
`

パラメータ

source Object: 登録されるソースのプロパティ。
source.name string: 一意で機械可読な名前。
source.label [string]: 人間可読なラベル。サーバーで定義されている場合はオプションです。
source.usesContext [Array]: エディタ内でのみソースが必要とするオプションのコンテキストの配列。
source.getValues [Function]: ソースから値を取得するためのオプションの関数。
source.setValues [Function]: ソースに接続された複数の値を更新するためのオプションの関数。
source.canUserEditValue [Function]: ユーザーが値を編集できるかどうかを判断するためのオプションの関数。

変更履歴

6.7.0 WordPressコアに導入されました。

registerBlockCollection

同じ名前空間でブロックをグループ化するための新しいブロックコレクションを登録します。

使用法

import { __ } from '@wordpress/i18n';
import { registerBlockCollection, registerBlockType } from '@wordpress/blocks';
// Register the collection.
registerBlockCollection( 'my-collection', {
   title: __( 'Custom Collection' ),
} );
// Register a block in the same namespace to add it to the collection.
registerBlockType( 'my-collection/block-name', {
   title: __( 'My First Block' ),
   edit: () => <div>{ __( 'Hello from the editor!' ) }</div>,
   save: () => <div>'Hello from the saved content!</div>,
} );

パラメータ

namespace string: インサータ内でブロックをグループ化するための名前空間; ブロック名前空間に対応します。
settings Object: ブロックコレクションの設定。
settings.title string: ブロックインサータに表示されるタイトル。
settings.icon [Object]: ブロックインサータに表示されるアイコン。

registerBlockStyle

指定されたブロックタイプの新しいブロックスタイルを登録します。

CSSとスタイルを接続する方法についての詳細は公式ドキュメントを参照してください。

使用法

import { __ } from '@wordpress/i18n';
import { registerBlockStyle } from '@wordpress/blocks';
import { Button } from '@wordpress/components';
const ExampleComponent = () => {
   return (
   <Button
   onClick={ () => {
   registerBlockStyle( 'core/quote', {
   name: 'fancy-quote',
   label: __( 'Fancy Quote' ),
   } );
   } }
   >
   { __( 'Add a new block style for core/quote' ) }
   </Button>
   );
};

パラメータ

blockNames string|Array: ブロックの名前（例: “core/latest-posts”または["core/group", "core/columns"]）。
styleVariation Object: nameを含むオブジェクトで、これはブロックに適用されるクラス名であり、labelはユーザーに対してバリエーションを識別します。

registerBlockType

一意の名前とその動作を定義するオブジェクトを提供すると、新しいブロックを登録します。登録されると、そのブロックはブロックが実装されている任意のエディタインターフェースでオプションとして利用可能になります。

カスタムブロックを登録する方法についての詳細は、ブロックを作成するチュートリアルを参照してください。

使用法

import { __ } from '@wordpress/i18n';
import { registerBlockType } from '@wordpress/blocks';
registerBlockType( 'namespace/block-name', {
   title: __( 'My First Block' ),
   edit: () => <div>{ __( 'Hello from the editor!' ) }</div>,
   save: () => <div>Hello from the saved content!</div>,
} );

パラメータ

blockNameOrMetadata string|Object: ブロックタイプ名またはそのメタデータ。
settings Object: ブロック設定。

戻り値

WPBlockType | undefined: ブロックが正常に登録された場合はブロック、それ以外の場合はundefined。

registerBlockVariation

指定されたブロックタイプの新しいブロックバリエーションを登録します。

ブロックバリエーションに関する詳細は公式ドキュメントを参照してください。

使用法

import { __ } from '@wordpress/i18n';
import { registerBlockVariation } from '@wordpress/blocks';
import { Button } from '@wordpress/components';
const ExampleComponent = () => {
   return (
   <Button
   onClick={ () => {
   registerBlockVariation( 'core/embed', {
   name: 'custom',
   title: __( 'My Custom Embed' ),
   attributes: { providerNameSlug: 'custom' },
   } );
   } }
   >
   __( 'Add a custom variation for core/embed' ) }
   </Button>
   );
};

パラメータ

blockName string: ブロックの名前（例: “core/columns”）。
variation WPBlockVariation: ブロックバリエーションを説明するオブジェクト。

serialize

ブロックまたはブロックのセットを受け取り、シリアル化された投稿コンテンツを返します。

パラメータ

blocks Array: シリアル化するブロック。
options WPBlockSerializationOptions: シリアル化オプション。

戻り値

string: 投稿コンテンツ。

serializeRawBlock

ブロックノードをネイティブHTMLコメント駆動のブロック形式にシリアル化します。注意: この関数は、有効なパーサーによって解析されたブロックを再シリアル化するために意図されており、検証ステップをスキップします。これは、メモリ内のブロック用の一般的なシリアル化関数ではありません。ほとんどの目的には、@wordpress/blocksパッケージで利用可能な次の関数を参照してください:

setCategories

ブロックカテゴリを設定します。

使用法

import { __ } from '@wordpress/i18n';
import { store as blocksStore, setCategories } from '@wordpress/blocks';
import { useSelect } from '@wordpress/data';
import { Button } from '@wordpress/components';
const ExampleComponent = () => {
   // Retrieve the list of current categories.
   const blockCategories = useSelect(
   ( select ) => select( blocksStore ).getCategories(),
   []
   );
   return (
   <Button
   onClick={ () => {
   // Add a custom category to the existing list.
   setCategories( [
   ...blockCategories,
   { title: 'Custom Category', slug: 'custom-category' },
   ] );
   } }
   >
   { __( 'Add a new custom block category' ) }
   </Button>
   );
};

パラメータ

categories WPBlockCategory[]: ブロックカテゴリ。

setDefaultBlockName

デフォルトのブロック名を割り当てます。

使用法

import { setDefaultBlockName } from '@wordpress/blocks';
const ExampleComponent = () => {
   return (
   <Button onClick={ () => setDefaultBlockName( 'core/heading' ) }>
   { __( 'Set the default block to Heading' ) }
   </Button>
   );
};

パラメータ

name string: ブロック名。

setFreeformContentHandlerName

非ブロックコンテンツを処理するブロックの名前を割り当てます。

パラメータ

blockName string: ブロック名。

setGroupingBlockName

ブロックグループ化インタラクションを処理するためのブロックの名前を割り当てます。

この関数を使用すると、デフォルトのcore/groupブロックの代わりに他のブロックを選択して他のブロックをグループ化できます。この関数は、コンポーネント内またはDOMが完全に読み込まれたときに使用する必要があります。詳細はhttps://developer.wordpress.org/block-editor/reference-guides/packages/packages-dom-ready/を参照してください。

使用法

import { setGroupingBlockName } from '@wordpress/blocks';
const ExampleComponent = () => {
   return (
   <Button onClick={ () => setGroupingBlockName( 'core/columns' ) }>
   { __( 'Wrap in columns' ) }
   </Button>
   );
};

パラメータ

name string: ブロック名。

setUnregisteredTypeHandlerName

未登録のブロックタイプを処理するブロックの名前を割り当てます。

パラメータ

blockName string: ブロック名。

store

ブロック名前空間のストア定義。

switchToBlockType

1つ以上のブロックを新しいブロックタイプの1つ以上のブロックに切り替えます。

パラメータ

blocks Array|Object: ブロックの配列またはブロックオブジェクト。
name string: ブロック名。

戻り値

?Array: ブロックの配列またはnull。

synchronizeBlocksWithTemplate

ブロックリストをブロックテンプレートと同期させます。

ブロックリストをブロックテンプレートと同期させるとは、ブロックをループして、テンプレート内の同じ位置にあるブロックと一致する場合はそのまま保持し（同じ名前を持つ場合）、一致しない場合はテンプレートに基づいて新しいブロックを作成します。テンプレートに存在しない追加のブロックは削除されます。

パラメータ

blocks Array: ブロックリスト。
template Array: ブロックテンプレート。

戻り値

Array: 更新されたブロックリスト。

unregisterBlockBindingsSource

その名前を提供することによってブロックバインディングソースの登録を解除します。

使用法

import { unregisterBlockBindingsSource } from '@wordpress/blocks';
unregisterBlockBindingsSource( 'plugin/my-custom-source' );

パラメータ

name string: 登録解除するブロックバインディングソースの名前。

変更履歴

6.7.0 WordPressコアに導入されました。

unregisterBlockStyle

指定されたブロックのブロックスタイルの登録を解除します。

使用法

import { __ } from '@wordpress/i18n';
import { unregisterBlockStyle } from '@wordpress/blocks';
import { Button } from '@wordpress/components';
const ExampleComponent = () => {
   return (
   <Button
   onClick={ () => {
   unregisterBlockStyle( 'core/quote', 'plain' );
   } }
   >
   { __( 'Remove the "Plain" block style for core/quote' ) }
   </Button>
   );
};

パラメータ

blockName string: ブロックの名前（例: “core/latest-posts”）。
styleVariationName string: ブロックに適用されるクラスの名前。

unregisterBlockType

ブロックの登録を解除します。

使用法

import { __ } from '@wordpress/i18n';
import { unregisterBlockType } from '@wordpress/blocks';
const ExampleComponent = () => {
   return (
   <Button
   onClick={ () => unregisterBlockType( 'my-collection/block-name' ) }
   >
   { __( 'Unregister my custom block.' ) }
   </Button>
   );
};

パラメータ

name string: ブロック名。

戻り値

WPBlockType | undefined: 以前のブロック値。正常に登録解除された場合はそれを返し、そうでない場合はundefinedを返します。

unregisterBlockVariation

指定されたブロックタイプのために定義されたブロックバリエーションの登録を解除します。

使用法

import { __ } from '@wordpress/i18n';
import { unregisterBlockVariation } from '@wordpress/blocks';
import { Button } from '@wordpress/components';
const ExampleComponent = () => {
   return (
   <Button
   onClick={ () => {
   unregisterBlockVariation( 'core/embed', 'youtube' );
   } }
   >
   { __( 'Remove the YouTube variation from core/embed' ) }
   </Button>
   );
};

パラメータ

blockName string: ブロックの名前（例: “core/columns”）。
variationName string: ブロックに対して定義されたバリエーションの名前。

updateCategory

カテゴリを更新します。

使用法

import { __ } from '@wordpress/i18n';
import { updateCategory } from '@wordpress/blocks';
import { Button } from '@wordpress/components';
const ExampleComponent = () => {
   return (
   <Button
   onClick={ () => {
   updateCategory( 'text', { title: __( 'Written Word' ) } );
   } }
   >
   { __( 'Update Text category title' ) }
   </Button>
   );
};

パラメータ

slug string: ブロックカテゴリのスラグ。
category WPBlockCategory: 更新すべきカテゴリプロパティを含むオブジェクト。

validateBlock

解析されたブロックが入力コンテンツに対して有効である場合、isValidプロパティがtrueに設定されたオブジェクトを返します。ブロックは、仮定された属性でシリアル化されたときに、コンテンツが元の値と一致する場合、有効と見なされます。ブロックが無効な場合、この関数はすべての検証問題も返します。

パラメータ

block WPBlock: ブロックオブジェクト。
blockTypeOrName [WPBlockType|string]: ブロックタイプまたは名前。与えられない場合はブロックから推測されます。

戻り値

[boolean,Array<LoggerItem>]: 検証結果。

withBlockContentContext

非推奨
コンテキストを使用してラップされたコンポーネントにBlockContentを注入するために使用される高階コンポーネント。

パラメータ

OriginalComponent Component: 強化するコンポーネント。

戻り値

Component: 同じコンポーネント。

Contributing to this package

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要な貢献者ガイドをお読みください。