- インストール
- API
- activatePlugin
- activateTheme
- arePrePublishChecksEnabled
- canvas
- changeSiteTimezone
- clearLocalStorage
- clickBlockAppender
- clickBlockToolbarButton
- clickButton
- clickMenuItem
- clickOnCloseModalButton
- clickOnMoreMenuItem
- closeGlobalBlockInserter
- closeListView
- createEmbeddingMatcher
- createJSONResponse
- createMenu
- createNewPost
- createNewTemplate
- createReusableBlock
- createURL
- createURLMatcher
- createUser
- deactivatePlugin
- deleteAllMenus
- deleteAllTemplates
- deleteAllWidgets
- deleteTheme
- deleteUser
- disableFocusLossObservation
- showBlockToolbar
- switchBlockInspectorTab
- switchEditorModeTo
- switchUserToAdmin
- switchUserToTest
- toggleGlobalBlockInserter
- toggleGlobalStyles
- toggleMoreMenu
- toggleOfflineMode
- togglePreferencesOption
- transformBlockTo
- trashAllComments
- trashAllPosts
- uninstallPlugin
- visitAdminPage
- visitSiteEditor
- waitForWindowDimensions
- wpDataSelect
- Contributing to this package
インストール
モジュールをインストールします
npm install @wordpress/e2e-test-utils --save-dev
注意: このパッケージは、長期サポートステータスのあるNode.jsバージョンを必要とします(アクティブLTSまたはメンテナンスLTSリリースを確認)。古いバージョンとは互換性がありません。
API
activatePlugin
インストールされたプラグインをアクティブにします。
パラメータ
activateTheme
インストールされたテーマをアクティブにします。
パラメータ
arePrePublishChecksEnabled
公開チェックが有効かどうかを確認します。
戻り値
canvas
changeSiteTimezone
一般設定ページにアクセスし、タイムゾーンを指定された値に変更します。
パラメータ
- timezone
string
: 設定するタイムゾーンの値。
戻り値
clearLocalStorage
clickBlockAppender
clickBlockToolbarButton
ブロックツールバーボタンをクリックします。
パラメータ
clickButton
ボタンのテキストに基づいてボタンをクリックします。
パラメータ
clickMenuItem
提供されたテキストでメニュー内のアイテムを検索し、クリックします。
パラメータ
clickOnCloseModalButton
オープンモーダルの閉じるボタンをクリックします。
パラメータ
clickOnMoreMenuItem
More Menuアイテムをクリックし、提供されたテキストのボタンを検索してクリックします。
パラメータ
closeGlobalBlockInserter
closeListView
createEmbeddingMatcher
リクエストが特定のURLを埋め込んでいるかどうかを判断する関数を作成します。
パラメータ
- url
string
: リクエストに対してチェックするURL。
戻り値
createJSONResponse
リクエストにJSONレスポンスで応答します。
パラメータ
- mockResponse
string
: JSONレスポンスでラップするモックオブジェクト。
戻り値
createMenu
REST APIを使用してメニューとそのすべてのリンクリソースを作成します。
パラメータ
createNewPost
新しい投稿を作成します。
パラメータ
- object
Object
: 新しい投稿を作成するためのオブジェクト、オプションを有効にするヒントを含む。 - object.postType
[string]
: 新しい投稿の投稿タイプ。 - object.title
[string]
: 新しい投稿のタイトル。 - object.content
[string]
: 新しい投稿の内容。 - object.excerpt
[string]
: 新しい投稿の抜粋。 - object.showWelcomeGuide
[boolean]
: ウェルカムガイドを表示するかどうか。
createNewTemplate
新しく作成されたテンプレートでテンプレートエディタを開きます。
パラメータ
createReusableBlock
段落ブロックを持つシンプルな再利用可能ブロックを作成します。
パラメータ
createURL
ベースURL、WPPath、およびクエリ文字列を解析して新しいURLを作成します。
パラメータ
- WPPath
string
: パス名としてシリアライズされる文字列。 - query
?string
: URLのクエリ部分としてシリアライズされる文字列。
戻り値
createURLMatcher
リクエストがサブストリングを含むURLを呼び出しているかどうかを判断する関数を作成します。
パラメータ
- substring
string
: チェックするサブストリング。
戻り値
createUser
新しいユーザーアカウントを作成します。
パラメータ
- username
string
: ユーザー名。 - object
Object?
: 新しいユーザーアカウントのオプション設定。 - object.firstName
[string]
: 名。 - object.lastName
[string]
: 姓。 - object.role
[string]
: 役割。デフォルトは管理者です。
戻り値
deactivatePlugin
アクティブなプラグインを無効にします。
パラメータ
deleteAllMenus
deleteAllTemplates
指定されたタイプのすべてのテンプレートを削除します。
パラメータ
deleteAllWidgets
deleteTheme
サイトからテーマを削除し、必要に応じて別のテーマをアクティブにします。
パラメータ
- slug
string
: テーマのスラッグ。 - settings
Object?
: オプションの設定オブジェクト。 - settings.newThemeSlug
string?
: 削除するテーマがアクティブな場合に切り替えるテーマ。削除するテーマがアクティブな場合は必須です。 - settings.newThemeSearchTerm
string?
: 新しいテーマがそのスラッグで見つからない場合に使用する検索用語。
deleteUser
ユーザーアカウントを削除します。
パラメータ
disableFocusLossObservation
<a name="disablepagedialogaccept"></a>
### disablePageDialogAccept
ダイアログの自動受け入れを無効にします。
<a name="disableprepublishchecks"></a>
### disablePrePublishChecks
プレパブリッシュチェックを無効にします。
<a name="disablesiteeditorwelcomeguide"></a>
### disableSiteEditorWelcomeGuide
サイトエディタの初回ユーザーにポップアップするウェルカムガイドをスキップします
<a name="dragandresize"></a>
### dragAndResize
要素をクリックし、特定の距離をドラッグしてマウスボタンを放します。
*パラメータ*
- element `````Object`````: Puppeteer要素ハンドル。
- delta `````Object`````: 移動距離を含むオブジェクト。
- delta.x `````number`````: 水平距離をドラッグします。
- delta.y `````number`````: 垂直距離をドラッグします。
*戻り値*
- `````Promise`````: ドラッグが完了したときに解決されるPromise。
<a name="enablefocuslossobservation"></a>
### enableFocusLossObservation
フォーカスを失った場合にエラーをスローするイベントリスナーをドキュメントに追加します。
<a name="enablepagedialogaccept"></a>
### enablePageDialogAccept
ページ上のすべてのダイアログを自動的に受け入れるイベントリスナーを有効にします。
<a name="enableprepublishchecks"></a>
### enablePrePublishChecks
プレパブリッシュチェックを有効にします。
<a name="ensuresidebaropened"></a>
### ensureSidebarOpened
編集投稿/サイト/ウィジェットのサイドバーが開いていることを確認し、開いていない場合は開きます。
*戻り値*
- `````Promise`````: サイドバーが開いたときに解決されるPromise。
<a name="entereditmode"></a>
### enterEditMode
編集モードに入ります。
<a name="findsidebarpaneltogglebuttonwithtitle"></a>
### findSidebarPanelToggleButtonWithTitle
提供されたタイトルのサイドバーパネルを見つけます。
*パラメータ*
- panelTitle `````string`````: サイドバーパネルの名前。
*戻り値*
- `````?ElementHandle`````: ページ内のDOM要素を表すオブジェクト。
<a name="findsidebarpanelwithtitle"></a>
### findSidebarPanelWithTitle
提供されたタイトルのサイドバーパネルを切り替えるボタンを見つけます。
*パラメータ*
- panelTitle `````string`````: サイドバーパネルの名前。
*戻り値*
- `````Promise<ElementHandle|undefined>`````: ページ内のDOM要素を表すオブジェクト。
<a name="getallblockinserteritemtitles"></a>
### getAllBlockInserterItemTitles
すべてのインサータアイテムタイトルを含む文字列の配列を返します。
*戻り値*
- `````Promise`````: すべてのインサータアイテムタイトルを含む配列で解決されるPromise。
<a name="getallblocks"></a>
### getAllBlocks
すべてのブロックを含む配列を返します; wp.data.select( ‘core/block-editor’ ).getBlocks(); を呼び出すのと同等です。
*戻り値*
- `````Promise`````: ドキュメント内のすべてのブロックを含む配列で解決されるPromise。
<a name="getavailableblocktransforms"></a>
### getAvailableBlockTransforms
現在選択されているブロックが変換できるすべてのブロックタイトルを含む文字列の配列を返します。
*戻り値*
- `````Promise`````: すべての可能なブロック変換を含む配列で解決されるPromise
<a name="getblocksetting"></a>
### getBlockSetting
提供されたブロック名に関連付けられたブロックタイトルを含む文字列を返します。
*パラメータ*
- blockName `````string`````: ブロック名。
- setting `````string`````: ブロック設定(例: タイトル、属性…)。
*戻り値*
- `````Promise`````: ブロックタイトルを含む文字列で解決されるPromise。
<a name="getcurrentpostcontent"></a>
### getCurrentPostContent
現在の投稿内容(HTML文字列)で解決されるPromiseを返します。
*戻り値*
- `````Promise`````: 現在の投稿内容マークアップで解決されるPromise。
<a name="getcurrentsiteeditorcontent"></a>
### getCurrentSiteEditorContent
編集された投稿内容(HTML文字列)で解決されるPromiseを返します。
*戻り値*
- `````Promise<string>`````: 投稿内容マークアップで解決されるPromise。
<a name="geteditedpostcontent"></a>
### getEditedPostContent
編集された投稿内容(HTML文字列)で解決されるPromiseを返します。
*戻り値*
- `````Promise`````: 投稿内容マークアップで解決されるPromise。
<a name="getlistviewblocks"></a>
### getListViewBlocks
指定されたブロック名ラベルに一致するリストビュー内のすべてのブロックアンカーノードを取得します。
*パラメータ*
- blockLabel `````string`````: リストビューに表示されるブロックのラベル。
*戻り値*
- `````Promise`````: リストビュー内のラベルに一致するすべてのブロックアンカーノード。
<a name="getoption"></a>
### getOption
オプション管理ページからサイトオプションを返します。
*パラメータ*
- setting `````string`````: IDでオプションを取得するために使用されるオプション。
*戻り値*
- `````string`````: オプションの値。
<a name="getpageerror"></a>
### getPageError
文字列またはnullのいずれかに解決されるPromiseを返します。 ページの内容にエラーメッセージが存在する場合は文字列が解決されます。 エラーが存在しない場合はnull値が解決されます。 これには、エラーを表示するように環境が設定されている必要があります。
*関連*
- [http://php.net/manual/en/function.error-reporting.php](http://php.net/manual/en/function.error-reporting.php)
*戻り値*
- `````Promise<?string>`````: ページエラーが存在するかどうかに応じて文字列またはnullに解決されるPromise。
<a name="hasblockswitcher"></a>
### hasBlockSwitcher
現在選択されているブロックにブロックスイッチャーがあるかどうかを示すブール値を返します。
*戻り値*
- `````Promise`````: ブール値で解決されるPromise。
<a name="insertblock"></a>
### insertBlock
グローバルインサータを介して指定された検索用語に一致するブロックを挿入します。
*パラメータ*
- searchTerm `````string`````: 挿入するブロックを見つけるための用語。
<a name="insertblockdirectoryblock"></a>
### insertBlockDirectoryBlock
グローバルインサータを介して指定された検索用語に一致するブロックディレクトリブロックを挿入します。
*パラメータ*
- searchTerm `````string`````: 挿入するブロックディレクトリブロックを見つけるための用語。
<a name="insertpattern"></a>
### insertPattern
グローバルインサータを介して指定された検索用語に一致するパターンを挿入します。
*パラメータ*
- searchTerm `````string`````: 挿入するパターンを見つけるための用語。
<a name="installplugin"></a>
### installPlugin
WP.orgリポジトリからプラグインをインストールします。
*パラメータ*
- slug `````string`````: プラグインのスラッグ。
- searchTerm `````string?`````: プラグインがそのスラッグで見つからない場合は、代替用語を使用して検索します。
<a name="installtheme"></a>
### installTheme
WP.orgリポジトリからテーマをインストールします。
*パラメータ*
- slug `````string`````: テーマのスラッグ。
- settings `````Object?`````: オプションの設定オブジェクト。
- settings.searchTerm `````string?`````: テーマがそのスラッグで見つからない場合に使用する検索用語。
<a name="iscurrenturl"></a>
### isCurrentURL
現在のURLがWordPressパスであるかどうかを確認します。
*パラメータ*
- WPPath `````string`````: パス名としてシリアライズされる文字列。
- query `````?string`````: URLのクエリ部分としてシリアライズされる文字列。
*戻り値*
- `````boolean`````: 現在のURLがWordPressパスであるかどうかを示すブール値。
<a name="isindefaultblock"></a>
### isInDefaultBlock
フォーカスされているブロックがデフォルトブロックであるかどうかを確認します。
*戻り値*
- `````Promise`````: フォーカスされているブロックがデフォルトブロックであるかどうかを示すブール値で解決されるPromise。
<a name="islistviewopen"></a>
### isListViewOpen
未文書の宣言。
<a name="isofflinemode"></a>
### isOfflineMode
未文書の宣言。
<a name="isthemeinstalled"></a>
### isThemeInstalled
テーマがサイトに存在するかどうかを確認します。
*パラメータ*
- slug `````string`````: 確認するテーマのスラッグ。
*戻り値*
- `````boolean`````: テーマが存在するかどうか。
<a name="loginuser"></a>
### loginUser
指定されたユーザー名とパスワードでログインを実行します。
*パラメータ*
- username `````?string`````: ユーザー資格情報として使用される文字列。
- password `````?string`````: ユーザー資格情報として使用される文字列。
<a name="logout"></a>
### logout
ログアウトを実行します。
<a name="mockortransform"></a>
### mockOrTransform
提供されたモックオブジェクトでリクエストをモックするか、リクエストのデシリアライズされたJSONレスポンスに基づいてオプションの変換を実行します。
*パラメータ*
- mockCheck `````Function`````: リクエストをモックする必要がある場合はtrueを返す関数。
- mock `````Object`````: リクエストをモックする必要がある場合にJSONレスポンスでラップするモックオブジェクト。
- responseObjectTransform `````Function|undefined`````: レスポンスが使用される前にレスポンスのオブジェクトを変換するオプションの関数。
*戻り値*
- `````Promise`````: `````mockCheck`````を使用してリクエストをモックする必要があるかどうかを確認し、`````mock`````でモックし、オプションで`````responseObjectTransform`````でレスポンスを変換するPromise。
<a name="opendocumentsettingssidebar"></a>
### openDocumentSettingsSidebar
ヘッダーのボタンをクリックして、閉じている場合にドキュメント設定サイドバーを開きます。
<a name="openglobalblockinserter"></a>
### openGlobalBlockInserter
グローバルインサータを開きます。
<a name="openglobalstylespanel"></a>
### openGlobalStylesPanel
グローバルスタイルパネルを開きます。
*パラメータ*
- panelName `````string`````: 開く予定のパネルの名前。
<a name="openlistview"></a>
### openListView
リストビューを開きます
<a name="openpreviewpage"></a>
### openPreviewPage
編集された投稿のプレビューページを開きます。
*パラメータ*
- editorPage `````Page`````: Puppeteerエディタページ。
*戻り値*
- `````Page`````: プレビューページ。
<a name="openpreviousglobalstylespanel"></a>
### openPreviousGlobalStylesPanel
前のグローバルスタイルパネルを開きます。
<a name="openpublishpanel"></a>
### openPublishPanel
公開パネルを開きます。
<a name="opentypographytoolspanelmenu"></a>
### openTypographyToolsPanelMenu
ブロックサポートを介して提供されるタイポグラフィツールパネルメニューを開きます。
<a name="presskeytimes"></a>
### pressKeyTimes
指定されたキーボードキーを順番に複数回押します。
*パラメータ*
- key `````string`````: 押すキー。
- count `````number`````: 押す回数。
<a name="presskeywithmodifier"></a>
### pressKeyWithModifier
修飾キー(Shift、Control、Meta、Alt)を使用してキーを押します。各修飾キーはプラットフォーム固有の修飾キーに正規化されます。
*パラメータ*
- modifier `````string`````: 修飾キー。
- key `````string`````: 修飾キーを押しながら押すキー。
<a name="publishpost"></a>
### publishPost
投稿を公開し、リクエストが完了すると解決されます(通知が表示されると)。
*戻り値*
- `````Promise`````: 公開が完了したときに解決されるPromise。
<a name="publishpostwithprepublishchecksdisabled"></a>
### publishPostWithPrePublishChecksDisabled
プレパブリッシュチェックなしで投稿を公開し、リクエストが完了すると解決されます(通知が表示されると)。
*戻り値*
- `````Promise`````: 公開が完了したときに解決されるPromise。
<a name="resetpreferences"></a>
### resetPreferences
すべてのユーザーメタ設定をクリアします。
<a name="savedraft"></a>
### saveDraft
投稿をドラフトとして保存し、リクエストが完了すると解決されます(「保存済み」インジケーターが表示されると)。
*戻り値*
- `````Promise`````: ドラフト保存が完了したときに解決されるPromise。
<a name="searchforblock"></a>
### searchForBlock
グローバルインサータを介してブロックを検索します。
*パラメータ*
- searchTerm `````string`````: インサータで検索する用語。
*戻り値*
- `````Promise<ElementHandle|null>`````: 挿入するブロックのハンドル、または何も見つからなかった場合はnull。
<a name="searchforblockdirectoryblock"></a>
### searchForBlockDirectoryBlock
グローバルインサータを介してブロックディレクトリブロックを検索します。
*パラメータ*
- searchTerm `````string`````: インサータで検索する用語。
*戻り値*
- `````Promise<ElementHandle|null>`````: 挿入するブロックディレクトリブロックのハンドル、または何も見つからなかった場合はnull。
<a name="searchforpattern"></a>
### searchForPattern
グローバルインサータを介してパターンを検索します。
*パラメータ*
- searchTerm `````string`````: インサータで検索する用語。
*戻り値*
- `````Promise<ElementHandle|null>`````: 挿入するパターンのハンドル、または何も見つからなかった場合はnull。
<a name="searchforreusableblock"></a>
### searchForReusableBlock
グローバルインサータを介して再利用可能ブロックを検索します。
*パラメータ*
- searchTerm `````string`````: インサータで検索する用語。
*戻り値*
- `````Promise<ElementHandle|null>`````: 挿入する再利用可能ブロックのハンドル、または何も見つからなかった場合はnull。
<a name="selectblockbyclientid"></a>
### selectBlockByClientId
ブロックのclientIdが与えられた場合、エディタでブロックを選択します。
*パラメータ*
- clientId `````string`````: ブロックの識別子。
<a name="setbrowserviewport"></a>
### setBrowserViewport
ブラウザのビューポートを指定されたタイプに設定します。
*パラメータ*
- viewport `````WPViewport`````: 割り当てるビューポート名または寸法オブジェクト。
<a name="setclipboarddata"></a>
### setClipboardData
`````pressKeyWithModifier( 'primary', 'v' )`````で貼り付け可能なクリップボードデータを設定します。
*パラメータ*
- $1 `````Object`````: オプション。
- $1.plainText `````string`````: 設定するプレーンテキスト。
- $1.html `````string`````: 設定するHTML。
<a name="setoption"></a>
### setOption
オプション一般管理ページからサイトオプションを設定します。
*パラメータ*
- setting `````string`````: IDでオプションを取得するために使用されるオプション。
- value `````string`````: オプションに設定する値。
*戻り値*
- `````string`````: オプションの以前の値。
<a name="setpostcontent"></a>
### setPostContent
コードエディタの内容を設定します
*パラメータ*
- content `````string`````: 新しいコードエディタの内容。
*戻り値*
- `````Promise`````: ドキュメント内のすべてのブロックを含む配列で解決されるPromise。
<a name="setupresponsemocking"></a>
### setUpResponseMocking
モックチェックとレスポンスを設定します。 次のプロパティを持つモック設定のリストを受け入れます:
- `````match`````: リクエストをモックする必要があるかどうかを確認する関数。
- `````onRequestMatch`````: リクエストに応答する非同期関数。
*使用法*
``````bash
const MOCK_RESPONSES = [
{
match: isEmbedding( 'https://wordpress.org/gutenberg/handbook/' ),
onRequestMatch: JSONResponse( MOCK_BAD_WORDPRESS_RESPONSE ),
},
{
match: isEmbedding(
'https://wordpress.org/gutenberg/handbook/block-api/attributes/'
),
onRequestMatch: JSONResponse( MOCK_EMBED_WORDPRESS_SUCCESS_RESPONSE ),
},
];
setUpResponseMocking( MOCK_RESPONSES );
`
モック設定のいずれもリクエストに一致しない場合、リクエストは続行されます。
パラメータ
showBlockToolbar
ブロックツールバーは、入力中は常に表示されるわけではありません。この関数を呼び出して表示します。
switchBlockInspectorTab
提供されたラベルのブロックインスペクタタブボタンをクリックし、タブの切り替えを待ちます。
パラメータ
switchEditorModeTo
エディタモードを切り替えます。
パラメータ
switchUserToAdmin
現在のユーザーを管理者ユーザーに切り替えます(テストを実行しているユーザーがすでに管理者ユーザーでない場合)。
switchUserToTest
現在のユーザーをテストを実行する必要があるユーザーに切り替えます(すでにそのユーザーでない場合)。
toggleGlobalBlockInserter
toggleGlobalStyles
グローバルスタイルサイドバーを切り替えます(閉じている場合は開き、開いている場合は閉じます)。
toggleMoreMenu
More Menuを切り替えます。
パラメータ
toggleOfflineMode
togglePreferencesOption
指定されたタブラベルとオプションラベルで設定オプションを切り替えます。
パラメータ
- tabLabel
string
: クリックする設定タブラベル。 - optionLabel
string
: ボタンを検索するためのオプションラベル。 - shouldBeChecked
[boolean]
: trueの場合、オプションをオンにします。 falseの場合、オフにします。 提供されていない場合、オプションは切り替えられます。
transformBlockTo
エディタのブロックタイプを変換します。
パラメータ
trashAllComments
コメントリスト画面に移動し、存在するコメントを一括でゴミ箱に入れます。
戻り値
trashAllPosts
投稿リスト画面に移動し、存在する投稿を一括でゴミ箱に入れます。
パラメータ
- postType
string
: – ゴミ箱に入れる投稿のタイプの文字列スラッグ。 - postStatus
string
: – ゴミ箱に入れる投稿のステータスの文字列。
戻り値
uninstallPlugin
プラグインをアンインストールします。
パラメータ
visitAdminPage
管理ページにアクセスします; ユーザーがログインしていない場合は、最初にログインし、その後管理ページにアクセスします。
パラメータ
visitSiteEditor
サイトエディタのメインページにアクセスします
デフォルトでは、ウェルカムガイドもスキップされます。このオプションは必要に応じて無効にできます。
関連
- disableSiteEditorWelcomeGuide
パラメータ
- query
string
: URLのクエリ部分としてシリアライズされる文字列。 - skipWelcomeGuide
[boolean]
: ナビゲーションの一部としてウェルカムガイドをスキップするかどうか。
waitForWindowDimensions
ページビューポートが必要な寸法になるまで待機する関数です。 setViewportを使用した後、実行が続行される可能性がある問題に対処するために使用されます。 https://github.com/GoogleChrome/puppeteer/issues/1751
パラメータ
wpDataSelect
WordPressデータモジュールをクエリします。
page.evaluate
– 関数内で使用され、非シリアライズ可能な値に遭遇した場合はundefined
を返します。 データモジュールに多くの異なる値を保存しているため、undefined
の結果が得られることがあります。 この関数を使用する前に、クエリしているデータに非シリアライズ可能な値(関数、DOM要素ハンドルなど)が含まれていないことを確認してください。
関連
- https://pptr.dev/#?product=Puppeteer&version=v9.0.0&show=api-pageevaluatepagefunction-args
- https://github.com/WordPress/gutenberg/pull/31199
パラメータ
- store
string
: クエリするストア(例: core/editor、core/blocks…) - selector
string
: 実行するセレクタ(例: getBlocks)。 - parameters
...Object
: セレクタに渡すパラメータ。
戻り値
Contributing to this package
これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。
このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要な貢献者ガイドをお読みください。