PHPackages                             outeredge/magento-structured-data-module - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. outeredge/magento-structured-data-module

ActiveMagento2-module

outeredge/magento-structured-data-module
========================================

Magento Structured Data Module by outer/edge

5.2.5(3mo ago)73128.8k—3.5%18[3 PRs](https://github.com/outeredge/magento-structured-data-module/pulls)MITPHPPHP ^8.1

Since Apr 24Pushed 2mo ago10 watchersCompare

[ Source](https://github.com/outeredge/magento-structured-data-module)[ Packagist](https://packagist.org/packages/outeredge/magento-structured-data-module)[ RSS](/packages/outeredge-magento-structured-data-module/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (122)Used By (0)

[![Packagist](https://camo.githubusercontent.com/4f57820c502149db273d9a56fe7b7593934cf032ccb278ec61d1b7e7a3999cd8/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6f75746572656467652f6d6167656e746f2d737472756374757265642d646174612d6d6f64756c653f7374796c653d666f722d7468652d6261646765)](https://packagist.org/packages/outeredge/magento-structured-data-module)[![Packagist](https://camo.githubusercontent.com/20924de9855208f4e4772734ff2bb7f75f95f52714b33f7477545db47a76a4d3/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6f75746572656467652f6d6167656e746f2d737472756374757265642d646174612d6d6f64756c653f7374796c653d666f722d7468652d6261646765)](https://packagist.org/packages/outeredge/magento-structured-data-module)[![Packagist](https://camo.githubusercontent.com/a1ed64e6fc935a91c4126a28191b5990ffcd811e8d7944114b4336c8aa1c95ba/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f6f75746572656467652f6d6167656e746f2d737472756374757265642d646174612d6d6f64756c653f7374796c653d666f722d7468652d6261646765)](https://packagist.org/packages/outeredge/magento-structured-data-module)

outer/edge Structured Data Module for Magento 2
===============================================

[](#outeredge-structured-data-module-for-magento-2)

[Hyvä](https://hyva.io) and [Breeze](https://breezefront.com/) compatible.

Our open source module allows you to quickly add structured data markup (also known as Rich Snippets) to any Magento 2 store by simply installing our module and setting a few configuration options.

Once this module is installed you will have valid structured data in the source of your product, contact and CMS pages. For example:

This will look similar to the below:

```

{
    "@context": "https://schema.org/",
    "@type": "Product",
    "@id": "https://example.co.uk/blue-t-shirt#Product",
    "brand": {
            "@type": "Brand",
            "name": "Nike"
    },
    "aggregateRating": {
        "@type": "AggregateRating",
        "bestRating": "100",
        "worstRating": "1",
        "ratingValue": "4.55",
        "reviewCount": "5"
    },
    "name": "Nike Blue T-Shirt",
    "sku": "blue-t-shirt",
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer viverra vitae nulla quis venenatis. Donec sollicitudin pharetra eros, in facilisis justo fringilla eu. In at consequat felis.",
    "image": "https://example.co.uk/media/catalog/product/b/t/blue-t-shirt.jpg",
    "offers": {
        "@type": "Offer",
        "url": "https://example.co.uk/blue-t-shirt",
        "price": 18.99,
        "priceCurrency": "GBP",
        "priceSpecification": {
            "@type": "UnitPriceSpecification",
            "price": 18.99,
            "priceCurrency": "GBP",
            "valueAddedTaxIncluded": true
        },
        "availability": "http://schema.org/InStock",
        "itemCondition": "http://schema.org/NewCondition"
    }
}

```

The module provides the following structured data:

### Product Page (GraphQL available)

[](#product-page-graphql-available)

- @type
- @id
- name
- sku
- description
- image
- weight
- brand
- aggregateRating
    - bestRating
    - worstRating
    - ratingValue
    - reviewCount
- mpn
- material
- color
- price
- priceCurency
- valueAddedTaxIncluded
- availability
- itemCondition
- AggregateOffer
    - offers
- highPrice
- lowPrice

### Contact Page

[](#contact-page)

- @type
- @id
- name
- image
- address
- telephone
- email
- url
- geo

### CMS Page

[](#cms-page)

- name
- mainContentOfPage
- description
- primaryImageOfPage

Installation
------------

[](#installation)

#### Install via Composer

[](#install-via-composer)

```
composer require outeredge/magento-structured-data-module

```

#### Review configuration for Structure Data Module

[](#review-configuration-for-structure-data-module)

Configuration is available in `Stores > Configuration > outer/edge > Structured Data`. The following options are available:

#### Products

[](#products)

[![structured_data-product](/assets/config-product.png)](/assets/config-product.png)

- **Enable for Product Page:** Enable or disable structured data on product pages.
- **Enable for Category Page:** Enable or disable structured data on category pages.
- **Use Short Description:** Use `short_description` attribute for the `description` markup. By default `description` will be used.
- **Include ChildProducts:** Choose whether to include individual offer for each child (simple) product for structured data on configurable product pages.
- **Include Product Weights:** Add `weight` schema to product page structured data.
- **Hide Product Price/Offer:** Removes the "offer" block with pricing from structured data. This is useful for B2B websites that don't display pricing to the public.
- **Include Magento Product Reviews:** Includes core Magento product reviews. Check theme and  - May conflict with core markup.
- **Product Attributes:** Choose which Magento attribute is used to populate the structured data values.
    - **Brand/Manufacturer** (Default: `manufacturer` or `brand`)
    - **MPN** (Default: empty)
    - **ISBN** (Default: empty)
    - **Size** (Default: empty)
    - **GTIN** (Default: empty)
    - **Color** (Default: `Color` or `Colour`)
    - **Material** (Default: empty)
    - **Keywords** (Default: empty)

#### CMS Pages

[](#cms-pages)

[![structured_data-cms](/assets/config-cms.png)](/assets/config-cms.png)

- **Enable:** Enable or disable structured data on CMS pages.
- **Enable About Page:** Enable or disable `"@type": "AboutPage"`.
- **About Page:** Select the CMS page for `"@type": "AboutPage"`.

#### Organization

[](#organization)

[![structured_data-contact](/assets/config-organization.png)](/assets/config-organization.png)

- **Type:** Select whether business in a Local Business or Organization.
- **Latitude:** Specify latitude for local business.
- **Longitude:** Specify longitude for local business.
- **Enable on Home Page:** Enable or disable Organization structured data on Home page.
- **Enable on Contact Page:** Enable or disable Organization structured data on Contact page.
- **Related Pages** Populates "SameAs" property. Add links to related pages, for example Facebook, Linked In and other social media sites.

Once the module is installed and configured you will find the schema markup in your source code:

[![schema_screenshot](/assets/screenshot-schema.png)](/assets/screenshot-schema.png)

GraphQL
-------

[](#graphql)

Our structured data module provides for product schema to the built in Magento GraphGL endpoint. Simply request the `structured_data` field with your product data as per the example below and the data will be returned as a JSON array:

```
{
  products(
    filter: {
        ...
    }
  ) {
    items {
      sku
      name
      structured_data
    }
  }
}

```

Uninstalling the module
-----------------------

[](#uninstalling-the-module)

#### Remove via Composer

[](#remove-via-composer)

```
composer remove outeredge/magento-structured-data-module

```

### References

[](#references)

#### Google docs for structured data format (using JSON-LD format)

[](#google-docs-for-structured-data-format-using-json-ld-format)

#### Structured data syntax is based on

[](#structured-data-syntax-is-based-on)

###  Health Score

65

—

FairBetter than 99% of packages

Maintenance84

Actively maintained with recent releases

Popularity47

Moderate usage in the ecosystem

Community23

Small or concentrated contributor base

Maturity89

Battle-tested with a long release history

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~31 days

Recently: every ~47 days

Total

92

Last Release

111d ago

Major Versions

1.2.0 → 2.1.82019-09-23

1.2.1 → 2.1.92019-10-23

2.4.1 → 3.0.02023-02-10

3.0.4 → 4.0.02023-06-29

4.2.1 → 5.0.02024-05-24

PHP version history (3 changes)2.0.0PHP 7.0.2|7.0.4|~7.0.6|~7.1.0

2.3.6PHP ^7.4|^8.1

5.0.0PHP ^8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/1860caf77d9ad2a652f889890911b695bbc63db970b03cd53c4c52aa5c922f8f?d=identicon)[outeredge](/maintainers/outeredge)

---

Top Contributors

[![davidwindell](https://avatars.githubusercontent.com/u/1720090?v=4)](https://github.com/davidwindell "davidwindell (93 commits)")[![vseager](https://avatars.githubusercontent.com/u/2035088?v=4)](https://github.com/vseager "vseager (70 commits)")[![broopdias](https://avatars.githubusercontent.com/u/2809478?v=4)](https://github.com/broopdias "broopdias (42 commits)")[![bensinca](https://avatars.githubusercontent.com/u/13001260?v=4)](https://github.com/bensinca "bensinca (6 commits)")[![thomas-kl1](https://avatars.githubusercontent.com/u/20971693?v=4)](https://github.com/thomas-kl1 "thomas-kl1 (2 commits)")[![sweetappleuk](https://avatars.githubusercontent.com/u/783268?v=4)](https://github.com/sweetappleuk "sweetappleuk (2 commits)")[![macieklewkowicz](https://avatars.githubusercontent.com/u/3532870?v=4)](https://github.com/macieklewkowicz "macieklewkowicz (2 commits)")[![ollyijb](https://avatars.githubusercontent.com/u/67915143?v=4)](https://github.com/ollyijb "ollyijb (1 commits)")[![barryvdh](https://avatars.githubusercontent.com/u/973269?v=4)](https://github.com/barryvdh "barryvdh (1 commits)")[![p24-max](https://avatars.githubusercontent.com/u/106059119?v=4)](https://github.com/p24-max "p24-max (1 commits)")[![paugnu](https://avatars.githubusercontent.com/u/506393?v=4)](https://github.com/paugnu "paugnu (1 commits)")

### Embed Badge

![Health badge](/badges/outeredge-magento-structured-data-module/health.svg)

```
[![Health](https://phpackages.com/badges/outeredge-magento-structured-data-module/health.svg)](https://phpackages.com/packages/outeredge-magento-structured-data-module)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
