Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Include information about multiple scripts support added in WP 6.1 #44155

Merged
merged 1 commit into from
Sep 15, 2022
Merged

Docs: Include information about multiple scripts support added in WP 6.1 #44155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions docs/reference-guides/block-api/block-metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ Starting in WordPress 5.8 release, we encourage using the `block.json` metadata
],
"editorScript": "file:./index.js",
"script": "file:./script.js",
"viewScript": "file:./view.js",
"viewScript": [ "file:./view.js", "example-shared-view-script" ],
gziolo marked this conversation as resolved.
Show resolved Hide resolved
"editorStyle": "file:./index.css",
"style": "file:./style.css",
"style": [ "file:./style.css", "example-shared-style" ],
"render": "file:./render.php"
}
```
Expand Down Expand Up @@ -464,7 +464,7 @@ See the [the variations documentation](/docs/reference-guides/block-api/block-va

### Editor Script

- Type: `WPDefinedAsset` ([learn more](#wpdefinedasset))
- Type: `WPDefinedAsset`|`WPDefinedAsset[]` ([learn more](#wpdefinedasset))
- Optional
- Localized: No
- Property: `editorScript`
Expand All @@ -475,9 +475,11 @@ See the [the variations documentation](/docs/reference-guides/block-api/block-va

Block type editor script definition. It will only be enqueued in the context of the editor.

_Note: An option to pass also an array of editor scripts exists since WordPress `6.1.0`._

### Script

- Type: `WPDefinedAsset` ([learn more](#wpdefinedasset))
- Type: `WPDefinedAsset`|`WPDefinedAsset[]` ([learn more](#wpdefinedasset))
- Optional
- Localized: No
- Property: `script`
Expand All @@ -488,6 +490,8 @@ Block type editor script definition. It will only be enqueued in the context of

Block type frontend and editor script definition. It will be enqueued both in the editor and when viewing the content on the front of the site.

_Note: An option to pass also an array of scripts exists since WordPress `6.1.0`._

### View Script

- Type: `WPDefinedAsset`|`WPDefinedAsset[]` ([learn more](#wpdefinedasset))
Expand All @@ -497,7 +501,7 @@ Block type frontend and editor script definition. It will be enqueued both in th
- Since: `WordPress 5.9.0`

```json
{ "viewScript": "file:./view.js" }
{ "viewScript": [ "file:./view.js", "example-shared-view-script" ] }
```

Block type frontend script definition. It will be enqueued only when viewing the content on the front of the site.
Expand Down Expand Up @@ -527,7 +531,7 @@ _Note: An option to pass also an array of editor styles exists since WordPress `
- Property: `style`

```json
{ "style": "file:./style.css" }
{ "style": [ "file:./style.css", "example-shared-style" ] }
```

Block type frontend and editor style definition. It will be enqueued both in the editor and when viewing the content on the front of the site.
Expand Down Expand Up @@ -579,10 +583,10 @@ In `block.json`:
```json
{
"editorScript": "file:./index.js",
"script": "my-script-handle",
"viewScript": "file:./view.js",
"editorStyle": "my-editor-style-handle",
"style": [ "file:./style.css", "my-style-handle" ]
"script": "file:./script.js",
"viewScript": [ "file:./view.js", "example-shared-view-script" ],
"editorStyle": "file:./index.css",
"style": [ "file:./style.css", "example-shared-style" ]
}
```

Expand Down
28 changes: 24 additions & 4 deletions schemas/json/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,12 +439,32 @@
}
},
"editorScript": {
"type": "string",
"description": "Block type editor script definition. It will only be enqueued in the context of the editor."
"description": "Block type editor script definition. It will only be enqueued in the context of the editor.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"script": {
"type": "string",
"description": "Block type frontend and editor script definition. It will be enqueued both in the editor and when viewing the content on the front of the site."
"description": "Block type frontend and editor script definition. It will be enqueued both in the editor and when viewing the content on the front of the site.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"viewScript": {
"description": "Block type frontend script definition. It will be enqueued only when viewing the content on the front of the site.",
Expand Down