Skip to content

[5.4] Plugin and events: extend deprecation to 7 #45818

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

Merged
muhme merged 8 commits into from
Aug 9, 2025
Merged

[5.4] Plugin and events: extend deprecation to 7 #45818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6fbe208
Extend deprecation for events to 7
Fedik Aug 2, 2025
3c3a0dc
Extend deprecation for events to 7
Fedik Aug 2, 2025
f7cbf3c
phpstan
Fedik Aug 3, 2025
64b9d79
Merge branch '5.4-dev' into plugin-events-extend-deprecation7
Fedik Aug 3, 2025
e4856be
phpstan
Fedik Aug 3, 2025
69df7c1
phpstan
Fedik Aug 3, 2025
242cf46
phpstan
richard67 Aug 3, 2025
cb0a856
Merge branch '5.4-dev' into plugin-events-extend-deprecation7
muhme Aug 9, 2025
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
2 changes: 1 addition & 1 deletion libraries/src/Application/EventAware.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public function registerEvent($event, callable $handler)
* @since 4.0.0
* @throws \InvalidArgumentException
*
* @deprecated 4.0 will be removed in 6.0
* @deprecated 4.0 will be removed in 7.0
* Use the Dispatcher method instead
* Example: Factory::getApplication()->getDispatcher()->dispatch($eventName, $event);
*
Expand Down
4 changes: 2 additions & 2 deletions libraries/src/Application/EventAwareInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
* Interface defining application that can trigger Joomla 3.x style events
*
* @since 4.0.0
* @deprecated 4.3 will be removed in 6.0
* @deprecated 4.3 will be removed in 7.0
* This interface will be removed without replacement as the Joomla 3.x compatibility layer will be removed
* @todo Move to compat plugin
*/
Expand Down Expand Up @@ -54,7 +54,7 @@ public function getDispatcher();
* @since 4.0.0
* @throws \InvalidArgumentException
*
* @deprecated 4.0 will be removed in 6.0
* @deprecated 4.0 will be removed in 7.0
* Use the Dispatcher method instead
* Example: Factory::getApplication()->getDispatcher()->dispatch($eventName, $event);
*/
Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Document/Renderer/Html/ModulesRenderer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public function render($position, $params = [], $content = null)

// Dispatch onAfterRenderModules event
$event = new Module\AfterRenderModulesEvent('onAfterRenderModules', [
'content' => &$buffer, // @todo: Remove reference in Joomla 6, see AfterRenderModulesEvent::__constructor()
'content' => &$buffer, // @todo: Remove reference in Joomla 7, see AfterRenderModulesEvent::__constructor()
'attributes' => $params,
]);
$app->getDispatcher()->dispatch('onAfterRenderModules', $event);
Expand Down
8 changes: 4 additions & 4 deletions libraries/src/Event/AbstractEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ public function getArgument($name, $default = null)

@trigger_error(
\sprintf(
'Numeric access to named event arguments is deprecated, and will not work in Joomla 6. Event %s argument %s',
'Numeric access to named event arguments is deprecated, and will not work in Joomla 7. Event %s argument %s',
\get_class($this),
$name
),
Expand All @@ -167,7 +167,7 @@ public function getArgument($name, $default = null)
if (method_exists($this, $methodName2)) {
@trigger_error(
\sprintf(
'Use method "%s" for value pre-processing is deprecated, and will not work in Joomla 6. Use "%s" instead. Event %s',
'Use method "%s" for value pre-processing is deprecated, and will not work in Joomla 7. Use "%s" instead. Event %s',
$methodName2,
$methodName1,
\get_class($this)
Expand Down Expand Up @@ -210,7 +210,7 @@ public function setArgument($name, $value)

@trigger_error(
\sprintf(
'Numeric access to named event arguments is deprecated, and will not work in Joomla 6. Event %s argument %s',
'Numeric access to named event arguments is deprecated, and will not work in Joomla 7. Event %s argument %s',
\get_class($this),
$name
),
Expand All @@ -228,7 +228,7 @@ public function setArgument($name, $value)
} elseif (method_exists($this, $methodName2)) {
@trigger_error(
\sprintf(
'Use method "%s" for value pre-processing is deprecated, and will not work in Joomla 6. Use "%s" instead. Event %s',
'Use method "%s" for value pre-processing is deprecated, and will not work in Joomla 7. Use "%s" instead. Event %s',
$methodName2,
$methodName1,
\get_class($this)
Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/AbstractImmutableEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public function offsetSet($name, $value)
parent::offsetSet($name, $value);

@trigger_error(
'Setting a result in an immutable event is deprecated, and will not work in Joomla 6. Event ' . $this->getName(),
'Setting a result in an immutable event is deprecated, and will not work in Joomla 7. Event ' . $this->getName(),
E_USER_DEPRECATED
);

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Cache/AfterPurgeEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class AfterPurgeEvent extends AbstractImmutableEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['subject'];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Checkin/AfterCheckinEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class AfterCheckinEvent extends AbstractImmutableEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['subject'];

Expand Down
6 changes: 3 additions & 3 deletions libraries/src/Event/Contact/SubmitContactEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class SubmitContactEvent extends AbstractImmutableEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['subject', 'data'];

Expand Down Expand Up @@ -63,8 +63,8 @@ public function __construct($name, array $arguments = [])
}

// For backward compatibility make sure the content is referenced
// @todo: Remove in Joomla 6
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 6
// @todo: Remove in Joomla 7
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 7
if (key($arguments) === 0) {
$this->arguments['data'] = &$arguments[1];
} elseif (\array_key_exists('data', $arguments)) {
Expand Down
6 changes: 3 additions & 3 deletions libraries/src/Event/Contact/ValidateContactEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class ValidateContactEvent extends AbstractImmutableEvent implements ResultAware
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['subject', 'data'];

Expand Down Expand Up @@ -68,8 +68,8 @@ public function __construct($name, array $arguments = [])
}

// For backward compatibility make sure the content is referenced
// @todo: Remove in Joomla 6
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 6
// @todo: Remove in Joomla 7
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 7
if (key($arguments) === 0) {
$this->arguments['data'] = &$arguments[1];
} elseif (\array_key_exists('data', $arguments)) {
Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Content/ContentEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ abstract class ContentEvent extends AbstractImmutableEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = [];

Expand Down
6 changes: 3 additions & 3 deletions libraries/src/Event/Content/ContentPrepareEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class ContentPrepareEvent extends ContentEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['context', 'subject', 'params', 'page'];

Expand Down Expand Up @@ -63,9 +63,9 @@ protected function onSetParams($value): Registry
if (!$value instanceof Registry) {
$value = new Registry($value);

// @TODO: In 6.0 throw an exception
// @TODO: In 7.0 throw an exception
@trigger_error(
\sprintf('The "params" attribute for the event "%s" must be type of Registry. In 6.0 it will throw an exception', $this->getName()),
\sprintf('The "params" attribute for the event "%s" must be type of Registry. In 7.0 it will throw an exception', $this->getName()),
E_USER_DEPRECATED
);
}
Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/CustomFields/AbstractPrepareFieldEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ abstract class AbstractPrepareFieldEvent extends CustomFieldsEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['context', 'item', 'subject'];

Expand Down
6 changes: 3 additions & 3 deletions libraries/src/Event/CustomFields/AfterPrepareFieldEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class AfterPrepareFieldEvent extends AbstractPrepareFieldEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['context', 'item', 'subject', 'value'];

Expand All @@ -49,8 +49,8 @@ public function __construct($name, array $arguments = [])
}

// For backward compatibility make sure the value is referenced
// @todo: Remove in Joomla 6
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 6
// @todo: Remove in Joomla 7
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 7
if (key($arguments) === 0 && \count($arguments) >= 4) {
$this->arguments['value'] = &$arguments[3];
} elseif (\array_key_exists('value', $arguments)) {
Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/CustomFields/CustomFieldsEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ abstract class CustomFieldsEvent extends AbstractImmutableEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = [];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/CustomFields/PrepareDomEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class PrepareDomEvent extends CustomFieldsEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['subject', 'fieldset', 'form'];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Extension/AbstractExtensionEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ abstract class AbstractExtensionEvent extends AbstractImmutableEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = [];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Extension/AbstractJoomlaUpdateEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ abstract class AbstractJoomlaUpdateEvent extends AbstractImmutableEvent
* @var array
*
* @since 5.2.0
* @deprecated 5.2.0 will be removed in 6.0
* @deprecated 5.2.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = [];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Extension/AfterInstallEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class AfterInstallEvent extends AbstractExtensionEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['installer', 'eid'];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Extension/AfterJoomlaUpdateEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class AfterJoomlaUpdateEvent extends AbstractJoomlaUpdateEvent
* @var array
*
* @since 5.2.0
* @deprecated 5.2.0 will be removed in 6.0
* @deprecated 5.2.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['oldVersion'];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Extension/AfterUninstallEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class AfterUninstallEvent extends AbstractExtensionEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['installer', 'eid', 'removed'];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Extension/AfterUpdateEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class AfterUpdateEvent extends AbstractExtensionEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['installer', 'eid'];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Extension/BeforeInstallEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class BeforeInstallEvent extends AbstractExtensionEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['method', 'type', 'manifest', 'extension'];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Extension/BeforeUninstallEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class BeforeUninstallEvent extends AbstractExtensionEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['eid'];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Extension/BeforeUpdateEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class BeforeUpdateEvent extends AbstractExtensionEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['type', 'manifest'];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Finder/AbstractFinderEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ abstract class AbstractFinderEvent extends AbstractImmutableEvent implements Fin
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = [];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Finder/AfterSaveEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class AfterSaveEvent extends SaveEvent implements FinderEventInterface
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['context', 'subject', 'isNew'];
}
2 changes: 1 addition & 1 deletion libraries/src/Event/Finder/BeforeSaveEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class BeforeSaveEvent extends SaveEvent implements FinderEventInterface
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['context', 'subject', 'isNew'];
}
2 changes: 1 addition & 1 deletion libraries/src/Event/Finder/PrepareContentEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class PrepareContentEvent extends AbstractFinderEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['subject'];

Expand Down
2 changes: 1 addition & 1 deletion libraries/src/Event/Finder/ResultEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class ResultEvent extends AbstractFinderEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['subject', 'query'];

Expand Down
6 changes: 3 additions & 3 deletions libraries/src/Event/Installer/AfterInstallerEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class AfterInstallerEvent extends InstallerEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['subject', 'package', 'installer', 'installerResult', 'message'];

Expand Down Expand Up @@ -59,8 +59,8 @@ public function __construct($name, array $arguments = [])
}

// For backward compatibility make sure the values is referenced
// @todo: Remove in Joomla 6
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 6
// @todo: Remove in Joomla 7
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 7
if (key($arguments) === 0) {
$this->arguments['installerResult'] = &$arguments[3];
$this->arguments['message'] = &$arguments[4];
Expand Down
6 changes: 3 additions & 3 deletions libraries/src/Event/Installer/BeforePackageDownloadEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class BeforePackageDownloadEvent extends AbstractImmutableEvent
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['url', 'headers'];

Expand Down Expand Up @@ -64,8 +64,8 @@ public function __construct($name, array $arguments = [])
}

// For backward compatibility make sure the value is referenced
// @todo: Remove in Joomla 6
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 6
// @todo: Remove in Joomla 7
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 7
if (key($arguments) === 0) {
$this->arguments['url'] = &$arguments[0];
$this->arguments['headers'] = &$arguments[1];
Expand Down
Loading
Loading