weltpixel

Guide for Magento 2 Rich Snippets (Schema.org Structured Data).

This extension is also included in the Pearl Theme.

1 MINUTE INSTALLATION GUI.

  • Step 1:
    Before installing please check the extension compatibility. This extension is currently compatible with the following Magento versions 2.0.X. - 2.4.6. It is recommended to install the extension first on a testing server before you install it on a live (production) server.
  • Step 2:
    Copy the extension files to below paths of your magento 2 instance. If ‘app/code/WeltPixel’ folder is missing, please create it manually:
    app/code/WeltPixel/Backend
    app/code/WeltPixel/GoogleCards


    • Optional
    Copy the extension files into the below path of your Magento 2 instance. If the ‘app/code/WeSupply’ folder is missing, please create it manually:
    app/code/WeSupply/Toolbox

  • Step 3:
    Copy the installation GUI folder 'weltpixel-extension-installation' in the root of your Magento installation. In some Magento configurations the public root folder may be under 'pub' directory.
    www.yourmagentostore.com/weltpixel-extension-installation/
  • Step 4:
    In your browser go to www.yourmagentostore.com/weltpixel-extension-installation/ and simply follow the installation steps from the graphical interface, presented in your browser. See the installation video: 1 Minute Module Installation via browser GUI.
  • Step 5:
    Wooohooo! The extension is now installed on your Magento store! Congrats!

Troubleshooting

If you experienced any issues or limitations with this quick GUI installation, see also SSH Installation below. SSH installation does the same thing but you are required to issue the commands step by step via CLI. Some servers may have high security configurations and may limit the functionality of this GUI Installer.

How to Install via SSH.

  • Step 1:
    Before installing Google Rich Snippets, Twitter Cards, Facebook Open Graph & Pinterest Rich Pins Extension on a Magento2 store please check the extension compatibility. This extension is currently compatible with the following Magento versions 2.0.X. - 2.4.6. It is recommended to install the extension first on a testing server before you install it on a live (production) server.
  • Step 2:
    Copy the extension files to below paths of your magento 2 instance. If ‘app/code/WeltPixel’ folder is missing, please create it manually:
    app/code/WeltPixel/Backend
    app/code/WeltPixel/GoogleCards


    • Optional
    Copy the extension files into the below path of your Magento 2 instance. If the ‘app/code/WeSupply’ folder is missing, please create it manually:
    app/code/WeSupply/Toolbox

  • Step 3:
    Access the root of your magento 2 project from command line and run the following commands:
    php bin/magento module:enable WeltPixel_Backend --clear-static-content
    php bin/magento module:enable WeltPixel_GoogleCards --clear-static-content
    php bin/magento setup:upgrade
    php bin/magento setup:di:compile
    php bin/magento setup:static-content:deploy -f
  • Step 4:
    Flush any cache that you might still have enabled on your server or in Magento.
  • Step 5:
    Woohoo, the extension is installed!

How to Upgrade the extension.

  • Step 1. Remove extension code under app/code/WeltPixel/GoogleCards before adding the new extension files. The extension may be refactored and old unused files may cause random issues so it's best to only keep the latest version of the files.
  • Step 2. Follow normal installation instructions above.

Magento Marketplace Installation.

How to create rich snippets for your Magento store.

General Settings

Go to Admin > WeltPixel > Rich Snippets & Cards > General Settings:

  • Enable [ Yes / No ] Activate or deactivate Rich Snippets and all related options.
  • Description Choose between Short description and Long description, option chosen will be added to rich structured data.
  • Price - TAX control, Special Price control, Special Price End period
    • Including / Excluding TAX - In case price is listed with Tax and without Tax select which price should be used
    • Special Price - From / To - special price and end date is added to structured data if available
    • Price currency - Automatically added to strucutred data from store settings.
  • Item Condition Select attribute used for product condition ( Attribute should have the following options: DamagedCondition / UsedCondition / NewCondition / RefurbishedCondition according to schema.org)
weltpixel
weltpixel
  • Brand - Select an additional brand that will be added to structured data (Country of manufacture, Shipping, etc..).
  • SKU - Control over the attribute that is used for product SKU, usually it is used the magento default attribute SKU but in special cases a different attribute can be used.
  • GTIN - Control over the attribute that is used for product GTIN code. A 13 digit code is necessary to be added on product details for this partiular attibute in order to be correctly validated. If you do not use a GTIM code, do not select any attribute for this option and it will not show up in your structured data.
  • MPN - Control over the attribute that is used for product MPN code. This code is necessary to be added on product details in order to show up in structured data. If you do not use a MPN code, do not select any attribute for this option and it will not show up in your structured data.
  • Review Markup Format - select between Agregate Ratings and Agregate Ratings with Detailed Reviews
    • Agregate rating - show only review score and number. ex 4.8 / 5 from 287 reviews
    • Agregate rating with Rewiews - add both agregate rating and also latest user rewiews: author, date, message, rating, review name. Ability to specify the number of latest reviews to include. (Pro version)
  • Number of reviews - Specify the number of latest reviews to included in structured data.
  • Use Breadcrumb Snippet - Add data related to Breadcrumbs to structured data. A breadcrumb trail on a page indicates the page's position in the site hierarchy. A user can navigate all the way up in the site hierarchy, one level at a time, by starting from the last breadcrumb in the breadcrumb trail.
  • Advanced Breadcrumbs functionality - Set Always process the full breadcrumbs to constantly display the full breadcrumbs paths to products even when Magento is configured to use short urls (without category url keys in it).
  • Include Simple Product Price in Schema - Choose whether or not to send the price data for each associated Simple Product on Configurable Product pages.
  • Product Image Type For Rich Snippet - Choose the image type you'd like the Magento instance to send via Rich Snippets.
  • Product Image Width (In Px) For Rich Snippet - Choose the Rich Snippet image width.
  • Product Image Height (In Px) For Rich Snippet - Choose the Rich Snippet image height.
Sitelinks Searchbox

Google Search can expose a search box scoped to your website when it appears as a search result. This search box is powered by Google Search. However, if you wish to power this search box with your own search engine, or if you want search results also to include an associated mobile app, you can do so using structured data embedded on your website.

Go to Admin > WeltPixel > Rich Snippets & Cards > Sitelinks Searchbox:

  • Enable Searchbox [ Yes / No ] - Activate searchbox functionality in Google Search.
weltpixel
weltpixel
Rich Snippets & Cards - Logo

Specify the image Google Search uses for your organization's logo in Search results and in the Knowledge Graph. Google Search uses the markup in the use case example to recognize the image to use as the organization’s logo. This ensures that, when possible, the image appears in search results about the company. Markup like this is a strong signal to Google Search algorithms to show this image in Knowledge Graph displays.

Go to Admin > WeltPixel > Rich Snippets & Cards > Rich Snippets & Cards Logo:

  • Enable Rich Snippet for Logo and Corporate [ Yes / No ] - Enable Google Search to show logo in Search results and in the Knowledge Graph.
    • Use Store Logo - the Logo snippet will use the store default logo. The image must be in .jpg, .png, or. gif format
    • Upload Custom Logo - you can upload a custom logo, different than the logo used for your store. The image must be in .jpg, .png, or. gif format
Rich Snippets & Cards - Corporate Contact

Go to Admin > WeltPixel > Rich Snippets & Cards > Rich Snippets & Cards - Corporate Contact:

  • Enable Rich Snippet for Corporate Contact [ Yes / No ] - Enable Google Search to show Corporate contact in Search results and in the Knowledge Graph.
  • Contact Telephone An internationalized version of the phone number, starting with the "+" symbol and country code (+1 in the US and Canada). Examples: "+1-800-555-1212", "+44-2078225951"
  • Contact Type - Examples: "customer support", "technical support", "billing support", "bill payment", "sales", "reservations", "credit card support", "emergency", "baggage tracking", "roadside assistance", "package tracking"
  • Contact Area Served - The geographical region served by the number, specified as a AdministrativeArea. Countries may be specified concisely using just their standard ISO-3166 two-letter code, as in the examples below. If omitted, the number is assumed to be global. Examples: "US", "GB", ["US","CA","MX"]
  • Contact Option - Details about the phone number. Currently only these are supported: "TollFree" and "HearingImpairedSupported"
  • Contact Language - Details about the language spoken. Languages may be specified by their common English name. If omitted, the language defaults to English. Examples: "English", "Spanish", ["French","English"]
weltpixel
weltpixel
    Rich Snippets & Cards - Social Profiles

    Use markup on your official website to add your social profile information to a Google Knowledge panel. Knowledge panels prominently display your social profile information in some Google Search results.

  • Enable Social Profile - Enable Google Search to show up to 10 Social Profiles in Search results and in the Knowledge Graph.
  • Facebook Url - If added, Facebook profile will show in Search results and Knowledge Graph.
  • Twitter Url - If added, Twitter profile will show in Search results and Knowledge Graph.
  • Instagram Url - If added, Instagram profile will show in Search results and Knowledge Graph.
  • Google+ Url - If added, Google+ profile will show in Search results and Knowledge Graph.
  • Youtube Url - If added, Youtube profile will show in Search results and Knowledge Graph.
  • Linkedin Url - If added, Linkedin profile will show in Search results and Knowledge Graph.
  • Pinterest Url - If added, Pinterest profile will show in Search results and Knowledge Graph.
  • Myspace Url - If added, Myspace profile will show in Search results and Knowledge Graph.
  • SoundCloud Url - If added, SoundCloud profile will show in Search results and Knowledge Graph.
  • Tumblr Url - If added, Tumblr profile will show in Search results and Knowledge Graph.
Twitter Cards Settings
  • Go to Admin -> WeltPixel -> Rich Snippets & Cards -> Twitter Cards Settings and set the Twitter Cards:
    • Enable [ Yes / No ] Activate or deactivate the Twitter Cards feature
    • Description Choose between short description and long description
    • Twitter Site Type your store Twitter username. For example @site_username
    • Twitter Creator Type Twitter username of the administrator of Magento store or owner of the store. You can use the site username or leave empty.
weltpixel
weltpixel
Facebook Open Graph Settings
  • Go to Admin -> WeltPixel -> Rich Snippets & Cards -> Facebook Open Graph Settings and set the Facebook Open Graph:
    • Enable [ Yes / No ] Activate or deactivate the Facebook Open Graph feature
    • Description Choose between short description and long description
    • Site name Insert Website’s name
    • App Id fb:app_id
    • Retailer's ID for the item product:retailer_item_id
    • Enable Facebook Graph For CMS Pages Choose whether or not to enable the Facebook Open Graph functionality for CMS Pages as well.
Pinterest Rich Pins Settings
  • Go to Admin -> WeltPixel -> Rich Snippets & Cards -> Pinterest Rich Pins Settings and set the Pinterest Rich Pins:
    • Enable [ Yes / No ] Activate or deactivate the Pinterest Rich Pins feature
weltpixel
weltpixel

How to setup Schema.org Structured Data.

How it works.

Rich Snippets & Cards
  • You can test the Google Cards & Rich Cards functionality by using this testing tool from Google, just place a link from one of your products and you will see data is structured as Google expects: Google Structured Data Testing Tool
    Note: Do not forget to login to Google account for the Google Structured Data Testing Tool to work

    Based on Google policy this data will be shown in the search results. Stores using this data structure will be highly advantaged by search engines, like Google, Yahoo, Bing and other search engines.

Twitter Cards
  • You can test the Twitter Cards functionality by using this testing tool from Twitter, just place a link from one of your products and you will see data is structured as Twitter expects: Twitter Cards Tool
    Note: Do not forget to login to Twitter account for the Twitter Cards Tool to work
weltpixel
weltpixel
Facebook Open Graph
  • You can test the Facebook Open Graph functionality by using this testing tool from Facebook, just place a link from one of your products and you will see data is structured as Facebook expects: Facebook Developpers Tool
    Note: Do not forget to login to Facebook Open Graph for the Facebook Developpers Tool to work

    Based on Google policy this data will be shown in the search results. Stores using this data structure will be highly advantaged by search engines, like Google, Yahoo, Bing and other search engines.

Pinterest Rich Pins
  • You can test the Pinterest functionality by using this testing tool from Pinterest, just place a link from one of your products and you will see data is structured as Pinterest expects: Pinterest Rich Pins Tool
    Note: Do not forget to login to Pinterest for the Pinterest Rich Pins Tool to work
weltpixel
weltpixel
  • After you click debug button, then you will get the analysis.

Change Log.

What’s new in v.1.11.17 - June 28, 2023

  • Fixed a couple of minor itemprop errors that would be displayed when running tests via the Markup Validation Service.
  • Added minor PHP 8.2 related adjustments.
  • Confirmed compatibility with the latest Magento Security Patch releases 2.4.6-p1, 2.4.5-p3 and 2.4.4-p4.
  • Fixed an error related to PHP 8.2 that would show when accessing the WeltPixel Debugger.
  • Added .localdev as a universally accepted licensing domain.


What’s new in v.1.11.15 - March 22, 2023

  • Fixed an error that would sometimes be thrown in the WeltPixel Debugger, depending on various server permissions.
  • Added compatibility with the latest Magento 2.4.6 and 2.4.5-p2 versions.


What’s new in v.1.11.11 - November 23, 2022

  • Fixed an error related to PHP 8.1 that would sometimes be thrown on Configurable Product Pages.
  • Confirmed compatibility with the latest Magento Security Patch releases 2.4.5-p1 and 2.4.4-p2.


What’s new in v.1.11.7 - September 1, 2022

  • Fixed an error that would sometimes be thrown on the Category Page when using a custom attribute in the Brand configuration option, along with a Meta Description on the Product Page.
  • Fixed a bug that resulted in an error on the Product Page when the product had no Description.
  • Added minor code enhancements to keep in line with Magento Best Practices.
  • Performed various code cleanups related to PHP 8.1.
  • Confirmed compatibility with the latest Magento 2.4.5 and 2.4.4-p1 versions.
  • Updated installation/upgrade scripts to use data patches.


What’s new in v.1.10.17 - October 22, 2021

  • Fixed an issue that would prevent the Product Page from loading when using the Full Breadcrumb Path functionality on Products that were not assigned to Catgories.
  • Updated Brand @type from "Thing" to "Brand" in accordance with new Google guidelines for Structured data.
  • Confirmed compatibility with the latest Magento 2.4.3-p1 and 2.3.7-p2 versions.


What’s new in v.1.10.15 - August 31, 2021

  • New Feature: Added a new option that allows for selecting the type of image sent via Rich Snippets - Small/Thumbnail/Base, with Base being default.
  • Confirmed compatibility with the newly released Magento 2.4.3, 2.4.2-p2 and 2.3.7-p1 versions.
  • Added .localhost as an accepted domain termination for the licensing process.


What’s new in v.1.10.11 - July 7, 2021

  • Optimized Breadcrumb generation and display when the extension is configured to process the Full Breadcrumb Path.
  • Added improvments to the WeltPixel Developer Magento Admin section. Latest Cron Jobs now lists the last 100 executed Cron Jobs.


What’s new in v.1.10.9 - May 18, 2021

  • New Feature: Added a new functionality which allows the full breadcrumb path to be displayed on Product Pages, even when navigating directly to the product.
  • Confirmed compatibility with the newly released Magento 2.3.7 and 2.4.2-p1 versions.
  • Excluded Magento 2.0.x - 2.2.x from new features and fixes starting with this release.
  • Adjusted WeltPixel Developer section comments.


What’s new in v.1.10.7 - March 26, 2021

  • New Feature: Added Rich Snippets functionality for CMS Pages.
  • Fixed a bug that prevented images from being uploaded via the Product Labels Magento Admin configuration.
  • Excluded Magento 2.0.x - 2.2.x from new features and fixes starting with this release.
  • Adjusted WeltPixel Developer section comments.


What’s new in v.1.10.5 - February 12, 2021

  • New Feature: Included pricing of Simple Products associated with Configurable Products in schema data. Previously, only the price of the base Configurable Product was sent.
  • Added additional verifications to avoid errors on Configurable Products when using an incorrect ItemCondition attribute.
  • Confirmed compatibility with the newly released Magento 2.4.2 version.
  • Added additional backend versioning verifications.
  • Backend module code optimizations.


What’s new in v.1.10.1 - October 22, 2020

  • Fixed a bug that caused breadcrumbs to fail to rended when FPC was active.
  • Confirmed compatibility with the newly released Magento 2.4.1 version.


What’s new in v.1.10.0 - August 10, 2020

  • Confirmed compatibility with the newly released Magento 2.4.0 version.


What’s new in v.1.9.8 - July 6, 2020

  • Whitelisted domain for Content Security Policies introduced in Magento 2.3.5.


What’s new in v.1.9.7 - May 7, 2020

  • Confirmed compatibility with Magento 2.3.5.
  • Implemented small Backend performance optimizations.
  • Added nxcli.net (Nexcess temporary URL) as a valid domain in the licensing process.
  • Added an option in the Developer section to allow for switching Magento's CSP between "report-only" and "restrict".


What’s new in v.1.9.6 - April 9, 2020

  • Fixed a Backend issue on Magento Commerce whereby the Category Schedule functionality was not working properly.


What’s new in v.1.9.5 - March 10, 2020

  • Added backend Google reCaptcha compatibility for Magento 2.3.x


What’s new in v.1.9.4 - February 5, 2020

  • Changed schema.org URL from HTTP to HTTPS for increased security.
  • Code enhancements for increased security. Changed User Group info collection method.
  • Confirmed compatibility for Magento 2.3.4.


What’s new in v.1.9.2 - November 27, 2019

  • Added Magento and PHP version in the WeltPixel Developer section.


What’s new in v.1.9.1 - October 16, 2019

  • Added Retailer Item ID option for Facebook Open Graph.
  • ConditionType now works with newly created attributes as well. Previously, only the predefined custom attribute could be used for this.
  • Confirmed compatibility with the latst Magento 2.3.3 version.
  • Included the WeSupply Toolbox integration extension - Proactive Notifications Email & SMS, Returns & RMA, Store Locator, Delivery Date Estimate, Logistics Analytics, NPS & CSAT score. Get Free on-boarding and launch within 24 hours.


What’s new in v.1.9.0 - July 18, 2019

  • Confirmed compatibility with Magento 2.3.2.
  • Added HTTPS endpoint for licensing process.


What’s new in v.1.8.5 - June 7, 2019

  • Small performance improvements.


What’s new in v.1.8.4 - April 25, 2019

  • Added PHP version in the WeltPixel Developer Section.


What’s new in v.1.8.3 - April 3rd, 2019

  • Implemented a fix for missing static blocks title. CMS page titles are now correctly shown.
  • Confirmed compatibility for Magento 2.3.1.


What’s new in v.1.8.2 - January 24, 2019

  • Fix for contact Rich Snippet, proper JSON formatting display.
  • Fix for missing breadcrumbs on Product Pages.
  • Helpcenter adjustment, removed Zendesk iframe and added a simple link to our Support Center in order to avoid any potential conflicts with other admin js added by 3rd party extensions.
  • Fix for multiple rewritten ImageFactory classes, rewrite check validity, rewrite checks optimizations.


What’s new in v.1.8.0 - December 8, 2018

  • Compatibility adjustments for Magento 2.1.16/2.2.7/2.3.0.
  • PHP 7.2 compatibility added.
  • As Magento 2.3 comes with major core changes, we have provided a different set of files in order to achieve the best performance on each version.


What’s new in v.1.7.5 - October 24, 2018

  • Added detailed error messages for invalid licenses for an easier identification of the cause.
  • License improvements, added *.magento.cloud as a valid test domain for Enterprise Cloud environments. Now both ‘magentosite.cloud’ and ‘magneto.cloud’ can be used for testing purpose with the production domain license.


What’s new in v.1.7.4 - September 25, 2018

  • Added meta description option.
  • Admin menu styling to fit screen size 1366px.
  • Fix for production mode with merged JS - missing color pallet display now fixed.


What’s new in v.1.7.3 - August 23, 2018

  • License improvements, adding *.magento.cloud as a valid test domain.


What’s new in v.1.7.2 - August 2, 2018

  • Adding organization name fallback to store name.
  • Fixed admin random logout issue.
  • Licensing improvements, allowing 3 letter domain as valid domain.


What’s new in v.1.7.1 - July 12, 2018

  • Compatibility with Magento 2.2.5 both Open Source & Commerce Cloud B2B.
  • Added domain.test & [any_subdomain].domain.test to the list of valid urls for staging/development environments. Added domain validation with port number included for licensing purpose.
  • Added licensing compatibility with Magento B2B.


What’s new in v.1.7.0 - July 5, 2018

  • Image uploader optimization.
  • Added option to enable/disable WeltPixel admin notifications.
  • Show store and server related information under debugging tab: Magento Mode, Magento Edition, Server User, Magento Installation Path, Current server time, Latest cron jobs.
  • Added licensing, license key needs to be generated under weltpixel.com account for purchased product, based on domain name and added under your magento installation.


What’s new in v.1.6.4 - May 16, 2018

  • Compatibility with Magento 2.2.4, logger broken reference fix, changed to rewrite from plugin.


What’s new in v.1.6.2 - March 23, 2018

  • Remove 'Item condition' attribute group assignment for Pro version.
  • Fixing view_preprocessed file issue for Pro version.

What’s new in v.1.6.1 - March 8, 2018

  • System log broken reference error fixes.

What’s new in v.1.6.0 - February 21, 2018

  • Removed magento duplicated product schema if WeltPixel Rich snippets schema is enabled.
  • Upgraded schema and removed error for non existing reviews.
  • Upgraded schema and removed error "The review has no reviewed item specified."
  • Added possibility to select the attribute used for SKU structured data.
  • Documentation updates.

>>> Released Pro version:

  • Added Reviews (Author, message, review name, date, rating).
  • Added Item Condition - New / Damaged / Refurbished / Used.
  • Added Breadcrumbs - website hierarchy structured data.
  • Added Sitelinks Searchbox - expose your search box in Google Search.
  • Added Rich Snippets Logo (Use store logo or upload new logo).
  • Added Corporate Contact - structured data for company contact.
  • Added 10 Social Profiles - display your social profiles in search results.
  • Added GTIN - product GTIN code structured data.
  • Added MPN - product MPN code structured data


What’s new in v.1.5.8 - January 12, 2018

  • Added version control for installed WeltPixel modules, including latest version check.
  • Magento default schema removal if WeltPixel rich snippets is enabled.


What’s new in v.1.5.7 - December 14, 2017

  • Added Support Center functionality in Magento Admin.
  • Added Debugger functionality, checks for rewrites and points potential issues.
  • Adding facebook graph warning fixes.
  • Adding fb:app_id meta tag and admin option posiibility as well for fb open graph.
  • Removing magento default schema.org pricing if google cards enabled, wrong price display fix.
  • New admin option: Possibility to select Price Including or Excluding taxes if both prices are displayed.
  • Configurable products price fix.


What’s new in v.1.5.3 - September 20, 2017

  • Checked compatibility with Magento 2.2 and PHP7.1 - all ok, updated composer.


What’s new in version 1.1.2 - May 16, 2017

  • Added translations files under /i18n/en_US.csv.

What’s new in version.1.1.1 - March 20, 2017

  • Added New Twitter cards admin options: Summary Card, Summary Card with Large Image.

What’s new in version.1.1.0 - 22/11/2016

  • Composer.json dependency updated to backend 1.0.3 instead of master
  • Description and name slash error fix

What’s new in version.1.0.5 - 03/10/2016

  • Update composer.json dependency to backend 1.0.3 instead of master

What’s new in version.1.0.4 - 13/09/2016

  • Fixed compilation dependency issue

What’s new in version.1.0.3 - 02/07/2016

  • Added admin notifications

What’s new in version.1.0.2 - 08/06/2016

  • New feature: Rich Snippets
  • New feature: Facebook Open Graph
  • New feature: Twitter Cards
  • New feature: Pinterest Rich Pins

What’s new in version.1.0.1 - 05/06/2016

  • Removing the unnecessary dependency
  • Exception namespace error fixed
weltpixel