Make regClientScript and regClientHTMLBlock work in the manager #16700
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.
What does it do?
Adds scripts registered with
regClientScript()
orregClientHTMLBlock()
to the output in the manager.Why is it needed?
There is some inconsistency:
The modX class has the 4 functions
regClientScript()
,regClientHTMLBlock()
,regClientStartupScript()
andregClientStartupHTMLBlock()
.On the frontend (outputting a resource) all 4 functions work.
In the manager, the functions
regClientStartupScript()
andregClientStartupHTMLBlock()
work, but scripts registered withregClientScript()
andregClientHTMLBlock()
are ignored.If there is a reason why these functions shouldn't work in the manager, then at least the MODX documentation (and the source code) should be updated to clearly state that this is the case.
How to test
$modx->regClientScript()
and$modx->regClientHTMLBlock()
on a manager event (like e.g.OnManagerPageBeforeRender
).Related issue(s)/PR(s)
Related discussion in the MODX forum: https://community.modx.com/t/13-years-and-6-months-regclientscript-still-not-working/8282