Packagist · #3175 most downloaded on Packagist

olegkoval/magento2-regenerate-url-rewrites

1.12.04.1M downloads/moolegkoval/magento2-regenerate_url_rewrites ↗New releases in your daily digest, changelog included.

Add into Magento 2 a CLI feature which allow to regenerate a Url Rewrites of products and categories

Last release today
07 Oct 2026
Ships unpredictably
gaps range from 9 days to 2.6 years
Nearly every release is documented
notes for 37 of 37 stable releases
Nothing withdrawn
no release was ever pulled
9 years old
37 releases · first in 2017

Release timeline

37 releases since 2017

Releases

1.12.07 Oct 2026
A feature release: preview a run with --dry-run , see every change with -v , and get short messages from the author (security notes, new releases) in
A feature release: preview a run with --dry-run, see every change with -v, and get short messages from the
author (security notes, new releases) in the admin and the console.

Added

--dry-run (#149). Previews a run without saving anything. The whole regeneration runs in one database
transaction that is always rolled back, so the preview is exact, even for cascades such as a parent category's
new URL key changing its children's and products' URLs. It prints a Changes: … summary (every change with
-v) and Dry run: no changes were saved., and it skips reindex and cache refresh.

bin/magento ok:urlrewrites:regenerate --entity-type=category --category-id=3 --regen-url-key --dry-run -v

It can't be combined with --set-product-suffix/--set-category-suffix. The rows it touches stay locked
until it ends, so preview large runs off-peak. From code: RunOptionsBuilder::setDryRun(true).

-v prints every change a run makes (#91):

URL rewrites added, removed or updated (only the columns that changed);

url_key/url_path changes with their scope;

then a Changes: … summary.

Without -v nothing is tracked, so ordinary runs cost the same as before.

Messages from the author:

shown in the admin notifications bell, and at the end of ok:urlrewrites:regenerate runs started from a
terminal (never in cron or piped output);

read once a day from the magento-extension-notifications
repository, with a 2 s timeout;

the request sends only a generic user agent: no shop URL, admin URL or Magento version.

Turn them off in Stores > Configuration > Advanced > System > Notifications, or per run with
--no-messages.

Fixed

Calling the service inside your own database transaction (for example from a data patch): one failed
save no longer makes every later save of the run fail. The extension's own saves use savepoints there.

Changed

The module now depends on Magento_AdminNotification, which is part of Magento Open Source.

The Composer package no longer contains the unit tests (Test/) or the CI configuration (.github/).

Compatibility: Magento Open Source 2.4.7–2.4.9, PHP 8.2–8.5 (unchanged). Verified on Magento 2.4.8-p5 with
sample data (1 and 2 store views):

every scenario run with --dry-run left the database identical to not running it;

plain and -v runs saved the same data as 1.11.1;

the -v change list matched the database diff;

unit tests run in CI on PHP 8.2–8.5.

Full details: CHANGELOG.md

20172019202120232025

20172026

One column per quarter.

Additional notes

Added

messages from the extension author (security notes, releases) in the admin notifications bell and at the end of interactive console runs, read once a day from the magento-extension-notifications repository. Only a generic user agent is sent. Turn them off in Stores > Configuration > Advanced > System > Notifications, or per run with the new --no-messages option. See "Messages From the Author" in the README
--dry-run (#149): preview a run — everything runs in one database transaction that is rolled back at the end, so nothing is saved; prints a summary of what would change, and skips reindex and cache refresh. Can't be combined with --set-product-suffix/--set-category-suffix. From code: RunOptionsBuilder::setDryRun()
-v prints every change a run makes (#91): URL rewrites added, removed or updated, and url_key/url_path changes with their scope, followed by a Changes: … summary. Without -v nothing is tracked, as before

Fixed

a failure inside a caller's database transaction (e.g. a data patch running the service) no longer makes every later save of the run fail: the extension's own saves use savepoints there

Changed

the module now depends on Magento_AdminNotification (part of Magento Open Source)
the Composer package no longer contains the unit tests (Test/) or the CI configuration (.github/)

Open source →

1.11.15 Oct 2026

A bug-fix release: URL regeneration no longer marks products as edited, and category runs no longer touch product URL keys.

A bug-fix release: URL regeneration no longer marks products as edited, and category runs no longer touch product
URL keys.

Fixed

Product updated_at is preserved. Until now every regenerated product got updated_at set to the run time
(Magento's mass attribute action writes it on every call), so after a full run the whole catalog looked
modified — XML sitemap <lastmod>, ERP/PIM/feed delta syncs and "recently updated" reports all picked it up.
Ordinary runs and the products of category runs now keep their updated_at; with --regen-url-key it changes
only for products whose URL key actually changes.
Category runs with --regen-url-key keep the products' URL keys. The products a category run regenerates get
new URL paths and rewrites, but their own url_key is no longer regenerated from the product name — which
overwrote hand-made product URL keys in a run that targeted only categories.

⚠️ Behavior change for --entity-type=category --regen-url-key: it now regenerates only the categories'
URL keys. To regenerate product URL keys, run --entity-type=product --regen-url-key.

Compatibility: Magento Open Source 2.4.7–2.4.9, PHP 8.2–8.5 (unchanged). Verified against 1.11.0 in 14
old-vs-new scenarios on Magento 2.4.8-p5 with sample data (1 and 2 store views); unit tests in CI on PHP 8.2–8.5.

Full details: CHANGELOG.md

Open source →

Additional notes

Fixed

ordinary product URL rewrite regeneration no longer changes updated_at, including products processed by category runs; explicit URL-key regeneration updates the timestamp only when the key changes
category runs with --regen-url-key now preserve cascaded products' URL keys; only category URL keys are regenerated, while the products' paths and rewrites are still refreshed

Open source →

1.11.030 Sept 2026

The regeneration is now available as a public service API for your own code (cron jobs, queue consumers, integrations), and the CLI command runs throu

The regeneration is now available as a public service API for your own code (cron jobs, queue consumers,
integrations), and the CLI command runs through it. Command options, results and exit codes are unchanged —
verified against 1.10.0 in 14 old-vs-new scenarios (1 and 2 store views): identical URL rewrites, identical
exit codes.

Added

Service API (@api): Api\RegenerateServiceInterface (validate(), run()), options built with
Model\RunOptionsBuilder, a result with failure and processed counts, an optional progress reporter (throw
from it to stop a run cleanly), and an optional change listener that receives every URL rewrite and
url_key/url_path change of a run — detailed enough to log, audit or undo a run. See "Use From Code" in the
README.
--exact-categories: with --category-id/--categories-range, only the given categories are processed;
their subcategories only when a given category's URL path changed — and then without regenerating their
url_key, so --regen-url-key stays on the categories you named. For precise fixes on large category trees.
A summary line before "Finished", e.g. Processed: 38 category(ies), 2040 product(s) in 3 store(s).
A backward-compatibility policy (README "Backward compatibility") for code that builds on this extension.

Changed

Reindex and cache refresh run in the same PHP process (Magento's indexer and cache services) instead of
spawning bin/magento indexer:reindex / cache:clean / cache:flush. They now use the run's own memory
limit — the spawned processes ignored php -d memory_limit=... and could run out of memory without any
message — and a failing or locked indexer now shows up in the [FAILURES] summary (exit code 1).
Category runs that regenerate their products show a progress bar for that phase too.
A URL suffix locked in app/etc/config.php is reported before anything is saved.
--include-not-visible help and README now describe what it can do: Magento itself creates no URL rewrites for
a product that isn't visible in any store view.

Fixed

--regen-url-key left a stale store-level url_key when the regenerated key equalled the default one: the
URL used the new key, the product/category kept the old one, and the next run switched the URL back. The
store-level value is now removed, so the store view inherits the default (products and categories).

ℹ️ If you extend the command or the models in your own code: the protected methods
_runReindexation(), _runClearCache() and _setSeoUrlSuffixes() of the command moved into the service, and
the models' _showProgress() / progressBarProgress / progressBarTotal were replaced by the progress
reporter. The command's constructor gained an optional 9th argument (existing 8-argument subclasses keep
working). From this release on, the backward-compatibility policy in the README applies.

Compatibility: Magento Open Source 2.4.7–2.4.9, PHP 8.2–8.5 (unchanged). Unit tests run in CI on PHP 8.2–8.5
against Magento 2.4.8-p5 / 2.4.9 packages; verified end-to-end on Magento 2.4.8-p5 with sample data (PHP 8.3).

Full details: CHANGELOG.md

Open source →

Additional notes

Added

a public service API to run the regeneration from code (cron jobs, queue consumers, integrations): Api\RegenerateServiceInterface (validate(), run()), run options built with Model\RunOptionsBuilder, a RunResultInterface with failure counts/details, and an optional ProgressReporterInterface. The CLI command now runs through it; its options and output are unchanged (except the new summary line below). See "Use From Code" in the README. Also: a documented way to stop a run (throw from the reporter), processed counts in the result, toArray()/RunOptionsBuilder::fromArray() to log and replay a run's options, and an Api\ChangeListenerInterface that receives a run's changes (rewrites added/removed/updated with full rows, url_key/url_path changes with their scope; not URL suffix config) — groundwork for a verbose output (#91)
new option --exact-categories: with --category-id/--categories-range, process only the given categories — their subcategories only when a given category's URL path changed, and then without regenerating their url_key, so --regen-url-key stays on the given categories. Useful for precise fixes on large category trees
the command prints a summary before "Finished", e.g. Processed: 38 category(ies), 2040 product(s) in 3 store(s)
a backward-compatibility policy (README "Backward compatibility"): semantic versioning, what stays stable within 1.x and which interfaces may grow

Changed

reindex and cache refresh after a run now happen in the same PHP process through Magento's indexer and cache services instead of spawning bin/magento indexer:reindex / cache:clean / cache:flush: they use the run's own memory limit (e.g. php -d memory_limit=-1 bin/magento ...), which the spawned processes didn't inherit, and a failing or locked indexer is now reported in the [FAILURES] summary (exit code 1) instead of being ignored
--include-not-visible help and README now say what the option does: "Not Visible Individually" products are processed too (e.g. url_key regeneration), but Magento creates no URL rewrites for a product that isn't visible in any store view — the option never could add those
category runs that regenerate their products (Use Categories Path for Product URLs) now show a progress bar for that product phase too, instead of nothing until it ends
a --set-product-suffix/--set-category-suffix value locked in app/etc/config.php is now reported before anything is saved; before, the other suffix was still saved and then the run aborted
for code extending the command or the models: the command's protected _runReindexation(), _runClearCache() and _setSeoUrlSuffixes() moved into the service, and the models' _showProgress() / progressBarProgress / progressBarTotal were replaced by the progress reporter; the command's constructor gained an optional 9th argument (8-argument subclasses keep working). The backward-compatibility policy applies from this release on

Fixed

--regen-url-key for a store view left a stale store-level url_key in place when the regenerated key was the same as the default one (it only skipped writing a redundant copy, see #92): the rewrite used the new key but the product/category kept the old one, and the next run without --regen-url-key switched the URL back. The store-level value is now removed, so the store view inherits the default

1.10.026 Sept 2026

⚠️ Behavior change — exit code. The command now exits with code 1 when any product/category (or a cleanup step) fails, after reindex and cache refresh

⚠️ Behavior change — exit code. The command now exits with code 1 when any product/category (or a
cleanup step) fails, after reindex and cache refresh have still run, and prints a [FAILURES] summary.
Earlier versions always exited 0 and hid these failures, so cron jobs or scripts that check the exit
code may start reporting failures that were already happening.

Changed

Failures are reported, not silently skipped: an end-of-run summary lists counts per entity type plus
up to 20 of the failures, and the command exits 1 (see above).
All-stores runs no longer regenerate every store view twice: the store 0 (default scope) pass now
only updates default-scope url_key/url_path, and each store view is generated once — identical
results; ~15–30% faster on a two-store-view catalog, more with more store views.
Category runs with "Use Categories Path for Product URLs" enabled regenerate each affected product
once, after all categories, instead of once per ancestor category — identical results; a full category
run on the sample catalog went from ~22s to ~5s.

Fixed

--save-old-urls now actually creates 301 redirects (#174, #142): when a URL changes, the old URL
redirects to the new one. Before, it kept serving the page as an ordinary rewrite (duplicate content).
Also covers switching to --add-sku-to-url together with --save-old-urls.
Custom URL rewrites are kept intact: --add-sku-to-url no longer appends the SKU to admin-created
rewrites or kept old-URL redirects, and redirects pointing at a product now follow it to its SKU URL
instead of a URL that no longer exists.
--store-id=0 runs no longer drop the rewrites of store views after the first, and now replace the
store views' current rewrites.
A product/category whose generated URL paths were all empty no longer has its existing rewrites touched.

Compatibility: Magento Open Source 2.4.7–2.4.9, PHP 8.2–8.5 (unchanged). Verified end-to-end on
Magento 2.4.8-p5 with sample data under PHP 8.3 and 8.4; lint-clean on 8.2–8.5.

Full details: CHANGELOG.md

Open source →

Additional notes

Changed

the command now reports failures instead of silently skipping them: products/categories whose URL rewrites couldn't be generated or saved (and failed cleanup steps) are listed in an end-of-run summary — counts per entity type plus up to 20 of the failures — and the command exits with code 1. Reindex and cache refresh still run first. Previously it always exited 0, so cron jobs/scripts that check the exit code may now start alerting on failures that used to be hidden.
all-stores runs no longer regenerate every store view twice: the store 0 (default scope) pass now only updates default-scope url_key/url_path, and each store view is generated once — with identical results; on a two-store-view sample catalog full runs were ~15–30% faster, and the saving grows with the number of store views
category runs with "Use Categories Path for Product URLs" enabled regenerate each affected product once, after all categories are done, instead of once per ancestor category (plus a full scan of the product/category rewrite table after every category) — identical results; on the sample catalog a full category run went from ~22s to ~5s

Fixed

--store-id=0 (global scope) runs dropped the product rewrites of every store view after the first (identical paths in different store views were treated as duplicates) and didn't replace the store views' current rewrites, so old URLs kept serving pages and --save-old-urls redirects were lost
--save-old-urls now actually creates 301 redirects: when a URL changes, the old URL redirects to the new one. Before, the old URL kept serving the page as an ordinary rewrite (duplicate content) and the redirect Magento generated was silently dropped when saving (#174, #142). This includes switching to --add-sku-to-url with --save-old-urls: the old unsuffixed URL now redirects to the SKU URL
--add-sku-to-url (and path clean-up/de-duplication in general) no longer alters custom URL rewrites: admin-created rewrites, and old-URL redirects kept by --save-old-urls, keep their exact request path. Before, --add-sku-to-url appended the SKU to them too, so a custom URL like promo/sale became promo/sale-<sku> and the original URL stopped working.
with --add-sku-to-url, custom redirects (and --save-old-urls redirects) pointing at a product's URL now follow it to the SKU-suffixed URL; before, they kept pointing at the old unsuffixed URL, which no longer existed (redirect to a 404)
a product/category whose generated URL paths were all empty no longer has its existing rewrites touched (nothing to write, so the current rewrites are kept)

Open source →

1.9.126 Aug 20262 sources agree

new options --set-product-suffix / --set-category-suffix — set the product/category URL suffix (e.g. .html ) before regenerating, via the same write p

Added

new options --set-product-suffix / --set-category-suffix — set the product/category URL suffix
(e.g. .html) before regenerating, via the same write path Magento's own config:set CLI command
uses, so validation and the automatic suffix swap on existing url_rewrite rows both run. Applied to
Default Config and every store view, or only the store given via --store-id. If either suffix value
fails Magento's validation, the whole command aborts before any regeneration runs.

Fixed

category url_path was not recalculated per store view: when a category's url_path had only ever
been saved at the default (store 0) scope, Magento's CategoryUrlPathGenerator short-circuited and
handed back that inherited value instead of building a new one from the store-scoped url_key,
because the category object's still-populated url_path made its dataHasChangedFor() checks look
unchanged. Now url_path is cleared on the category object before generation, matching the pattern
already used on the product side. (#184)

Open source →

1.9.018 Aug 20262 sources agree

new option --skip-products — skip regenerating associated product URLs when regenerating categories (useful on large catalogs when "Use Category Path

Added

new option --skip-products — skip regenerating associated product URLs when regenerating categories (useful on large catalogs when "Use Category Path for Product URLs" is enabled)
new option --skip-existing — skip an entity entirely if it already has any url_rewrite for the current store, instead of always deleting + regenerating
new option --include-not-visible — also regenerate URLs for products with visibility "Not Visible Individually" (e.g. configurable child products), excluded by default since 1.6.2
new option --add-sku-to-url — append the product's SKU as a URL segment in generated product Url Rewrites, e.g. screws.html -> screws-2244000004.html

Fixed

guard against writing a blank url_key when Magento's own transliteration can't handle the product/category title (e.g. Arabic/other non-Latin scripts)

Open source →

1.8.09 Aug 2026Deprecated

The old --no-regen-url-key option is removed entirely (not deprecated) — passing it will now produce an "option does not exist" error. If your scripts…

⚠️ Breaking change

url_key regeneration is now opt-in. Previously, url_key was regenerated automatically unless you passed --no-regen-url-key. That default is now inverted: url_key is not regenerated unless you explicitly pass the new --regen-url-key option.

The old --no-regen-url-key option is removed entirely (not deprecated) — passing it will now produce an "option does not exist" error. If your scripts/cron jobs relied on the previous default (url_key regenerated automatically), add --regen-url-key to them before upgrading. (#151)

What's Changed

Fixed

Data loss risk in saveUrlRewrites(): deleting existing rewrites and inserting new ones now happen in a single transaction, so a failed insert can no longer leave an entity with its rewrites deleted and nothing to replace them. (#137)
Category regeneration now processes every category, top level down to the deepest child, instead of only top-level categories — child categories' own url_key/url_path are now regenerated too, not just their url_rewrite rows. (#153, #166)
Skip writing a redundant per-store url_key override when the regenerated value is identical to the default-scope value, avoiding unnecessary bloat in the EAV attribute tables. (#92)

Added

New option --delete-orphaned-rewrites — deletes url_rewrite rows (for the given --entity-type) whose product/category no longer exists. (#158)

Compatibility

Magento Open Source 2.4.7 → 2.4.9
PHP 8.2 → 8.5

Full Changelog: 1.7.3...1.8.0

Open source →

Additional notes

Changed

BREAKING: inverted url_key regeneration default — url_key is no longer regenerated automatically; use the new --regen-url-key option to opt in. The old --no-regen-url-key option is removed entirely (not deprecated) — update any existing scripts/cron jobs that relied on the previous default.
fixed data loss risk in saveUrlRewrites(): deleting existing rewrites and inserting new ones now happen in a single transaction, so a failed insert can no longer leave an entity with its rewrites deleted and nothing to replace them
fixed category URL rewrite regeneration to process every category (top level down to the deepest child) instead of only top-level categories, so child categories' own url_key/url_path are regenerated too
skip writing a redundant per-store url_key override when the regenerated value is identical to the default-scope value

Added

new option --delete-orphaned-rewrites — deletes url_rewrite rows (for the given --entity-type) whose product/category no longer exists

Open source →

1.7.39 Aug 2026Deprecated

PHP 8.5 compatibility: replaced the deprecated non-canonical (double) type cast with (float) in the progress bar calculation, eliminating the deprecat…

Fixed

PHP 8.5 compatibility: replaced the deprecated non-canonical (double) type cast with (float) in the progress bar calculation, eliminating the deprecation notice Magento throws under PHP 8.5. (#183)
Reindex/cache commands now use the correct PHP executable: replaced a hardcoded php command with PHP_BINARY so reindex/cache calls always run under the same PHP version as the CLI command itself, instead of whatever php happens to resolve to on $PATH. (#161)
Category regeneration no longer aborts entirely when it hits one broken/orphaned category: exception handling is now scoped per-category (matching the existing per-product behavior), so a single bad entity is skipped instead of stopping the whole batch. (#172)

Changed

Added a missing type hint and defensive casting in a couple of internal helper methods (PHP 8.x hygiene).
Declared the minimum supported PHP version (>=8.2) in composer.json.

Compatibility

Magento Open Source 2.4.7 → 2.4.9
PHP 8.2 → 8.5

Thanks to @swnsma and @f123248 for reporting and helping diagnose the PHP 8.5 issue.

Open source →

Additional notes

Changed

fixed deprecated non-canonical (double) type cast for PHP 8.5 compatibility
use the current PHP executable (PHP_BINARY) instead of a hardcoded "php" command for reindex/cache calls
fixed category URL rewrite regeneration stopping entirely when a single broken/orphaned category is encountered
added missing type hint and defensive casting in a couple of helper methods
declared minimum supported PHP version (>=8.2) in composer.json

Open source →

1.7.27 Apr 2026Deprecated2 sources agree

fixed deprecated functionality: ctype_digit()

This release improves compatibility, hardens query safety, and refines CLI behavior for URL rewrite regeneration.

Changed

fixed deprecated functionality: ctype_digit()
improved SQL safety in URL rewrite regeneration queries
fixed SQL escaping in URL rewrite cleanup logic
fixed _clearRequestPath() to correctly handle multiple consecutive slashes
removed dead code from category URL rewrite model
display validation errors before command failure
display a completed progress bar for empty product/category collections
normalized line endings to LF

Open source →

1.7.130 May 2025Deprecated2 sources agree

Adapted for compatibility with PHP 8.4 (deprecated implicitly nullable types).

Open source →

1.7.017 Apr 20252 sources agree

Adapted for compatibility with Magento 2.4.7-p4. Adapted the composer.json file to be compatible with Composer 2.

Adapted for compatibility with Magento 2.4.7-p4.
Adapted the composer.json file to be compatible with Composer 2.

Open source →

1.6.210 Oct 2023

Fixed Symfony Command constant issue. Excluded non visible products from url regeneration.

Fixed Symfony Command constant issue.
Excluded non visible products from url regeneration.

Open source →

Additional notes

Changed

fixed Symfony Command constant issue
exclude non visible products from url regeneration

Open source →

1.6.124 Aug 2023

Fixed compatibility with Symfony Console 5 and Magento 2.4.6. Updated contact email.

Fixed compatibility with Symfony Console 5 and Magento 2.4.6.
Updated contact email.

Open source →

Additional notes

Changed

fixed compatibility with Symfony Console 5 and Magento 2.4.6
updated contact email to Gmail email (my own domain olegkoval.com was stolen)

Open source →

1.6.027 Jan 20212 sources agree

Adapted to Magento 2.3.5. Fixed incorrect generation when URL suffix is slash.

Adapted to Magento 2.3.5.
Fixed incorrect generation when URL suffix is slash.

Open source →

1.5.614 Apr 2020

Updated logic of "cleaning" of Url Rewrites and duplications check.

Open source →

Additional notes

Changed

updated logic of "cleaning" of Url Rewrites and duplications check

Open source →

1.5.52 Apr 2020

updated logic of Url Rewrite regeneration via category entity

Changed

updated logic of Url Rewrite regeneration via category entity
fixed compilation issue in helper

Open source →

1.5.421 Mar 2020

fixed issue of non-empty/non-false "request_path" of product entity.

Changed

fixed issue of non-empty/non-false "request_path" of product entity.
modified logic of Url Rewrite db table updates

Open source →

1.5.321 Mar 2020

updated Url Rewrite preparing function

Changed

updated Url Rewrite preparing function
updated logic of Url Rewrite regeneration via category entity
updated save logic

Open source →

1.5.218 Mar 2020

updated logic of Url Rewrite regeneration via category entity

Changed

updated logic of Url Rewrite regeneration via category entity
CLI options logic optimized (for category entity)

Open source →

1.5.18 Mar 2020

fixed issue of url_key and url rewrites regeneration based on product name value

Changed

fixed issue of url_key and url rewrites regeneration based on product name value

Open source →

1.5.026 Feb 2020

modified functional logic of extension

Changed

revised and restructured code
modified functional logic of extension
removed option "--check-use-category-in-product-url"

Open source →

1.4.312 May 2019

### Added - new option "no-regen-url-key" ### Changed - fixed a "typo" issue

Added

new option "no-regen-url-key"

Changed

fixed a "typo" issue

Open source →

1.4.24 Apr 2019

new option "--check-use-category-in-product-url"

Added

new option "--check-use-category-in-product-url"
info into log about conflicted URL Rewrites

Changed

fixed logical issues in url_key regeneration
a fix for category/products rewrites for multistore
fixed issue of division by zero in progress bar
update the url_key regeneration behavior to use UrlPathGenerators
modified logic of displaying console messages (notifications, errors, exceptions...)

Open source →

1.4.122 Feb 2019

fixed the issue of removing previously added URL rewrites of product when the same URL key exists;