 |
VOOZH | about |
|
VOOZH | about |
This page documents the URL rewrite system, SEO configuration, and metadata management in Maho. It explains how internal system paths are transformed into search-engine-friendly URLs, the indexing logic behind these transformations, and how SEO metadata is managed across products, categories, and integrated modules.
The URL rewrite system is a core component of Maho's catalog management. It serves several critical functions:
catalog/product/view/id/123) into keyword-rich URLs (e.g., blue-widget.html).Maho integrates these features seamlessly into the front controller’s request dispatch and URL generation subsystems.
The rewrite system decouples internal module/controller/action routes from browser-visible URLs by employing a lookup table (core_url_rewrite) synchronized by indexers. Friendly URLs rewrite incoming requests to internal paths transparently.
request_path (SEO-friendly URLs) to target_path (internal routes).This diagram shows how user-friendly URLs and internal system URLs are linked through the URL rewrite table, and the classes managing these flows.
Sources:
app/code/core/Mage/Core/Model/Url.php160-179
app/code/core/Mage/Core/Controller/Request/Http.php227-255
app/code/core/Mage/Core/Helper/Url.php214-238
app/code/core/Mage/Adminhtml/controllers/UrlrewriteController.php110-180
The core_url_rewrite table stores URL rewrite rules with the following critical columns:
| Component | Description | Code Reference |
|---|---|---|
store_id | Store view scope for this rewrite rule | app/code/core/Mage/Core/Model/Url.php264-268 |
request_path | The SEO-friendly URL path (browser-visible URL) | app/code/core/Mage/Core/Model/Url.php44-60 |
target_path | The internal system path (module/controller/action and params) | app/code/core/Mage/Core/Model/Url.php44-60 |
id_path | Unique identifier grouping rewrites | app/code/core/Mage/Adminhtml/controllers/UrlrewriteController.php127-171 |
options | Redirect options, e.g., 'R' for redirect | app/code/core/Mage/Adminhtml/controllers/UrlrewriteController.php153-167 |
is_system | Flag indicating system-generated vs. custom rewrite | app/code/core/Mage/Adminhtml/Block/Urlrewrite/Grid.php62-70 |
description | Optional descriptive text for admin interface | app/code/core/Mage/Adminhtml/controllers/UrlrewriteController.php130-131 |
Trailing slash behavior can be configured globally through admin configuration, influencing URL canonicalization and redirection policies:
Mage_Adminhtml_Model_System_Config_Source_Catalog_Trailingslash.Sources:
app/code/core/Mage/Core/Model/Url.php44-60
app/code/core/Mage/Adminhtml/controllers/UrlrewriteController.php110-180
app/code/core/Mage/Adminhtml/Block/Urlrewrite/Grid.php62-70
app/code/core/Mage/Adminhtml/Model/System/Config/Source/Catalog/Trailingslash.php13-27
Mage_Core_Model_Url builds URLs for frontend and admin routing. It assembles components such as schema, host, port, base path, route names, controller, actions, route params, query strings, and fragments.
The canonical structure of URLs generated by Mage_Core_Model_Url is:
https://user:password@host:port/base_path/[base_script][storeview_path]route_name/controller_name/action_name/param1/value1?query_param=query_value#fragment
Where the segments are:
| Symbol | Description |
|---|---|
| A | Authority: user/pass, host, port |
| B | Path including base paths, scripts, store-code path, route path |
| C | Absolute base URL (scheme + host + port + base_path) |
| D | Action path: route_name/controller/action |
| E | Route parameters encoded in path segments |
| F | Host URL (scheme + host + port) |
| G | Route path relative to base URL |
| H | Fully qualified route URL |
Sources:
app/code/core/Mage/Core/Model/Url.php44-60
app/code/core/Mage/Core/Helper/Url.php89-101
Mage_Core_Helper_Url provides runtime URL manipulation methods critical for SEO and correct URL processing during page rendering and redirects.
| Method Name | Purpose | Code Reference |
|---|---|---|
addTrailingSlash() | Adds a trailing slash to URLs without extensions for uniformity in SEO URLs. | app/code/core/Mage/Core/Helper/Url.php214-228 |
removeTrailingSlash() | Removes trailing slashes for URLs to conform with global trailing slash policy. | app/code/core/Mage/Core/Helper/Url.php230-238 |
setRouteParams() | Adds, updates, or removes Varien-style URL parameters encoded in path segments. | app/code/core/Mage/Core/Helper/Url.php106-131 |
addRequestParam() | Adds query string parameters to URLs. | app/code/core/Mage/Core/Helper/Url.php157-177 |
getCurrentUrl() | Retrieves the current full URL from the request including scheme and port. | app/code/core/Mage/Core/Helper/Url.php22-35 |
buildUrl() | Utility that reconstructs URLs from parse_url components. | app/code/core/Mage/Core/Helper/Url.php89-101 |
These helpers are used throughout layouts, blocks, and controllers to ensure consistent URL syntax, helpful especially when redirecting or generating links dynamically.
The Mage_Adminhtml_UrlrewriteController handles administration of URL rewrites with key capabilities:
The admin UI grids and forms use block classes like Mage_Adminhtml_Block_Urlrewrite_Grid for listing rewrites, showing system vs. custom flags, and mass deletion operations.
Sources:
app/code/core/Mage/Adminhtml/controllers/UrlrewriteController.php12-183
app/code/core/Mage/Adminhtml/Block/Urlrewrite/Grid.php13-111
SEO-related settings are exposed via system configuration and affect URL formatting:
Mage_Adminhtml_Model_System_Config_Source_Catalog_Trailingslash, enabling redirects adding or removing trailing slash.Maho integrates SEO features into its native modules, such as the Blog module. This module extends URL rewriting and SEO by:
Maho_Blog_Model_Observer) to automate SEO-related tasks on content changes.These extensions ensure fully integrated SEO strategies for both standard catalog content and custom module content.
Sources:
app/code/core/Maho/Blog/etc/config.xml142-162
app/code/core/Maho/Blog/Model/Observer.php1
The URL Rewrite and SEO system in Maho tightly integrates internal routing with SEO best practices, providing flexibility and extensibility for store views, canonical URLs, and module-specific SEO needs. It combines database-backed rewrite rules, dynamic URL generation, trailing slash policies, and admin management interfaces to provide robust SEO-friendly URL support.
Sources:
Refresh this wiki