Magento 2 Flat Category URLs Documentation

  • Installation

    You can install the module for Magento 2 using Composer or you can manually install it using FTP.

    Composer

    Run the following commands in your Magento 2 root directory to install the module using Composer.

    # Add the FishPig Composer repo
    composer config repositories.fishpig composer https://repo.fishpig.com/
    
    # Install the module using Composer
    composer require fishpig/magento2-flatcategoryurl:*
    
    # Enable the module in Magento 2
    php bin/magento module:enable FishPig_FlatCategoryURL
    
    # Run the Magento upgrade system
    php bin/magento setup:upgrade
    Manual

    You can download the latest version of the module by logging in to your account and selecting Account > Projects.

    Extract the ZIP file and upload the files to your Magento site at the directory below:

    app/code/FishPig/FlatCategoryURL

    When creating the folders, ensure you use the correct capitalisation.

    To complete the installation, run the following commands in a terminal.

    # Enable the module in Magento 2
    bin/magento module:enable FishPig_FlatCategoryURL
    
    # Run the Magento upgrade system
    bin/magento setup:upgrade

    ↑ Back to Top

  • CLI Commands

    The Flat Category URL module comes with a CLI command that can be run using SSH and the terminal. This command generates the new URLs based on the module's configuration. You should run this command after installing the module and/or changing any of the module's configuration options.

    php bin/magento fishpig:flatcategoryurl:reindex

    ↑ Back to Top