How To: Integrate the Highlighter with the Schema App Advanced WordPress Plugin

Modified on Thu, 27 Apr 2023 at 11:44 AM

This support document lists all the steps that must be completed in order to receive markup from the Schema App Highlighter and the WordPress plugin. Failure to follow this process can result in duplicate markup (i.e custom markup from the Highlighter and automatic markup from the Plugin), or schema drift (markup not updating to reflect page content).

Resources Required

  • Schema App Account
  • Schema App Advanced WordPress Plugin
  • Schema App Highlighter


Step 1: Set Up Your Schema App Account

  1. Navigate to the Schema App Homepage
  2. Confirm the deployment method for your site is set to WordPress
  3. When you navigate to the Integrations page, the WordPress plugin option should be Active
  4. Information about Webhooks can be found on the WordPress Integration page. If you plan to use the Highlighter to deploy markup at scale, the Highlighter must be set to enabled in the WordPress settings.

Step 2: Install the WordPress Plugin

  1. Login to Schema App
  2. Navigate to the WordPress Integration page (found in the Integrations subdirectory)
  3. Copy the Account ID listed in step 6
  4. Login to your WordPress website. 
  5. Download the Plugin on WordPress from Plugin Repository.
    1. In your WordPress site hover over the plugins tab on the ride side of your screen and click on "add new". 
    2. Type in "Schema App" in the search bar. 
    3. Click "Install Now". 
    4. After downloading the plugin, click "activate plugin", and it will automatically be added to the plugins list in your WordPress account.
  6. Activate the plugin through the ‘Plugins’ menu in WordPress. This is an essential step It is important that you check to make sure the plugin is activated and ready to add markup to your site.

Step 3: Set up the Schema App Plugin

  1. Within WordPress, go to Settings > Schema App
  2. Under the Settings tab of the Schema App Plugin fill out the following:
    1. Enter the Account ID from your Schema App account
    2. Select the Publisher Type (Note: This is usually an Organization)
    3. Provide the Publisher Name (Note: This should be the name of your Organization)
    4. Provide a Publisher Logo noting the size requirements listed. You can select this from your uploaded images in WordPress.

  3. Fill out the Schema Default Settings:
    1. Enable default markup on Posts and Pages if desired 
    2. Determine the location of the markup (we recommend the header)
    3. Select the default Type for Posts and Pages
    4. Enable video markup for embedded videos
    5. Keep "Background sync of Schema Editor markup" disabled unless using WP Cron
    6. Upload a default image to be used for Posts and Pages when none is available
  4. (Optional) If using WPEngine, enable "Clear WPEngine Page Level Cache Automatically" for faster deployment times.

Step 4: Install the Advanced Plugin

  1. Follow the steps in the Advanced Plugin Installation Guide to install the Advanced Plugin

Step 5: Complete Setup for Highlighter

If you are an Enterprise customer with a Highlighter subscription, you need to complete these steps to ensure your Highlighter markup deploys and to avoid duplicate markup.
  1. Navigate to WordPress Settings > SchemaApp > Advanced and set the Schema App Highlighter to "Enabled". Enabling the highlighter will add the necessary scripts to your page so you can use the JavaScript + Webhook Hybrid integration method to deploy markup server side.

  2. Installation is now complete. You or your CSM will still want to verify that your templates are deploying as expected.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article