インストール

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

  1. npm install @wordpress/e2e-test-utils --save-dev

注意: このパッケージは、長期サポートステータスのあるNode.jsバージョンを必要とします(アクティブLTSまたはメンテナンスLTSリリースを確認)。古いバージョンとは互換性がありません。

API

activatePlugin

インストールされたプラグインをアクティブにします。

パラメータ

  • slug string: プラグインのスラッグ。

activateTheme

インストールされたテーマをアクティブにします。

パラメータ

  • slug string: テーマのスラッグ。

arePrePublishChecksEnabled

公開チェックが有効かどうかを確認します。

戻り値

  • Promise<boolean>: プレパブリッシュチェックの状態を表すブール値。

canvas

エディターのキャンバスフレームを取得します。

changeSiteTimezone

一般設定ページにアクセスし、タイムゾーンを指定された値に変更します。

パラメータ

  • timezone string: 設定するタイムゾーンの値。

戻り値

  • string: 前のタイムゾーンの値。

clearLocalStorage

ローカルストレージをクリアします。

clickBlockAppender

デフォルトのブロックアペンダーをクリックします。

clickBlockToolbarButton

ブロックツールバーボタンをクリックします。

パラメータ

  • label string: ボタンラベルのテキスト文字列。
  • type [string]: ボタンラベルのタイプ: ‘ariaLabel’または‘content’。

clickButton

ボタンのテキストに基づいてボタンをクリックします。

パラメータ

  • buttonText string: クリックするボタンに表示されるテキスト。

clickMenuItem

提供されたテキストでメニュー内のアイテムを検索し、クリックします。

パラメータ

  • label string: メニューアイテムを検索するためのラベル。

clickOnCloseModalButton

オープンモーダルの閉じるボタンをクリックします。

パラメータ

  • modalClassName ?string: 閉じるモーダルのクラス名

clickOnMoreMenuItem

More Menuアイテムをクリックし、提供されたテキストのボタンを検索してクリックします。

パラメータ

  • buttonLabel string: ボタンを検索するためのラベル。

closeGlobalBlockInserter

グローバルインサータを閉じます。

closeListView

リストビューを閉じます

createEmbeddingMatcher

リクエストが特定のURLを埋め込んでいるかどうかを判断する関数を作成します。

パラメータ

  • url string: リクエストに対してチェックするURL。

戻り値

  • Function: リクエストが埋め込みAPIのものであり、特定のURLを埋め込んでいるかどうかを判断する関数。

createJSONResponse

リクエストにJSONレスポンスで応答します。

パラメータ

  • mockResponse string: JSONレスポンスでラップするモックオブジェクト。

戻り値

  • Promise: モックJSONレスポンスでリクエストに応答するPromise。

createMenu

REST APIを使用してメニューとそのすべてのリンクリソースを作成します。

パラメータ

  • menu Object: メニューのRESTペイロード
  • menuItems ?Array: 作成するメニューアイテムのデータ。

createNewPost

新しい投稿を作成します。

パラメータ

  • object Object: 新しい投稿を作成するためのオブジェクト、オプションを有効にするヒントを含む。
  • object.postType [string]: 新しい投稿の投稿タイプ。
  • object.title [string]: 新しい投稿のタイトル。
  • object.content [string]: 新しい投稿の内容。
  • object.excerpt [string]: 新しい投稿の抜粋。
  • object.showWelcomeGuide [boolean]: ウェルカムガイドを表示するかどうか。

createNewTemplate

新しく作成されたテンプレートでテンプレートエディタを開きます。

パラメータ

  • name string: テンプレートの名前。

createReusableBlock

段落ブロックを持つシンプルな再利用可能ブロックを作成します。

パラメータ

  • content string: 段落ブロックの内容
  • title title: 再利用可能ブロックの名前。

createURL

ベースURL、WPPath、およびクエリ文字列を解析して新しいURLを作成します。

パラメータ

  • WPPath string: パス名としてシリアライズされる文字列。
  • query ?string: URLのクエリ部分としてシリアライズされる文字列。

戻り値

  • string: 完全なURLを表す文字列。

createURLMatcher

リクエストがサブストリングを含むURLを呼び出しているかどうかを判断する関数を作成します。

パラメータ

  • substring string: チェックするサブストリング。

戻り値

  • Function: リクエストのURLがサブストリングを含むかどうかを判断する関数。

createUser

新しいユーザーアカウントを作成します。

パラメータ

  • username string: ユーザー名。
  • object Object?: 新しいユーザーアカウントのオプション設定。
  • object.firstName [string]: 名。
  • object.lastName [string]: 姓。
  • object.role [string]: 役割。デフォルトは管理者です。

戻り値

  • string: 新しく作成されたユーザーアカウントのパスワード。

deactivatePlugin

アクティブなプラグインを無効にします。

パラメータ

  • slug string: プラグインのスラッグ。

deleteAllMenus

REST APIを使用してすべてのメニューを削除します

deleteAllTemplates

指定されたタイプのすべてのテンプレートを削除します。

パラメータ

  • type ('wp_template'|'wp_template_part'): – 削除するテンプレートのタイプ。

deleteAllWidgets

ウィジェット画面のすべてのウィジェットを削除します。

deleteTheme

サイトからテーマを削除し、必要に応じて別のテーマをアクティブにします。

パラメータ

  • slug string: テーマのスラッグ。
  • settings Object?: オプションの設定オブジェクト。
  • settings.newThemeSlug string?: 削除するテーマがアクティブな場合に切り替えるテーマ。削除するテーマがアクティブな場合は必須です。
  • settings.newThemeSearchTerm string?: 新しいテーマがそのスラッグで見つからない場合に使用する検索用語。

deleteUser

ユーザーアカウントを削除します。

パラメータ

  • username string: ユーザー名。

disableFocusLossObservation

  1. <a name="disablepagedialogaccept"></a>
  2. ### disablePageDialogAccept
  3. ダイアログの自動受け入れを無効にします。
  4. <a name="disableprepublishchecks"></a>
  5. ### disablePrePublishChecks
  6. プレパブリッシュチェックを無効にします。
  7. <a name="disablesiteeditorwelcomeguide"></a>
  8. ### disableSiteEditorWelcomeGuide
  9. サイトエディタの初回ユーザーにポップアップするウェルカムガイドをスキップします
  10. <a name="dragandresize"></a>
  11. ### dragAndResize
  12. 要素をクリックし、特定の距離をドラッグしてマウスボタンを放します。
  13. *パラメータ*
  14. - element `````Object`````: Puppeteer要素ハンドル。
  15. - delta `````Object`````: 移動距離を含むオブジェクト。
  16. - delta.x `````number`````: 水平距離をドラッグします。
  17. - delta.y `````number`````: 垂直距離をドラッグします。
  18. *戻り値*
  19. - `````Promise`````: ドラッグが完了したときに解決されるPromise。
  20. <a name="enablefocuslossobservation"></a>
  21. ### enableFocusLossObservation
  22. フォーカスを失った場合にエラーをスローするイベントリスナーをドキュメントに追加します。
  23. <a name="enablepagedialogaccept"></a>
  24. ### enablePageDialogAccept
  25. ページ上のすべてのダイアログを自動的に受け入れるイベントリスナーを有効にします。
  26. <a name="enableprepublishchecks"></a>
  27. ### enablePrePublishChecks
  28. プレパブリッシュチェックを有効にします。
  29. <a name="ensuresidebaropened"></a>
  30. ### ensureSidebarOpened
  31. 編集投稿/サイト/ウィジェットのサイドバーが開いていることを確認し、開いていない場合は開きます。
  32. *戻り値*
  33. - `````Promise`````: サイドバーが開いたときに解決されるPromise。
  34. <a name="entereditmode"></a>
  35. ### enterEditMode
  36. 編集モードに入ります。
  37. <a name="findsidebarpaneltogglebuttonwithtitle"></a>
  38. ### findSidebarPanelToggleButtonWithTitle
  39. 提供されたタイトルのサイドバーパネルを見つけます。
  40. *パラメータ*
  41. - panelTitle `````string`````: サイドバーパネルの名前。
  42. *戻り値*
  43. - `````?ElementHandle`````: ページ内のDOM要素を表すオブジェクト。
  44. <a name="findsidebarpanelwithtitle"></a>
  45. ### findSidebarPanelWithTitle
  46. 提供されたタイトルのサイドバーパネルを切り替えるボタンを見つけます。
  47. *パラメータ*
  48. - panelTitle `````string`````: サイドバーパネルの名前。
  49. *戻り値*
  50. - `````Promise<ElementHandle|undefined>`````: ページ内のDOM要素を表すオブジェクト。
  51. <a name="getallblockinserteritemtitles"></a>
  52. ### getAllBlockInserterItemTitles
  53. すべてのインサータアイテムタイトルを含む文字列の配列を返します。
  54. *戻り値*
  55. - `````Promise`````: すべてのインサータアイテムタイトルを含む配列で解決されるPromise。
  56. <a name="getallblocks"></a>
  57. ### getAllBlocks
  58. すべてのブロックを含む配列を返します; wp.data.select( ‘core/block-editor’ ).getBlocks(); を呼び出すのと同等です。
  59. *戻り値*
  60. - `````Promise`````: ドキュメント内のすべてのブロックを含む配列で解決されるPromise。
  61. <a name="getavailableblocktransforms"></a>
  62. ### getAvailableBlockTransforms
  63. 現在選択されているブロックが変換できるすべてのブロックタイトルを含む文字列の配列を返します。
  64. *戻り値*
  65. - `````Promise`````: すべての可能なブロック変換を含む配列で解決されるPromise
  66. <a name="getblocksetting"></a>
  67. ### getBlockSetting
  68. 提供されたブロック名に関連付けられたブロックタイトルを含む文字列を返します。
  69. *パラメータ*
  70. - blockName `````string`````: ブロック名。
  71. - setting `````string`````: ブロック設定(例: タイトル、属性…)。
  72. *戻り値*
  73. - `````Promise`````: ブロックタイトルを含む文字列で解決されるPromise。
  74. <a name="getcurrentpostcontent"></a>
  75. ### getCurrentPostContent
  76. 現在の投稿内容(HTML文字列)で解決されるPromiseを返します。
  77. *戻り値*
  78. - `````Promise`````: 現在の投稿内容マークアップで解決されるPromise。
  79. <a name="getcurrentsiteeditorcontent"></a>
  80. ### getCurrentSiteEditorContent
  81. 編集された投稿内容(HTML文字列)で解決されるPromiseを返します。
  82. *戻り値*
  83. - `````Promise<string>`````: 投稿内容マークアップで解決されるPromise。
  84. <a name="geteditedpostcontent"></a>
  85. ### getEditedPostContent
  86. 編集された投稿内容(HTML文字列)で解決されるPromiseを返します。
  87. *戻り値*
  88. - `````Promise`````: 投稿内容マークアップで解決されるPromise。
  89. <a name="getlistviewblocks"></a>
  90. ### getListViewBlocks
  91. 指定されたブロック名ラベルに一致するリストビュー内のすべてのブロックアンカーノードを取得します。
  92. *パラメータ*
  93. - blockLabel `````string`````: リストビューに表示されるブロックのラベル。
  94. *戻り値*
  95. - `````Promise`````: リストビュー内のラベルに一致するすべてのブロックアンカーノード。
  96. <a name="getoption"></a>
  97. ### getOption
  98. オプション管理ページからサイトオプションを返します。
  99. *パラメータ*
  100. - setting `````string`````: IDでオプションを取得するために使用されるオプション。
  101. *戻り値*
  102. - `````string`````: オプションの値。
  103. <a name="getpageerror"></a>
  104. ### getPageError
  105. 文字列またはnullのいずれかに解決されるPromiseを返します。 ページの内容にエラーメッセージが存在する場合は文字列が解決されます。 エラーが存在しない場合はnull値が解決されます。 これには、エラーを表示するように環境が設定されている必要があります。
  106. *関連*
  107. - [http://php.net/manual/en/function.error-reporting.php](http://php.net/manual/en/function.error-reporting.php)
  108. *戻り値*
  109. - `````Promise<?string>`````: ページエラーが存在するかどうかに応じて文字列またはnullに解決されるPromise。
  110. <a name="hasblockswitcher"></a>
  111. ### hasBlockSwitcher
  112. 現在選択されているブロックにブロックスイッチャーがあるかどうかを示すブール値を返します。
  113. *戻り値*
  114. - `````Promise`````: ブール値で解決されるPromise。
  115. <a name="insertblock"></a>
  116. ### insertBlock
  117. グローバルインサータを介して指定された検索用語に一致するブロックを挿入します。
  118. *パラメータ*
  119. - searchTerm `````string`````: 挿入するブロックを見つけるための用語。
  120. <a name="insertblockdirectoryblock"></a>
  121. ### insertBlockDirectoryBlock
  122. グローバルインサータを介して指定された検索用語に一致するブロックディレクトリブロックを挿入します。
  123. *パラメータ*
  124. - searchTerm `````string`````: 挿入するブロックディレクトリブロックを見つけるための用語。
  125. <a name="insertpattern"></a>
  126. ### insertPattern
  127. グローバルインサータを介して指定された検索用語に一致するパターンを挿入します。
  128. *パラメータ*
  129. - searchTerm `````string`````: 挿入するパターンを見つけるための用語。
  130. <a name="installplugin"></a>
  131. ### installPlugin
  132. WP.orgリポジトリからプラグインをインストールします。
  133. *パラメータ*
  134. - slug `````string`````: プラグインのスラッグ。
  135. - searchTerm `````string?`````: プラグインがそのスラッグで見つからない場合は、代替用語を使用して検索します。
  136. <a name="installtheme"></a>
  137. ### installTheme
  138. WP.orgリポジトリからテーマをインストールします。
  139. *パラメータ*
  140. - slug `````string`````: テーマのスラッグ。
  141. - settings `````Object?`````: オプションの設定オブジェクト。
  142. - settings.searchTerm `````string?`````: テーマがそのスラッグで見つからない場合に使用する検索用語。
  143. <a name="iscurrenturl"></a>
  144. ### isCurrentURL
  145. 現在のURLがWordPressパスであるかどうかを確認します。
  146. *パラメータ*
  147. - WPPath `````string`````: パス名としてシリアライズされる文字列。
  148. - query `````?string`````: URLのクエリ部分としてシリアライズされる文字列。
  149. *戻り値*
  150. - `````boolean`````: 現在のURLがWordPressパスであるかどうかを示すブール値。
  151. <a name="isindefaultblock"></a>
  152. ### isInDefaultBlock
  153. フォーカスされているブロックがデフォルトブロックであるかどうかを確認します。
  154. *戻り値*
  155. - `````Promise`````: フォーカスされているブロックがデフォルトブロックであるかどうかを示すブール値で解決されるPromise。
  156. <a name="islistviewopen"></a>
  157. ### isListViewOpen
  158. 未文書の宣言。
  159. <a name="isofflinemode"></a>
  160. ### isOfflineMode
  161. 未文書の宣言。
  162. <a name="isthemeinstalled"></a>
  163. ### isThemeInstalled
  164. テーマがサイトに存在するかどうかを確認します。
  165. *パラメータ*
  166. - slug `````string`````: 確認するテーマのスラッグ。
  167. *戻り値*
  168. - `````boolean`````: テーマが存在するかどうか。
  169. <a name="loginuser"></a>
  170. ### loginUser
  171. 指定されたユーザー名とパスワードでログインを実行します。
  172. *パラメータ*
  173. - username `````?string`````: ユーザー資格情報として使用される文字列。
  174. - password `````?string`````: ユーザー資格情報として使用される文字列。
  175. <a name="logout"></a>
  176. ### logout
  177. ログアウトを実行します。
  178. <a name="mockortransform"></a>
  179. ### mockOrTransform
  180. 提供されたモックオブジェクトでリクエストをモックするか、リクエストのデシリアライズされたJSONレスポンスに基づいてオプションの変換を実行します。
  181. *パラメータ*
  182. - mockCheck `````Function`````: リクエストをモックする必要がある場合はtrueを返す関数。
  183. - mock `````Object`````: リクエストをモックする必要がある場合にJSONレスポンスでラップするモックオブジェクト。
  184. - responseObjectTransform `````Function|undefined`````: レスポンスが使用される前にレスポンスのオブジェクトを変換するオプションの関数。
  185. *戻り値*
  186. - `````Promise`````: `````mockCheck`````を使用してリクエストをモックする必要があるかどうかを確認し、`````mock`````でモックし、オプションで`````responseObjectTransform`````でレスポンスを変換するPromise。
  187. <a name="opendocumentsettingssidebar"></a>
  188. ### openDocumentSettingsSidebar
  189. ヘッダーのボタンをクリックして、閉じている場合にドキュメント設定サイドバーを開きます。
  190. <a name="openglobalblockinserter"></a>
  191. ### openGlobalBlockInserter
  192. グローバルインサータを開きます。
  193. <a name="openglobalstylespanel"></a>
  194. ### openGlobalStylesPanel
  195. グローバルスタイルパネルを開きます。
  196. *パラメータ*
  197. - panelName `````string`````: 開く予定のパネルの名前。
  198. <a name="openlistview"></a>
  199. ### openListView
  200. リストビューを開きます
  201. <a name="openpreviewpage"></a>
  202. ### openPreviewPage
  203. 編集された投稿のプレビューページを開きます。
  204. *パラメータ*
  205. - editorPage `````Page`````: Puppeteerエディタページ。
  206. *戻り値*
  207. - `````Page`````: プレビューページ。
  208. <a name="openpreviousglobalstylespanel"></a>
  209. ### openPreviousGlobalStylesPanel
  210. 前のグローバルスタイルパネルを開きます。
  211. <a name="openpublishpanel"></a>
  212. ### openPublishPanel
  213. 公開パネルを開きます。
  214. <a name="opentypographytoolspanelmenu"></a>
  215. ### openTypographyToolsPanelMenu
  216. ブロックサポートを介して提供されるタイポグラフィツールパネルメニューを開きます。
  217. <a name="presskeytimes"></a>
  218. ### pressKeyTimes
  219. 指定されたキーボードキーを順番に複数回押します。
  220. *パラメータ*
  221. - key `````string`````: 押すキー。
  222. - count `````number`````: 押す回数。
  223. <a name="presskeywithmodifier"></a>
  224. ### pressKeyWithModifier
  225. 修飾キー(Shift、Control、Meta、Alt)を使用してキーを押します。各修飾キーはプラットフォーム固有の修飾キーに正規化されます。
  226. *パラメータ*
  227. - modifier `````string`````: 修飾キー。
  228. - key `````string`````: 修飾キーを押しながら押すキー。
  229. <a name="publishpost"></a>
  230. ### publishPost
  231. 投稿を公開し、リクエストが完了すると解決されます(通知が表示されると)。
  232. *戻り値*
  233. - `````Promise`````: 公開が完了したときに解決されるPromise。
  234. <a name="publishpostwithprepublishchecksdisabled"></a>
  235. ### publishPostWithPrePublishChecksDisabled
  236. プレパブリッシュチェックなしで投稿を公開し、リクエストが完了すると解決されます(通知が表示されると)。
  237. *戻り値*
  238. - `````Promise`````: 公開が完了したときに解決されるPromise。
  239. <a name="resetpreferences"></a>
  240. ### resetPreferences
  241. すべてのユーザーメタ設定をクリアします。
  242. <a name="savedraft"></a>
  243. ### saveDraft
  244. 投稿をドラフトとして保存し、リクエストが完了すると解決されます(「保存済み」インジケーターが表示されると)。
  245. *戻り値*
  246. - `````Promise`````: ドラフト保存が完了したときに解決されるPromise。
  247. <a name="searchforblock"></a>
  248. ### searchForBlock
  249. グローバルインサータを介してブロックを検索します。
  250. *パラメータ*
  251. - searchTerm `````string`````: インサータで検索する用語。
  252. *戻り値*
  253. - `````Promise<ElementHandle|null>`````: 挿入するブロックのハンドル、または何も見つからなかった場合はnull。
  254. <a name="searchforblockdirectoryblock"></a>
  255. ### searchForBlockDirectoryBlock
  256. グローバルインサータを介してブロックディレクトリブロックを検索します。
  257. *パラメータ*
  258. - searchTerm `````string`````: インサータで検索する用語。
  259. *戻り値*
  260. - `````Promise<ElementHandle|null>`````: 挿入するブロックディレクトリブロックのハンドル、または何も見つからなかった場合はnull。
  261. <a name="searchforpattern"></a>
  262. ### searchForPattern
  263. グローバルインサータを介してパターンを検索します。
  264. *パラメータ*
  265. - searchTerm `````string`````: インサータで検索する用語。
  266. *戻り値*
  267. - `````Promise<ElementHandle|null>`````: 挿入するパターンのハンドル、または何も見つからなかった場合はnull。
  268. <a name="searchforreusableblock"></a>
  269. ### searchForReusableBlock
  270. グローバルインサータを介して再利用可能ブロックを検索します。
  271. *パラメータ*
  272. - searchTerm `````string`````: インサータで検索する用語。
  273. *戻り値*
  274. - `````Promise<ElementHandle|null>`````: 挿入する再利用可能ブロックのハンドル、または何も見つからなかった場合はnull。
  275. <a name="selectblockbyclientid"></a>
  276. ### selectBlockByClientId
  277. ブロックのclientIdが与えられた場合、エディタでブロックを選択します。
  278. *パラメータ*
  279. - clientId `````string`````: ブロックの識別子。
  280. <a name="setbrowserviewport"></a>
  281. ### setBrowserViewport
  282. ブラウザのビューポートを指定されたタイプに設定します。
  283. *パラメータ*
  284. - viewport `````WPViewport`````: 割り当てるビューポート名または寸法オブジェクト。
  285. <a name="setclipboarddata"></a>
  286. ### setClipboardData
  287. `````pressKeyWithModifier( 'primary', 'v' )`````で貼り付け可能なクリップボードデータを設定します。
  288. *パラメータ*
  289. - $1 `````Object`````: オプション。
  290. - $1.plainText `````string`````: 設定するプレーンテキスト。
  291. - $1.html `````string`````: 設定するHTML。
  292. <a name="setoption"></a>
  293. ### setOption
  294. オプション一般管理ページからサイトオプションを設定します。
  295. *パラメータ*
  296. - setting `````string`````: IDでオプションを取得するために使用されるオプション。
  297. - value `````string`````: オプションに設定する値。
  298. *戻り値*
  299. - `````string`````: オプションの以前の値。
  300. <a name="setpostcontent"></a>
  301. ### setPostContent
  302. コードエディタの内容を設定します
  303. *パラメータ*
  304. - content `````string`````: 新しいコードエディタの内容。
  305. *戻り値*
  306. - `````Promise`````: ドキュメント内のすべてのブロックを含む配列で解決されるPromise。
  307. <a name="setupresponsemocking"></a>
  308. ### setUpResponseMocking
  309. モックチェックとレスポンスを設定します。 次のプロパティを持つモック設定のリストを受け入れます:
  310. - `````match`````: リクエストをモックする必要があるかどうかを確認する関数。
  311. - `````onRequestMatch`````: リクエストに応答する非同期関数。
  312. *使用法*
  313. ``````bash
  314. const MOCK_RESPONSES = [
  315. {
  316. match: isEmbedding( 'https://wordpress.org/gutenberg/handbook/' ),
  317. onRequestMatch: JSONResponse( MOCK_BAD_WORDPRESS_RESPONSE ),
  318. },
  319. {
  320. match: isEmbedding(
  321. 'https://wordpress.org/gutenberg/handbook/block-api/attributes/'
  322. ),
  323. onRequestMatch: JSONResponse( MOCK_EMBED_WORDPRESS_SUCCESS_RESPONSE ),
  324. },
  325. ];
  326. setUpResponseMocking( MOCK_RESPONSES );
  327. `

モック設定のいずれもリクエストに一致しない場合、リクエストは続行されます。

パラメータ

  • mocks Array: モック設定の配列。

showBlockToolbar

ブロックツールバーは、入力中は常に表示されるわけではありません。この関数を呼び出して表示します。

switchBlockInspectorTab

提供されたラベルのブロックインスペクタタブボタンをクリックし、タブの切り替えを待ちます。

パラメータ

  • label string: タブボタンを見つけるためのAriaラベル。

switchEditorModeTo

エディタモードを切り替えます。

パラメータ

  • mode string: 文字列エディタモード。

switchUserToAdmin

現在のユーザーを管理者ユーザーに切り替えます(テストを実行しているユーザーがすでに管理者ユーザーでない場合)。

switchUserToTest

現在のユーザーをテストを実行する必要があるユーザーに切り替えます(すでにそのユーザーでない場合)。

toggleGlobalBlockInserter

グローバルインサータを切り替えます。

toggleGlobalStyles

グローバルスタイルサイドバーを切り替えます(閉じている場合は開き、開いている場合は閉じます)。

toggleMoreMenu

More Menuを切り替えます。

パラメータ

  • waitFor ['open' | 'close']: メニューが開くまたは閉じるのを待つべきかどうか。 undefinedの場合、何も待ちません。

toggleOfflineMode

未文書の宣言。

togglePreferencesOption

指定されたタブラベルとオプションラベルで設定オプションを切り替えます。

パラメータ

  • tabLabel string: クリックする設定タブラベル。
  • optionLabel string: ボタンを検索するためのオプションラベル。
  • shouldBeChecked [boolean]: trueの場合、オプションをオンにします。 falseの場合、オフにします。 提供されていない場合、オプションは切り替えられます。

transformBlockTo

エディタのブロックタイプを変換します。

パラメータ

  • name string: ブロック名。

trashAllComments

コメントリスト画面に移動し、存在するコメントを一括でゴミ箱に入れます。

戻り値

  • Promise: コメントがゴミ箱に入れられたときに解決されるPromise。

trashAllPosts

投稿リスト画面に移動し、存在する投稿を一括でゴミ箱に入れます。

パラメータ

  • postType string: – ゴミ箱に入れる投稿のタイプの文字列スラッグ。
  • postStatus string: – ゴミ箱に入れる投稿のステータスの文字列。

戻り値

  • Promise: 投稿がゴミ箱に入れられたときに解決されるPromise。

uninstallPlugin

プラグインをアンインストールします。

パラメータ

  • slug string: プラグインのスラッグ。

visitAdminPage

管理ページにアクセスします; ユーザーがログインしていない場合は、最初にログインし、その後管理ページにアクセスします。

パラメータ

  • adminPath string: パス名としてシリアライズされる文字列。
  • query string: URLのクエリ部分としてシリアライズされる文字列。

visitSiteEditor

サイトエディタのメインページにアクセスします

デフォルトでは、ウェルカムガイドもスキップされます。このオプションは必要に応じて無効にできます。

関連

  • disableSiteEditorWelcomeGuide

パラメータ

  • query string: URLのクエリ部分としてシリアライズされる文字列。
  • skipWelcomeGuide [boolean]: ナビゲーションの一部としてウェルカムガイドをスキップするかどうか。

waitForWindowDimensions

ページビューポートが必要な寸法になるまで待機する関数です。 setViewportを使用した後、実行が続行される可能性がある問題に対処するために使用されます。 https://github.com/GoogleChrome/puppeteer/issues/1751

パラメータ

  • width number: ウィンドウの幅。
  • height number: ウィンドウの高さ。

wpDataSelect

WordPressデータモジュールをクエリします。

page.evaluate – 関数内で使用され、非シリアライズ可能な値に遭遇した場合はundefinedを返します。 データモジュールに多くの異なる値を保存しているため、undefinedの結果が得られることがあります。 この関数を使用する前に、クエリしているデータに非シリアライズ可能な値(関数、DOM要素ハンドルなど)が含まれていないことを確認してください。

関連

パラメータ

  • store string: クエリするストア(例: core/editor、core/blocks…)
  • selector string: 実行するセレクタ(例: getBlocks)。
  • parameters ...Object: セレクタに渡すパラメータ。

戻り値

  • Promise<?Object>: クエリの結果。

Contributing to this package

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

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