optiweb/module-robots

Control and limit catalog page indexing by altering the robots meta tag value based on applied filters in layered navigation.

Maintainers

Details

git.optiweb.serv.si/ow-public/magento-2-robots-fix-module

Installs: 66

Dependents: 0

Suggesters: 0

Security: 0

Type:magento2-module

1.0.1 2021-10-11 07:10 UTC

Requires

  • php: >=7.4
  • magento/framework: >=103.0.2

MIT a425f7372df5b3019cd494aaeebbc168e34a35c1

This package is auto-updated.

Last update: 2025-03-11 14:18:27 UTC

README

A Magento 2 module

This module allows you to easily control when web crawlers are allowed to index your catalog pages by modifying the robots meta tag.

Features

  • Select one or more filterable attributes where indexing is allowed
  • Control on which layout handles this is applied (defualts to catalog_category_view)
  • Test mode - display current robots meta value and see currently applied filters

Brief description of logic

  1. check if functionality is enabled
  2. check if we are currently on a page where this logic is applied
  3. check if the module is configured - if there are no allowed attributes to index the default behavior is not changed
  4. if there is a sorting parameter applied, we set robots to NOINDEX,FOLLOW
  5. check if there are more than 1 filters applied and set NOINDEX,NOFOLLOW in that case
  6. iterate through applied filters and set
    1. NOINDEX,NOFOLLOW if the attribute is not indexable and more than 1 option is selected
    2. NOINDEX,FOLLOW if the attribute is not indexable and exactly 1 option is selected
    3. NOINDEX,FOLLOW if the attribute is indexable and more than 1 option is selected

Installation

Warning: You can only install this module with Composer 2.x. If you don't use Composer 2.x yet, read below.

composer require optiweb/module-robots
bin/magento module:enable Optiweb_Robots
bin/magento setup:upgrade
bin/magento setup:di:compile

If you don't use Composer 2.x yet, you can install this module in app/code.

  1. Create directories: mkdir -p app/code/Optiweb/Robots && cd app/code/Optiweb/Robots
  2. Clone the repository git clone https://git.optiweb.serv.si/ow-public/magento-2-robots-fix-module.git .
  3. Enable module: bin/magento module:enable Optiweb_Robots
  4. Compile code bin/magento setup:upgrade && bin/magento setup:di:compile

Configure module in Stores → Configuration → Catalog → Catalog Robots Settings

Changelog

  • 1.0.0 - initial release
  • 1.0.1 - readme updates, composer constraints updates

Known issues

There are currently no known issues

Compatibility

Developed on Magento 2.4.3 and tested on Magento 2.3. should work with all Magento 2 versions.

License

MIT - see LICENSE.txt