インストール

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

  1. npm install @wordpress/block-directory --save

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

使用法

このパッケージは、スタンドアロンのJSファイルを構築します。ブロックエディタを使用しているページで読み込まれると、WordPress.orgからブロックを検索するためにブロック挿入器を拡張します。

これを行うために、unstableInserterMenuExtensionを使用します。これは、ブロックタイプリストにフックされたスロットフィルエリアです。ユーザーが検索を実行し、現在インストールされている結果がない場合、WordPress.orgに一致するブロックのリクエストを送信します。これらは、ユーザーがワンクリックプロセスでインストールできるようにリストされます。このプロセスは、ブロックをインストール、アクティブ化し、投稿に挿入します。 投稿が保存されると、ブロックが使用されていない場合は、静かにアンインストールされます。 clutterを避けるために。

WordPress.orgの検索用APIエンドポイントも参照してください: /wp/v2/block-directory/search、およびプラグインのインストールとアクティブ化: /wp/v2/plugins/。

アクション

次の一連のディスパッチアクションクリエーターは、wp.data.dispatch( 'core/block-directory' )によって返されるオブジェクトで利用可能です:

addInstalledBlockType

「新しくインストールされた」トラッキングリストにブロックタイプを追加するために使用されるアクションオブジェクトを返します。

パラメータ

  • item Object: ブロックIDと名前を持つブロックアイテム。

返り値

  • Object: アクションオブジェクト。

clearErrorNotice

特定のブロックのエラーノーティスを空に設定します。

パラメータ

  • blockId string: ブロックプラグインのID。例: my-block

返り値

  • Object: アクションオブジェクト。

fetchDownloadableBlocks

ダウンロード可能なブロックがリクエストされていることを示すために使用されるアクションオブジェクトを返します。

パラメータ

  • filterValue string: 検索文字列。

返り値

  • Object: アクションオブジェクト。

installBlockType

ブロックプラグインをインストールするためにトリガーされるアクション。

パラメータ

  • block Object: 検索によって返されたブロックアイテム。

返り値

  • boolean: ブロックが正常にインストールされ、読み込まれたかどうか。

receiveDownloadableBlocks

ダウンロード可能なブロックが更新されたことを示すために使用されるアクションオブジェクトを返します。

パラメータ

  • downloadableBlocks Array: ダウンロード可能なブロック。
  • filterValue string: 検索文字列。

返り値

  • Object: アクションオブジェクト。

removeInstalledBlockType

「新しくインストールされた」トラッキングリストからブロックタイプを削除するために使用されるアクションオブジェクトを返します。

パラメータ

  • item string: ブロックIDと名前を持つブロックアイテム。

返り値

  • Object: アクションオブジェクト。

setErrorNotice

特定のブロックに対してユーザーに表示されるエラーノーティスを設定します。

パラメータ

  • blockId string: ブロックプラグインのID。例: my-block
  • message string: ノーティスに表示されるメッセージ。
  • isFatal boolean: ユーザーがエラーから回復できるかどうか。

返り値

  • Object: アクションオブジェクト。

setIsInstalling

インストールが進行中であることを示すために使用されるアクションオブジェクトを返します。

パラメータ

  • blockId string:
  • isInstalling boolean:

返り値

  • Object: アクションオブジェクト。

uninstallBlockType

ブロックプラグインをアンインストールするためにトリガーされるアクション。

パラメータ

  • block Object: ブロックタイプオブジェクト。

セレクター

次のセレクターは、wp.data.select( 'core/block-directory' )によって返されるオブジェクトで利用可能です:

getDownloadableBlocks

利用可能な未インストールのブロックを返します。

パラメータ

  • state Object: グローバルアプリケーション状態。
  • filterValue string: 検索文字列。

返り値

  • Array: ダウンロード可能なブロック。

getErrorNoticeForBlock

特定のブロックに対するエラーノーティスを返します。

パラメータ

  • state Object: グローバルアプリケーション状態。
  • blockId string: ブロックプラグインのID。例: my-block

返り値

  • string|boolean: エラーテキスト、またはエラーがない場合はfalse。

getErrorNotices

すべてのブロックエラーノーティスを返します。

パラメータ

  • state Object: グローバルアプリケーション状態。

返り値

  • Object: エラーノーティスを持つオブジェクト。

getInstalledBlockTypes

このセッションでサーバーにインストールされたブロックタイプを返します。

パラメータ

  • state Object: グローバルアプリケーション状態。

返り値

  • Array: ブロックタイプアイテム

getNewBlockTypes

サーバーにインストールされ、現在の投稿で使用されているブロックタイプを返します。

パラメータ

  • state Object: グローバルアプリケーション状態。

返り値

  • Array: ブロックタイプアイテム。

getUnusedBlockTypes

サーバーにインストールされているが、現在の投稿で使用されていないブロックタイプを返します。

パラメータ

  • state Object: グローバルアプリケーション状態。

返り値

  • Array: ブロックタイプアイテム。

isInstalling

ブロックプラグインのインストールが進行中である場合はtrueを返します。

パラメータ

  • state Object: グローバルアプリケーション状態。
  • blockId string: ブロックのID。

返り値

  • boolean: このブロックが現在インストールされているかどうか。

isRequestingDownloadableBlocks

アプリケーションがダウンロード可能なブロックをリクエストしている場合はtrueを返します。

パラメータ

  • state Object: グローバルアプリケーション状態。
  • filterValue string: 検索文字列。

返り値

  • boolean: ブロックリストのリクエストが進行中かどうか。

このパッケージへの貢献

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

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要な[https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md]をお読みください。