EZ-Pages Meta-Tags — for Zen Cart v1.5.6 and later

Version 4.0.0, Copyright © 2015-2019, Vinos de Frutas Tropicales (lat9)

Current Support Thread at Zen Cart Forums: Click here.

GitHub Repository: Click here.


What it does

This plugin adds three (3) additional fields in your admin's Tools->EZ-Pages where you can enter the meta title, keywords and description for each page. Values you enter here override the built-in Zen Cart meta-tag processing for that page. The admin-level tool is updated to show the meta-tags' on/off icons depending on whether or not meta-tags have been defined for a given EZ-Page.

Three additional fields are added to your Zen Cart's ezpages_content table by the plugin's admin-level auto-installer:

  1. pages_meta_title
  2. pages_meta_keywords
  3. pages_meta_description

Notes:

  1. If an EZ-Page has been configured to use an External Link URL, then the page's metatags are not used, since the link is going to an external page!
  2. If a store has installed a version of EZ-Pages Meta-Tags prior to v4.0.0, the admin-installation copies any recording of the meta-tags' information from the site's ezpages table to the ezpages_content table … and then removes that content from the ezpages table. Be sure to make a backup copy of your database prior to installation, if this applies to your store!

Plugin Installation

This plugin has one core-file overwrite and makes changes to your store's database; you should always backup your cart's database and files prior to making any changes.

  1. Unzip the plugin's package file, which you've most likely already done if you're reading this!
  2. Rename the /YOUR_ADMIN directory to match your Zen Cart's secret admin-folder name.
  3. Make a copy of your current /YOUR_ADMIN/ezpages.php file; if you've made previous changes to that file, you'll need to merge those changes with this plugin's updates. Those updates add a series of notifications that are used by the plugin's admin-level "observer".
  4. Copy the plugin's files to your store's file system.
    1. /includes/auto_loaders/config.ezpages_metatags.php
    2. /includes/classes/observers/EzPagesMetaTagsObserver.php
    3. /YOUR_ADMIN/ezpages.php
    4. /YOUR_ADMIN/includes/auto_loaders/config.ezpages_metatags_admin.php
    5. /YOUR_ADMIN/includes/classes/observers/EzPagesMetaTagsAdminObserver.php
    6. /YOUR_ADMIN/includes/extra_datafiles/ezpages_metatags_sanitization.php
    7. /YOUR_ADMIN/includes/functions/extra_functions/ezpages_metatags_admin_extra_functions.php
    8. /YOUR_ADMIN/includes/init_includes/init_ezpages_metatags_admin.php
    9. /YOUR_ADMIN/includes/languages/english/extra_definitions/ezpages_metatags_extra_definitions.php
  5. Log into your Zen Cart admin-console; this will cause the auto-installer to run, adding the three new fields to the ezpages_content database table.

Upgrading from a Version Prior To v4.0.0

If you are upgrading the EZ-Pages Meta-Tags from a version prior to v4.0.0, you'll need to first remove some of the core/template-file changes provided by those previous versions.

  1. Delete these no longer used files:
    1. /YOUR_ADMIN/includes/auto_loaders/config.zc154_compatibility.php
    2. /YOUR_ADMIN/includes/init_includes/init_zc154_compatibility.php
  2. Restore core-file contents. For each of these files, restore the files to their as-shipped Zen Cart version, merging any additional customizations that you might have made, but removing any sections associated with the plugin's previous version:
    1. /YOUR_ADMIN/includes/classes/object_info.php
    2. /YOUR_ADMIN/includes/languages/english/ezpages.php
  3. Remove the plugin's previous version's changes from template-override files. If you have other customizations to this file, remove this plugin's prior additions. If the only changes were from this plugin's prior versions, you can safely remove this file from your template's override directory … restoring the use of the default processing.
    1. /includes/modules/YOUR_TEMPLATE/meta_tags.php

Once you've removed the plugin's previous versions' changes, continue your upgrade by following the Plugin Installation instructions.


Uninstalling

Delete the plugin's new files (see the Plugin Installation instructions) copied during the installation — the plugin's changes to your admin's ezpages.php can safely remain, as they're the simple additions of notifications. Finally, run the /docs/ezpages_metatags/uninstall/uninstall_ezpages_metatags.sql to remove the plugin's added fields from your database.


Version History