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.
fixes #3768
The
ConfigFormEventsHook
allows developers to hook into the handling of configuration forms. It provides three methods:appliesTo()
isValid()
onSuccess()
appliesTo()
determines whether the hook should run for a given configuration form.Developers should use
instanceof
checks in order to decide whether the hook should run or not.If
appliesTo()
returnsfalse
,isValid()
andonSuccess()
won't get called for this hook.isValid()
is called after the configuration form has been validated successfully.An exception thrown here indicates form errors and prevents the config from being stored.
The exception's error message is shown in the frontend automatically.
If there are multiple hooks indicating errors, every error will be displayed.
onSuccess()
is called after the configuration has been stored successfully.Form handling can't be interrupted here. Any exception will be caught, logged and notified.
Hook example: