Plugin that adds Schema (in JSON-LD format), Facebook and Twitter structured markup to all pages. Schema markup is added in three blocks: organisation, breadcrumbs and product (including reviews).
This plugin was originally based on the Super Data code with reviews and breadcrumbs added from Zen 4All Github but my modifications got out of hand and I redid it completely. I made considerable changes for some bugs, multilanguage site with multibyte characters and removed added fields as demanded by the various validators.
Plugin Forum Thread: https://www.zen-cart.com/showthread.php?221868-Structured-Data-Markup-for-Schema-Facebook-Open-Graph-Twitter
As ALWAYS, expect that ANY new code will self-destruct your shop so test ALL new code on your development server FIRST. When you are satisfied, ensure your production files and database are backed up prior to installing in the production site.
Super Data: If you wish to uninstall the old Super Data plugin, please note that the uninstall sql included with that plugin is incorrect. A corrected version is included with these files.
- Use the installation sql to install constant definitions and register the new admin configuration page into the database.
In my testing it was possible to run the sql code in the ZC->Admin->SQL Patch tool on a ZC155e vanilla installation. But, it's known to be pretty strict (https://www.zen-cart.com/showthread.php?216551-ERROR-Cannot-insert-configuration_key-quot-quot-because-it-already-exists-empty-db-key) so if this gives you an error, you can restore the database (from the backup you did immediately before trying this...), and try again using phpmyadmin instead.
- Copy the admin file to enable the admin page to display.
CHECK THE ADMIN PAGE WORKS BEFORE GOING ANY FURTHER.
The plugin in disabled by default so you need to enable it in the configuration page and add values to the constants before it will show up in the catalog.
Optional There are 38 constants and it's very tedious to update them one by one (especially if repeatedly testing the sql install and thereby starting from scratch each time). I have included a spreadsheet where you can enter all the constant values into a worksheet to generate sql UPDATE queries. Hence you can copy and paste the queries to enter all the values into the database in one go (via the ZC admin SQL patch tool or phpmyadmin).
- Copy catalog file to:
includes/templates/YOUR_TEMPLATE/jscript
The inclusion of this file in this /jscript folder should make the structured data blocks be included on ALL pages automagically.
- Although the markup will display without any further template modifications, strictly you should make this additional modification to the html_header.php, assuming you have a HTML5 template.
from:
<!DOCTYPE html>
<html <?php echo HTML_PARAMS; ?>>to:
<!DOCTYPE html>
<html <?php echo HTML_PARAMS; ?> prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb# product: http://ogp.me/ns/product#">This adds the namespaces for the properties og:, fb:, product: which are used later in the structured data block.
- Check the output on all your pages for empty parameters or properties that don't reflect what they should.
Every site is different, so it is impossible to make this particular plugin 100% plug and play, you DO need to check the markup output carefully to ensure it reflects your business and be prepared to modify accordingly or report any omissions if you think they are relevant generally.
Use the various debuggers to check the various blocks:
- Google Structured Data
- Facebook Opengraph Debugger
- Twitter Card Validator
Please try it out and report any issues.
Things behind some of the code that you may wish to modify/be aware of.
There are three code blocks:
- Organisation: on all pages.
The sameAs property should point to:
a. the "best" page for contact information on this particular website: this is currently hard-coded as the contact_us page. The property is thus not generated on the contact_us page.
b. other social pages
Breadcrumbs: on all pagesProduct: on product pages only
priceValidUntil: set to the last day of the current year as that may be when prices get updated.
LocalBusiness - refers to a PHYSICAL store NOT an online only shop. Then you can add a subtype such as Store or something more specific from the spreadsheet listing here:
https://docs.google.com/spreadsheets/d/1Ed6RmI01rx4UdW40ciWgz2oS_Kx37_-sPi7sba_jC3w/edit?pli=1#gid=0
An online-only business should use Organisation, (or the more specific Corporation, if it applies). This allows you to use the makesOffer/offeredBy property.
If you wish to use LocalBusiness, this may be expanded (example):
"openingHours": "Mo, Tu, We, Th, Fr 9:00-17:00"
To suit all, a minimum of 600x300 is recommended.
Image size is not defined in Schema but one Google recommendation is minimum:160x90 maximum: 1920x1080
Google Structured Data Testing tools complains about "Unspecified Type". Ignore it, discussed here: https://productforums.google.com/forum/#!msg/webmasters/tOewAWTfMDM/l8ZYnmk-BQAJ
Tags have been referenced to type product: https://developers.facebook.com/docs/reference/opengraph/object-type/product/ and NOT product.item: https://developers.facebook.com/docs/reference/opengraph/object-type/product.item/
some tags are different...
Note that an error in the OG debugger will stop the app id from showing up in for example scraped tags, even though you would assume it to be unrelated to the error...so fix the reported error!
There must be a type for each image.
minimum dimensions (or will not display): 200*200px or will not be shown
maximum dimensions: 1200/630px
"recommended" dimensions by users: 600/315 (1.91:1)
Type may need editing to suit your business.
Background info for type business.business: https://developers.facebook.com/docs/reference/opengraph/object-type/business.business
condition: new, refurbished, used. The Schema definitions are slightly different, so they are hard-coded/listed in an array in the code.
The availability of the product is instock, oos, or pending. Hardcoded to instock and pending depending on if stock = 0 or not.
availability: set toinStockorPreOrderdeliveryLeadTime: set toinStock= 1 day,Out of Stock/PreOrder= 7 days
minimum dimensions =: 280x150px or will not display
maximum size: approx. 1MB.
"recommended" dimensions by users: 600x321 (1.867:1)
2020 03 27 - torvista Added the option of creating an anonymous, blank review with an admin-defined star-rating for products with no review at all, in an attempt to stop hundreds of warnings: Missing field "aggregateRating" Missing field "review" Remains to be seen if results in further warnings. 2020 02 25 - torvista changed array declarations to short syntax changed while to a foreach 2020 02 11 - torvista fixed double encoding ampersands. general revision for strict mode/EA inspection recommendations 2019 06 18 - torvista for php notices: facebook reviews code to only run on a product page. 2019 05 08 - torvista added schema: priceValidUntil Used last day of the year. added schema: SKU sku, mpn, ProductID all use the same products_model. Misc Moved fields around to mirror Google Structured Data Tool example. Edited the layout spacing for better visual presentation.
Bugfix Improved cleaning of product description for schema (line feeds, carriage returns, extra spaces). meta property="og:description" was always using Meta Tag description instead of category description when defined.
2018 10 03 - torvista Minor readme corrections. Uploaded to Zen Cart Plugins as v1.0
2017 04 24 - Dr. Byte improved readme (and further modified by torvista to use Github markdown), install sql, trap error for getimagesize
2017 04 - torvista changed review, datepublished to required format yyy-mm-dd bugfix: corrected product, offer, acceptedPaymentMethods
2017 02 - torvista og: product_retailer changed from AdminID to Appid og: product:retailer_title removed (not in spec)
complete overhaul... revised Super Data, breadcrumb code and added/revised Review code for products from Zen4all: https://github.com/Zen4All-nl/Zen-Cart-Structured-Data-using-Json
Many changes made so decided to offer this as a separate plugin. bugs: added closing spaces to some properties, added missing quotation marks around product: acceptedPaymentMethod, incorrect category name on product, reviews all used same rating, review bestRating/worstRating incorrectly used, reviews did not take account of a multi-language shop nor multibyte characters in names and descriptions. sameAS item assumed all constants populated (not true) so produced an invalid listing with spaces and quotation marks. Facebook: condition->product.condition and others added/modified. App secret removed: not used anywhere. Deprecated images: added optional image tags locale: added array to auto-generate locale and locale:alternate Twitter: removed obsolete card types. Changed to large_card. Changed: removed sql queries where not required - got info from other already existing globals. Added simple stock/lat9 POSM query. Added clauses around facebook and twitter markup to only display if using these services. Image info re-written. Removed attributes: product: inventoryLevel
2015 Zen Cart - forked into Super Data - mprough https://www.zen-cart.com/downloads.php?do=file&id=1984
2014 Zen Cart - Facebook Open Graph - Numinix https://www.zen-cart.com/downloads.php?do=file&id=1820