Magento 2 After Plugin: Benefits And Types of Plugin

• Benefits of Magento 2 Plugin

• What are the Magento 2 Plugins Restrictions

• Types of Plugins In Magento 2

• How To Define a Plugin in Magento 2

• What Is The Plugin Execution Order

• What Are Sort Orders and Dependencies?

• FAQs

• Summary

Benefits of Magento 2 Plugin

1. Extensibility

Plugins allow developers to modify core functionality without altering source code. It is achieved through the use of 'before', 'after', and 'around' methods. For example, a plugin can add additional validation to a product before it's added to the cart. It can be done without modifying the core addProduct method.

2. Flexibility

Plugins enable customization of public methods in Magento classes. Developers can intercept method calls, modify input parameters, or alter return values. For instance, a plugin could modify the getPrice method. This modification could apply dynamic discounts based on customer segments.

3. Modularity

Plugins can be easily added or removed, enhancing system modularity. Each plugin is defined in a separate class. It allows for independent development and maintenance. The modular approach simplifies the process of activating or deactivating specific functionality.

4. Performance

Magento 2 plugins use efficient interceptor patterns for improved performance. The system generates optimized interceptor classes at runtime. It reduces overhead compared to traditional event observers.

5. Code organization

Plugins promote cleaner, more maintainable code structures. By separating customizations from core code, developers can organize modifications logically. This separation of concerns improves code readability. It also reduces the risk of conflicts.

6. Compatibility

Plugins reduce conflicts between extensions and core updates. Plugins don't directly modify core files. It makes them less likely to break when Magento releases updates. As a result, overall system stability improves, and maintenance efforts are reduced.

7. Debugging

The plugin system facilitates easier debugging and troubleshooting. Developers can use the 'around' method to wrap original method calls. It allows for detailed logging or performance monitoring. These tasks can be done without altering the core logic.

8. Interoperability

Plugins allow multiple modules to modify the same method harmoniously. Magento manages the execution order of plugins. It ensures that multiple customizations can coexist without conflicts. This feature is particularly valuable in complex e-commerce setups with multiple extensions.

9. Upgrade safety

Using plugins minimizes the risk of breaking changes during Magento upgrades. Customizations are isolated from core code. It makes upgrades less likely to impact custom functionality. As a result, the time and effort required for testing and compatibility checks after each upgrade is reduced.

What are the Magento 2 Plugins Restrictions

Restriction	Description	Impact
Scope	Only public methods	Preserves encapsulation
Constructors	Cannot modify	Maintains object initialization integrity
Final methods	Cannot intercept	Respect the PHP finality concept
Private methods	Not modifiable	Upholds information hiding principle
Static methods	Cannot intercept	Preserves static method nature
Non-public properties	No access	Enforces proper encapsulation
Virtual types	Do not work	Respects the compile-time nature of virtual types
Abstract classes	Cannot use	Prevents conflicts with implementations
Interfaces	Cannot apply directly	Ensures plugins work with concrete classes
Return types	Must maintain consistency	Ensures type safety
Parameters	Must match original	Maintains method signature consistency
Naming	Must follow conventions	Aids in plugin discovery and loading
Sort Order	Requires management	Prevents conflicts between multiple plugins
Performance	Overuse may impact	It can lead to system slowdowns
Visibility	Cannot change	Maintains intended method accessibility

Types of Plugins In Magento 2

1. Before Methods

Before plugins are used, when you need to add some behavior or modify arguments before the original method is executed, the signature must match the observed process. You should use the prefix "before" in the plugin's method name. One key feature of before plugins is that they cannot alter the return value. It is because they do not return anything. They are typically used to intercept a function call and run a code before it proceeds.

For example, change the arguments when adding a product to the cart. In this case, a before plugin could intercept and alter those parameters. It would happen before proceeding with the original function. It helps adjust inputs while keeping the execution flow intact.

2. After Methods

After plugins allow you to make modifications after the original method has been executed. This type of plugin is helpful in changing the returned values of the original process. It can also add additional behavior after the function has completed its operations. Similar to before plugins, they use the prefix "after.". They must have the same method name as the observed method.

For example, an after plugin can be used to add logging functionality to a public function. After the function completes, the after plugin can log the results. It provides access to the results of the observed method without altering its logic.

3. Around Methods

Around plugins are the most versatile type. They can completely override a method's behavior. They run both before and after the original method. It allows you to modify both the arguments and returned values. Around plugins wrap around the original method. It means they provide complete control over whether and how the original method is called. They use the "around" prefix. They must return the result of the original method, typically by using the callable $proceed().

One key aspect of plugins is their ability to control execution. They can decide if and when to call the original method or other plugins in the execution stack. If the around plugin does not call $proceed(), further execution will be prevented. It includes any other plugins in the stack and the original method. This capability is powerful but should be used cautiously. Improper implementation can lead to unexpected behaviors.

How To Define a Plugin in Magento 2

1. Create a plugin class

• Choose a namespace for your plugin.

• Define a class that will contain the plugin methods.

• The class name should follow Magento naming conventions.

2. Implement plugin methods

• Use 'before,' 'after,' or 'around' prefixes for method names.

• Method names must match the observed method's name.

• Accept appropriate arguments based on the plugin type.

3. Configure the plugin

• Create a di.xml file in your module's etc directory.

• Specify the class to be plugged, the plugin class, and the plugin name.

• Define the sort order if multiple plugins exist for the same method.

What Is The Plugin Execution Order

The order in which plugins execute depends on their types: Before, After, and Around.

1. Before Plugins

These plugins are executed before the observed method. The purpose is to modify input parameters or add behavior before executing the original process. They run in the sequence determined by the sortOrder attribute, which is an integer used to define priority.

2. After Plugins

These plugins run after the original method has been executed. They can modify the return values of the original method or add additional behavior afterward. Like before plugins, the execution is controlled using the sortOrder attribute.

3. Around Plugins

These plugins wrap the original method, executing code both before and after it. The execution order of around plugins is important because it affects both the input arguments and return values. Around plugins, you need to call $proceed() to execute the following plugin or the original method.

If $proceed() is not called, it can prevent the execution of the original method and all other plugins in the execution stack. This capability gives around plugins significant power to alter method behavior completely.

What Are Sort Orders and Dependencies?

• The execution order of plugins is influenced by the sortOrder attribute. A plugin with a lower value in sortOrder will execute before those with higher values. However, if two plugins have the same sort order, their relative execution order is not defined. It may lead to unpredictable behavior. To maintain stability, Magento recommends assigning unique sortOrder values. It is essential when working with third-party modules that may interact with each other.

• Magento allows developers to define plugin execution order. It can be done using attributes. These attributes include "before" or "after". They specify whether a plugin should run before or after a specific plugin. These attributes can help manage complex dependencies. They ensure that plugins execute in a predictable sequence even when multiple modules are in use.

• Magento recommends avoiding the use of around plugins unless necessary. They increase stack traces and can negatively impact performance. If a method override is needed, the around plugin should be considered only in specific cases. These cases are when you need to modify both arguments and return values. Additionally, the before or after plugins cannot accomplish the required changes.

FAQs

1. What is a Magento 2 After Plugin?

A Magento 2 After Plugin is a type of interceptor used in Magento 2 development. It allows you to execute your custom code after the execution of an original method. This type of plugin is beneficial for modifying the output values of an original method. It achieves this without altering the method's core functionality.

2. How do you write and use a Magento 2 After Plugin?

To write and use a Magento 2 After Plugin, you first need to create a new plugin class in your module. The plugin must have the same name as the method you want to intercept, followed by 'Afte.'. You then configure the plugin in the module's di.xml file to associate it with the target class and method. Refer to the Magento documentation for detailed steps.

3. Can you provide an example of a plugin in Magento 2?

A plugin example in Magento 2 could involve adding a new plugin to modify the behavior of adding a product to a cart. You could use an After Plugin for this purpose. It would automatically log a message upon each successful addition of a product to the cart. It can be done using the psr\log\loggerinterface class.

4. Are there any restrictions when using plugins in Magento 2?

Yes, certain restrictions apply when using plugins in Magento 2. Plugins cannot be applied to final, static, or private methods. Furthermore, methods must maintain the original signature. It includes any changes to the arguments of an original method.

5. What does 'plugin must have the same name' refer to?

'Plugin must have the same name' refers to the naming convention used when creating a plugin method. The method in the plugin class must have the same name as the target method you are modifying. This name should be prefixed by 'before,' 'after,' or 'around.' The prefix depends on the type of plugin you are implementing.

Summary

Magento 2 plugins, their types, benefits, and restrictions. Magento 2 plugins are designed to modify core functionality without altering the source code. Let's summarize the key points covered in this article:

• Magento 2 plugins enable customization of core functionality without altering the source code.

• Three types of plugins exist: "before," "after," and "around," each offering specific control over method execution.

• Plugins offer benefits like extensibility, modularity, and improved compatibility during Magento upgrades.

Explore managed Magento hosting services to enhance performance with plugins.