Add: note in the save function documentation to discourage side effects #15765
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jorgefilipecosta
added
[Type] Enhancement
jorgefilipecosta
requested review from
ajitbohra,
chrisvanpatten,
gziolo,
mkaz,
notnownikki and
youknowriad
as code owners
|
It seems to be a good clarification to be added. |
aduth
reviewed
May 22, 2019
docs/designers-developers/developers/block-api/block-edit-save.md
Outdated
Show resolved
Hide resolved
| @@ -226,6 +226,13 @@ For most blocks, the return value of `save` should be an [instance of WordPress | |||
|
|
|||
| _Note:_ While it is possible to return a string value from `save`, it _will be escaped_. If the string includes HTML markup, the markup will be shown on the front of the site verbatim, not as the equivalent HTML node content. If you must return raw HTML from `save`, use `wp.element.RawHTML`. As the name implies, this is prone to [cross-site scripting](https://en.wikipedia.org/wiki/Cross-site_scripting) and therefore is discouraged in favor of a WordPress Element hierarchy whenever possible. | |||
|
|
|||
| _Note:_ The save function should be a pure function that depends only on the attributes used to invoke it. | |||
| It can not have any side effect or retrieve information from another source, e.g. it is not possible to use the data module inside it `wp.data.select...`. | |||
There was a problem hiding this comment.
I think the mention of "wp.data.select..." could help clarify what's referred to, but for what it's worth, we should discourage this use of the window global in blocks anywhere, since it cannot account for separate data registries, which will become necessary for e.g. embedded editors (#7119), multiple editors on a page.
docs/designers-developers/developers/block-api/block-edit-save.md
Outdated
Show resolved
Hide resolved
Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>
Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>
jorgefilipecosta
deleted the
add/note-in-the-save-function-to-discourage-side-effects
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I noticed people are not aware side effects cannot be used in the save function, and people use the data module in the save function e.g: to query the post title. This may easily break the blocks.
This PR updates the documentation to make people more aware of this problem.