Custom Attribute Name Prefix

3min
As Magento has separate attributes for products and categories and these attributes can have the same name. Klevu does not differentiate attributes between entity types and therefore a name clash could occur with category and product attributes overwriting each other. To mitigate this we have added a prefix to any custom category attributes. By default this prefix is set to cat__.
module-m2-indexing-categories/etc/di.xml
<virtualType name="Klevu\IndexingCategories\Service\Mapper\MagentoToKlevuAttributeMapper"
             type="Klevu\Indexing\Service\Mapper\MagentoToKlevuAttributeMapper">
    <arguments>
        <argument name="entityType"
                  xsi:type="const">Magento\Catalog\Api\Data\CategoryAttributeInterface::ENTITY_TYPE_CODE</argument>
        
        <!-- CATEGORY ATTRIBUTE PREFIX -->
        <argument name="prefix" xsi:type="string">cat__</argument>
        
        <argument name="attributeMapping" xsi:type="array">
            <item name="path" xsi:type="string">categoryPath</item>
            <item name="url_key" xsi:type="string">url</item>
        </argument>
    </arguments>
</virtualType>
<virtualType name="Klevu\IndexingCategories\Service\Mapper\MagentoToKlevuAttributeMapper"
             type="Klevu\Indexing\Service\Mapper\MagentoToKlevuAttributeMapper">
    <arguments>
        <argument name="entityType"
                  xsi:type="const">Magento\Catalog\Api\Data\CategoryAttributeInterface::ENTITY_TYPE_CODE</argument>
        
        <!-- CATEGORY ATTRIBUTE PREFIX -->
        <argument name="prefix" xsi:type="string">cat__</argument>
        
        <argument name="attributeMapping" xsi:type="array">
            <item name="path" xsi:type="string">categoryPath</item>
            <item name="url_key" xsi:type="string">url</item>
        </argument>
    </arguments>
</virtualType>
﻿
The prefix only applies to custom attributes. Klevu standard attributes are not prefixed.
You are free to change this prefix like so
Vendor/Module/etc/di.xml
<virtualType name="Klevu\IndexingCategories\Service\Mapper\MagentoToKlevuAttributeMapper">
    <arguments>
        <argument name="prefix" xsi:type="string">prefix_</argument>
    </arguments>
</virtualType>
<virtualType name="Klevu\IndexingCategories\Service\Mapper\MagentoToKlevuAttributeMapper">
    <arguments>
        <argument name="prefix" xsi:type="string">prefix_</argument>
    </arguments>
</virtualType>
﻿
Note: The prefix is limited to underscores and alphanumeric characters only.
If you change the prefix you’ll also need to ensure that any cat__attribute_code references in your pipeline YMAL files and/or frontend search requests are updated with the new prefix.
﻿
Updated 18 Sep 2024
Did this page help you?
Exclude Categories from Search Results
Images