User Tools

Site Tools


magento2:extensions:toweringmedia-shop-by-brand

This is an old revision of the document!


Magento 2 Shop by Brand Extension – User Guide

Extension Overview

The Shop by Brand extension lets you create brand pages in Magento and assign products to each brand. Customers can browse the available brands, open a brand page, and view the products assigned to that brand.

Product Information

  • Extension Name: Toweringmedia Shop by Brand
  • Magento Module: Toweringmedia_ShopByBrand
  • Composer Package: toweringmedia/module-shop-by-brand
  • Version: 1.1.0
  • Magento: Magento 2
  • PHP: 8.1, 8.2, 8.3, 8.4
  • Dependency: toweringmedia/module-base
  • License: Proprietary

Key Features

  • Create brand pages with a custom URL, logo, description, and SEO details.
  • Use any Magento product attribute for your brands.
  • Select products manually and set their display order.
  • Show brands on a separate brand listing page.
  • Show the brand logo and information on product pages.
  • Add a More from this Brand section to product pages.
  • Choose the product limit, layout, sorting, and Add to Cart option.
  • Customers can filter, sort, paginate, compare, and add products to their Wishlist.
  • Set the brand URL route and pagination noindex option.

Installation

For installation instructions, please see the Toweringmedia Installation Guide.

Admin Configuration

To configure the extension, go to:

Stores → Configuration → Towering Media → Shop by Brand

General

Brand Product Attribute – Select the product attribute you use for brands. Manufacturer is selected by default.

Product Page

  • Display Brand Info on Product Page – Choose where the brand information should appear on the product page.
  • Display Brand Description – Turn the brand description on or off.

More from this Brand Block

  • Enable “More from this Brand” Block – Turn the block on or off.
  • Block Name – Enter the heading to show above the products.
  • Block Position – Choose where the block should appear on the product page.
  • Block Layout – Choose the layout for the products.
  • Max Products to Display – Set the number of products to show.
  • Display “Add to Cart” Button – Choose whether to show the Add to Cart button.
  • Sort Products by – Choose how the products should be sorted.

SEO

  • Add Noindex to Pagination Pages – Add NOINDEX,FOLLOW to pages after the first brand page.
  • Route to Brand Pages – Set the URL prefix for brand pages. The default value is brands.

After changing these settings, clear the Magento cache so the changes appear on the storefront.

Brand Management

Go to:

Catalog → Shop by Brand by Towering Media

From here, you can add a new brand or edit an existing one.

Brand Page Grid

The brand grid shows the following information:

  • ID – Brand ID.
  • Brand Name – Name of the brand.
  • URL Key – URL key used for the brand page.
  • Status – Shows whether the brand is enabled or disabled.
  • Actions – Open the brand for editing.

Click Add Brand to create a new brand.

Create or Edit a Brand

When you add or edit a brand, you can enter the following information.

General Information

  • Brand – Select the brand from the configured product attribute.
  • URL Key – Enter the URL key that will be used for the brand page.
  • Logo – Upload the brand logo. PNG, GIF, JPG, and JPEG files are supported. The maximum file size is 4 MB.
  • Featured Brand – Set this to Yes if you want to mark the brand as featured.

Content

  • Meta Description – Enter the meta description for the brand page.
  • Description – Enter the description you want to show on the brand page.

Click Save Brand when you are done.

Editing an Existing Brand

Open a brand from the grid to update its URL key, logo, featured setting, meta description, or description.

To remove a brand, open the brand and click Delete.

When you create a new brand, options that are already used by another brand are not shown in the dropdown. When editing a brand, its current option remains available.

Product Assignment

Products can be selected manually from the brand edit page.

Assign Products

  1. Open a brand from Catalog → Shop by Brand by Towering Media.
  2. Go to the product selection section.
  3. Select the products you want to assign to the brand.
  4. Set a position for each product.
  5. Save the brand.

The saved position controls the order of products on the brand page.

The product grid can also be filtered using the configured brand product attribute.

User Experience

Shop By Brand Page

Customers can open the Shop By Brand page to see the available brands.

Brands are shown with their logos and names. Pagination is available when there are more brands to display.

The Browse Brands section can be used to find brands by letter. Featured brands are also shown in the sidebar.

Brand Details Page

Click a brand to open its brand page.

The brand page shows the brand logo, name, description, and assigned products.

Customers can:

  • Filter products
  • Sort products
  • Move between pages
  • Add products to the cart
  • Add products to the Wishlist
  • Compare products

The brand page also uses the standard Magento product listing toolbar and filters.

Product Details Page

When enabled, the brand information is shown on the product page.

The customer can see the brand logo and description. Clicking the logo opens the brand page.

This gives customers a quick way to view other products from the same brand.

More from this Brand

The More from this Brand section can be displayed on the product page when it is enabled in the configuration.

It shows other products assigned to the same brand.

The administrator can control:

  • Block heading
  • Block position
  • Product layout
  • Number of products
  • Product sorting
  • Add to Cart button

SEO

Brand URL

Each brand can have its own URL key.

For example:

https://example.com/brands/nike

The brands part is controlled by the Route to Brand Pages setting.

Meta Information

Each brand can have its own:

  • Meta title
  • Meta description
  • Brand description

Pagination Noindex

If Add Noindex to Pagination Pages is enabled, paginated brand pages use:

NOINDEX,FOLLOW

This setting applies to brand pagination pages after the first page.

Validation Checklist

Use the following checklist after installing and configuring the extension:

  • [ ] Check that the Shop by Brand module is enabled.
  • [ ] Check the Brand Product Attribute setting.
  • [ ] Create a brand and set its URL key.
  • [ ] Upload a valid logo and save the brand.
  • [ ] Check that the brand is enabled.
  • [ ] Assign products to the brand and set their positions.
  • [ ] Open the Shop By Brand page and check that the brand is listed.
  • [ ] Open the brand page and check the logo, description, and products.
  • [ ] Check product filtering, sorting, and pagination.
  • [ ] Check Wishlist, Compare Products, and Add to Cart.
  • [ ] Open an assigned product and check the brand information.
  • [ ] Click the brand logo and check that it opens the correct brand page.
  • [ ] If More from this Brand is enabled, check that the block appears correctly.
  • [ ] Check the block position, layout, product limit, and sorting.
  • [ ] Check the brand URL and pagination noindex setting.
  • [ ] Clear Magento cache after changing the configuration.

Troubleshooting

A brand does not appear in the Add Brand dropdown

Check whether the option is already being used by another brand. An option that already has a brand page is not shown when creating another brand.

Products are not showing on the brand page

Check that the products have been assigned to the brand. Also make sure the products are enabled and available in the catalog.

Brand logo is not showing

Check the logo file type and size. PNG, GIF, JPG, and JPEG are supported, and the file must be 4 MB or smaller.

Brand page shows a 404

Check that the brand is enabled and that the URL key is correct.

Also check the Route to Brand Pages setting.

Clear the Magento cache after changing the URL settings.

Changes are not visible on the storefront

Clear the Magento cache and Full Page Cache, then reload the page.

More from this Brand is not showing

Check that the block is enabled in the configuration.

Also make sure there are other products assigned to the same brand.

Changing the Brand Product Attribute did not change existing brands

This is expected. Changing the Brand Product Attribute does not change the attribute used by brands that were already created.

magento2/extensions/toweringmedia-shop-by-brand.1790625444.txt.gz · Last modified: by swatwik