How to Use _findCategoryTreeByAlias Method#
The _findCategoryTreeByAlias method retrieves the category tree based on the current URL path or alias. This method is particularly useful for dynamically loading category trees in a web application where the URL structure corresponds to different categories. It handles complex scenarios like subdomain paths and utilizes other category-related methods to fetch the relevant data.Usage Steps:#
1.
This method automatically extracts the category alias from the URL path. You do not need to provide any parameters. Simply call the method when you need to retrieve the category tree based on the current URL.
2.
Define a Callback Function:The callback function is passed as a parameter. This function will be executed once the category tree is retrieved. The retrieved category tree data will be passed as an argument to this function.
3.
Handle Retrieved Category Tree:Inside your callback function, you can process the retrieved category tree. This might involve displaying the category structure on the UI, using it for navigation, or performing other actions based on the category hierarchy.
Example:#
The handleCategoryTree function will be executed once the category tree is retrieved, allowing you to process the data as needed.
Common Use Cases:#
1.
Use this method to load and display the correct category tree on dynamic category pages based on the current URL structure.
2.
In applications where the category structure is embedded in the URL, this method allows you to dynamically fetch and display categories without hardcoding the category tree.
3.
Optimized Data Retrieval:The method makes use of caching and existing category retrieval methods, ensuring efficient data fetching while adapting to complex URL structures.
Notes:#
URL Path Extraction: The alias is the second segment of the URL path: for /categories/kitchen it is kitchen. When the store is served under a sub-path (stored in the _domainpath cookie), that segment is removed first.
No alias in the URL: If the path has no second segment, the callback receives the entire category tree.
Unknown alias: If the second segment does not match any category alias, there is no fallback. The method fails with a TypeError while reading the category id, and the callback is never called. On pages where the URL may not name a category, check the alias with _findCategoryByAlias first, or call _findCategoryTreeById(null, callback) to get the full tree.
Asynchronous Process: Since the method involves fetching category data based on the alias, the callback function will be executed asynchronously once the data is retrieved.
Modified at 2026-10-07 12:02:07
