Magento 2 Add Extension Attributes to Products with Custom PHP

• Why Do You Need to Create and Update the Extension Attributes?

• SEO Tips for Managing Magento Data via Extension Attributes

• 13 Steps to Join Extension Attributes in Magento 2

• Techniques to Improve Product Pages with Extended Commerce PHP Extensions

• 4 Steps to Add Extension Attribute to Entities in Magento 2

• Best Practices for Changing the API Data Interfaces in Your Magento 2 Store

• How to Add Scalar and Non-scalar Magento 2 Extension Attributes?

• What Actions to Take When Developers Cannot Change the API Data?

• 4 Steps to Configure Extension Attributes in Adobe Commerce and Magento Open Source

• EAV and Custom Attribute Data Types

• How to Add Extension Attributes via Plugin for Product Attributes?

• FAQs

• Summary

Why Do You Need to Create and Update the Extension Attributes?

Extension attributes are used to extend interface functionality. It allows you to use more complex data types than custom attributes. Unlike custom attributes, extension attributes do not appear in the Admin panel. They enable developers to overcome the limitations of scalar values. They can extend both EAV and non-EAV entities with complex objects.

For example, you can create an extension attribute that stores:

• Warehouse locations as objects
• Stock levels per location
• Transfer histories
• Supplier relationships

It is not possible with regular custom attributes. This is because it only stores scalar values like "strings" or "integers".

SEO Tips for Managing Magento Data via Extension Attributes

1. Avoid Modifying Core Code

Extension attributes allow custom fields to be added to entities without the codebase. Store owners maintain the integrity of the Magento 2 core code. It ensures compatibility with updates and reduces the risk of conflicts during upgrades.

2. Extend Functionality Without Affecting API

Adding custom data through the API helps developers extend their store functionality. They can add advanced features like:

• Personalized product recommendations
• Custom pricing rules
• Additional product information

The API remains untouched, ensuring smooth integration with third-party systems and CRMs.

3. Use Complex Data Types

Magento 2 extension attributes support complex data types. These data types do not support standard EAV attributes. This complexity can be used to manage detailed information like:

• Product specifications
• Customer preferences
• Custom delivery options

For example, add custom attributes to track customer preferences for product sizes & colors. It improves personalized recommendations and customer satisfaction.

4. Improve Site Speed

Enhance site speed by caching attributes and reducing database requests. Google Page Speed Optimizer Pro, for example, can significantly improve speed. It does not require custom development methods.

5. Enhance User Experience

Extension attributes allow store owners to add advanced features, improving user experience. For example, you can add:

• Hreflang tags for multi-language support
• Rich snippets for better search result display
• Product SEO templates for easy optimization

These enhancements boost SEO visibility & click-through rates.

6. Improve your Control over SEO

Magento 2 SEO extension suites like SEO Suite Ultimate provide tools to optimize:

• Meta tags
• Canonical tags
• Sitemaps
• Redirects

These optimization tools help store owners ensure SEO effectiveness and control.

7. Increase Visibility

Store admins can adjust their product pages to meet specific SEO needs. For instance, you can add custom attributes for product reviews/special pricing offers. It allows you to make your products more visible in SERPs (Search Engine Results Pages).

8. Ensure Data Integrity and Safety

Extension attributes ensure that custom data is integrated safely into Magento's ecosystem. It reduces the risk of duplicate content or data conflicts during updates. It also assures you that your custom data is secure and won't impact the core system's stability.

13 Steps to Join Extension Attributes in Magento 2

1. Define the extension attribute.
2. Create an XML file in your module's etc/extension_attributes.xml directory.
3. Specify the entity to be extended (e.g., product, order) and set up the attribute structure.
4. In app/code/Vendor/ExtentionAttribute/etc, create the db_schema.xml.
5. Define the structure of the custom table that will store your additional data.
6. Create a webapi.xml file in app/code/Vendor/ExtentionAttribute/etc.
7. Define API endpoints for interacting with the newly added attributes
8. Define dependency injection by creating di.xml in app/code/Vendor/ExtentionAttribute/etc.
9. Use this to map the interface with the corresponding model.
10. Define the OrderManagementInterface.php in app/code/Vendor/ExtentionAttribute/Api.
11. Specify the contract for fetching order details.
12. Create OrderManagement.php in app/code/Vendor/ExtentionAttribute/Model to implement the interface.

Note: It will handle the logic of fetching the list of orders along with the extension attributes.

13. After joining the tables, load the extension attribute data as needed.

Techniques to Improve Product Pages with Extended Commerce PHP Extensions

Improvement	Description
Custom Data Fields	Developers can add custom fields to product pages without modifying the core code. For example, the enhanced implementation of extension attributes can add customer preferences. For example, sizes and colors can be used to track customer data.
Enhanced SEO Features	Magento SEO extensions can optimize product pages for better search engine rankings. For example, SEO Suite Ultimate can add hreflang tags for multi-language support. It also provides rich snippets for better search result display & product SEO templates.
Advanced Filtering and Sorting	Developers can enable advanced filtering and sorting options on product pages. For example, layered navigation can be optimized for SEO, improving the user experience.
Personalized Product Recommendations	Commerce PHP extensions can facilitate customized product recommendations based on customer data. For example, with extension attributes, you can track customer preferences & provide personalized suggestions.
Improved API Functionality	PHP extensions can extend API interfaces to retrieve and update extra custom data. The API, for example, allows you to add custom pricing or tier pricing information. It enhances integration with third-party systems.
Complex Data Types	Complex data types for product information allow for richer data structures. For example, you can add delivery time & date preferences for personalized delivery options.
User Experience Enhancements	One Step Checkout Magento/Checkout Custom Field offers a smoother checkout process. For example, the Magento SEO extension can add smart breadcrumbs. It allows visitors and search engines to navigate through the store.
Data Integrity and Performance	Safe customizations ensure data integrity that doesn't affect the core system. For example, Use Magento's caching mechanisms to reduce database requests & improve site speed.
Cross-selling and Upselling	Some extensions can encourage customers to buy more. Examples include Frequently Bought Together or Customers Also Bought/Also Viewed. For example, you can add cross-selling and upselling options to product pages.
Dynamic Content	Magento 2 B2B extensions can add dynamic content to product pages for B2B customers. Examples include custom pricing or minimum order amounts. For example, present child product information in a grid table for configurable products.

4 Steps to Add Extension Attribute to Entities in Magento 2

1. Create the file app/code/Vendor/Extension/etc/extension_attributes.xml.
2. Specify the "Path\To\Interface".
3. Create the file app/code/Vendor/Extension/etc/extension_attributes.xml.
4. Mention the "Magento\Quote\Api\Data\AddressInterface".

Best Practices for Changing the API Data Interfaces in Your Magento 2 Store

Best Practice	Description
Performance Considerations	- Use Magento's caching mechanisms (dev/caching/cache_user_defined_attributes) to reduce database requests. - Minimize complex queries using extension attributes to join external attributes to collections. - Ensure API responses are optimized for quick rendering.
Data Integrity and Maintenance	- Use built-in Magento 2 validation mechanisms to ensure data consistency. - Keep track of custom attributes and extension attributes for maintenance purposes. - Use extension attributes to avoid modifying core schemas, ensuring easy updates.
Consider Data Types	- Use extension attributes for rich data structures like customer preferences/product specifications. - Standard EAV attributes can be used for simpler data like boolean, int, float, or string.
Understand API Interactions	- Use tools like Swagger to generate detailed API documentation automatically. - Implement secure authentication methods like OAuth for third-party integrations. - Utilize Magento's versioning system to ensure backward compatibility during changes. - Understand how Magento processes data in API responses. - Ensure all required data is returned.

How to Add Scalar and Non-scalar Magento 2 Extension Attributes?

1. Create app/code/Vendor/DemoModule/etc/extension_attributes.xml.
2. Specify the scalar attributes.

Note: These attributes can only contain scalar values such as "boolean", "int", "float", or "string".

3. Create a custom interface for the non-scalar attributes.

Note: These attributes use objects to represent more complex data types.

4. Set or get these attribute values.
5. Create an instance of the Magento/Checkout/Api/Data/ShippingInformationInterface.php interface.

What Actions to Take When Developers Cannot Change the API Data?

What to Do	Solution
Use Extension Attributes	- Add custom fields to entities without modifying the core code. - Ensure that the API remains untouched, maintaining data integrity & compatibility with updates.
Leverage API Interfaces	- Allow developers to work with store data without affecting the core system. - Use API to retrieve and update custom data. - Ensure smooth integration with third-party systems without changing the core code.
Create Custom Modules	- Create a custom module that integrates with the Magento order management system. - Ensure that new functionalities are added without modifying the core system.
Implement Custom Authentication	- Customize API authentication methods like OAuth for third-party integrations. - Ensure secure access to the API without changing core code, preserving its integrity.
Optimize API Requests	- Improve API efficiency by reducing database requests and leveraging caching mechanisms. - Ensure that the API remains fast and efficient without altering the data structures.
Use Complex Data Types	- Manage detailed information without altering the existing API data interfaces. - Allow for richer data structures like product specifications or customer preferences.
Create Custom Endpoints	- Develop custom API endpoints to meet specific needs. - Facilitate third-party app integration without modifying the core API. - Custom endpoints provide tailored solutions for specific business requirements.
Document API Changes	- Ensure smooth development and integration processes with API documentation. - Understand how to work with custom attributes without modifying the existing API.
Maintain Data Integrity	- Ensure data integrity by allowing safe customizations that don't affect the system. - Prevent data conflicts during updates and maintain the stability of the store.

4 Steps to Configure Extension Attributes in Adobe Commerce and Magento Open Source

1. Retrieve a product or a list of products using Magento's Product Repository.

Note: You can make an API request to the appropriate service. It will return the product objects with your code structure.

2. Extend the attributes of the retrieved product entity.
3. Create an after plugin on the Product Repository.

Note: It intercepts calls to Product Repository methods, like get, getList, or save. Then, it appends or modifies the extension attributes.

4. Configure the extension attributes in an XML file located in your module’s /etc folder.

EAV and Custom Attribute Data Types

Use Case	Description
Magento 2 Add Custom Attributes	Developers or merchants can add custom attributes to entities, like products/customers/orders. It allows them to extend the functionality of Adobe Commerce or Magento Open Source. It also provides more detailed information/additional functionality without modifying the core system.
Magento 2 Extension Attributes	Developers can add extension attributes to entities like products, customers, or orders. Extension attributes can include more complex data types than custom attributes. They are not visible by default in the Admin panel and are used for third-party integrations.
Magento 2 Add Extension Attribute to Product	Developers can add extension attributes to products. It allows them to extend the product API with complex data structures. Thus, they can enhance the product data without altering the core database schema.
Magento 2 Extension Attributes for Complex Data Types	Extension attributes can be used to add complex data types to entities. They enable the enrichment of basic product attributes with detailed or structured information. Examples include gift_message or stock_item.
Magento 2 Add Extension Attribute to Entity	Developers can add extension attributes to any entity, not just products. They can extend functionality, manage more complex data structures, and improve data integrity.
Magento 2 Extension Attributes for Backend Customization	Developers can add extension attributes for backend-only data, like customer preferences. It doesn't impact the frontend user experience/require modifications to the database schema.
Magento 2 Extension Attributes for Performance Optimization	Caching extension attributes can improve performance by reducing database requests. Thus, it can optimize the retrieval of product information.
Magento 2 Add Extension Attribute for API Data Interfaces	Extension attributes can be used to extend API data interfaces. It enhances the API responses with additional data fields.
Magento 2 Add Extension Attribute for Authenticated Access	Developers can restrict access to specific extension attributes based on user permissions. Ensure that sensitive data like inventory details is only available to authorized users.
Magento 2 Add Extension Attribute for Search Operations	Extension attributes can be configured to join external attributes to collections. It enables filtering and searching capabilities for extended data.

How to Add Extension Attributes via Plugin for Product Attributes?

1. Get the entity’s extension attributes.

Note: It ensures that if any attributes are already set, they are not overwritten.

2. Add your custom extension attribute to the entity.
3. Set the extension attributes back to the entity with your modifications.

Note:

• The same approach applies to other methods, such as afterGetList and afterSave. These methods handle product entities in bulk or effectively save changes.
• If a product entity doesn’t have an implementation to fetch the extension attributes, it will return null. Each time you fetch extension attributes, check if they are null. Also, initialize them if necessary.
• To prevent code duplication, create an afterGetExtensionAttributes plugin. It initializes extension attributes if they do not exist.

FAQs

1. What are extension attributes, and are they new in Adobe Commerce?

Extension attributes are new features in Adobe Commerce. They work differently from regular attributes, offering more flexibility than custom attributes. They support complex data structures and let you add extra data fields. They also allow you to extend product functionality without core changes.

2. What param is needed to make an API request?

Your API request needs specific parameters for success. It includes the product ID in your request. Add authentication tokens for API access. Remember to specify the attribute name you want to modify. You can also define the data type for your extension attribute.

3. Which attributes include complex data structures?

Extension attributes support arrays and nested objects and handle multiple data types together. They also work with custom classes and interfaces. Thus, they allow relationship-based data storage that effectively processes composite data.

4. What is the correct syntax for magento\catalog\api\data\productextensioninterface implementation?

Start with the use statement declaration and then import productinterface and productextensionfactory. Next, create your class implementation. Define your interface methods clearly and set up proper return types.

5. How do I define the name of the attribute correctly?

Choose a unique name for your attribute and follow Magento naming conventions strictly. Use underscores for multi-word attributes and keep the name descriptive but concise. Make sure to match the name with the purpose of your extension.

6. What public function types are required?

To implement the extension attribute interface properly, you need getter and setter functions. Create data processing functions as required. Add validation functions and include error handling functions where appropriate.

Summary

The 'Magento 2 add extension attribute to product' plugin uses XML files to add additional attribute names. It allows you to:

• Add complex data types that go beyond the standard capabilities.
• Configure the namespace that processes the extension attributes via products.
• Add plugin functionality to modify the extension attributes.
• Enable more sophisticated customization while avoiding direct modifications to Magento core code.
• Maintain upgrade compatibility to extend Magento's product entity beyond its default capabilities.
• Improve extensibility and maintain consistency in your Magento projects.

Consider managed Magento hosting to add extension attributes to the products in your store.