WordPress Plugin

Overview

Connecting a site to tidyDOM with our WordPress plugin allows you to see the latest scan details and download reports without leaving the WordPress dashboard. This is especially useful for agencies and freelancers that want to surface reports for clients, but do not want to set them up with an account on tidyDOM.

Installing the Plugin

Search for tidyDOM from the Add Plugins page in WordPress, or download the plugin from https://wordpress.org/plugins/tidydom.

Configuring the Plugin

First, you’ll need to generate an API key for the site you are setting up.

On tidyDOM.com

  1. From the site dashboard, click Integrations and then Add Integration.
    A screenshot of the add integration screen.
  2. Click Add CMS Plugin.
    A screenshot of the add CMS Plugin screen.
  3. On the next screen, choose the CMS type (WordPress) and click Add.
  4. Your API Key will be displayed in a modal window. Make note of it, as you will not be able to view it again.
    A screenshot of the API Key modal.

From your Wordpress Admin Dashboard

  1. After enabling the plugin, you will see a new menu item called Accessibility. Visit the Settings submenu of this new menu item.
  2. Paste the API key you just generated into the appropriate field.
  3. Select the user roles you would like to have access to accessibility reports.
  4. Click save settings.
  5. If get an error, double check your API key and try again. Contact support if you continue to have issues.

Viewing Reports

  1. Click the Accessibility menu item to view/download reports and see configured pages.