UF Health Require Image Alt Tags

pipeline status coverage report

Forces users to add an ALT tag when adding images to WordPress posts and more.

Installation and Usage

In order to improve efficiency processed files such as minified JS, CSS and .pot files are not stored in this repository. To use this plugin:

  1. Clone the repository
  2. Change to the repository directory
  3. Run composer install
  4. Run npm install
  5. Run grunt
  6. Map or copy the plugin folder to your WordPress plugins folder to activate like a regular plugin.
Using minified CSS and JS in your plugin

Minified JS and CSS is great in production but it can make development much harder. Fortunately Grunt helps us by building oth minified versions as well as development versions of all of our CSS and JS. To best utilize these in your plugin it is recommended to swap between using SCRIPT_DEBUG. Here's a great article to help you utilize this in your plugin:

Developing your plugin locally

Bundled with this plugin is a Docker configuration compatible with our Ouroboros Docker hub. Here's how do get it running.

  1. Clone and bring up Ouroboros using the instructions on its page
  2. Run ./develop up -d in this repo
  3. Run the setup script using the following ./Docker/bin/setup
  4. Visit the site at [http://ufhealth-require-image-alt-tags.test/]

To access the WordPress Dashboard for the development site use the username admin and the password password

Accessing the PHP server

Should you need to access the PHP server directly you can do so in the terminal by running ./Docker/bin/shell

Running WP-cli commands

You can run WP-cli commands directly against the system by running the wp script in Docker/bin. For example: ./Docker/bin/wp site list will give you a site list.

Setting up Xdebug

Xdebug is available. To access you'll need to set the XDEBUG_SESSION cookie to DOCKER_DEBUG and listen for the connection in your ide (map your local files to /var/www/html/wp-content/plugins/uf-health-test in the IDE to get correct path mappings). A plugin such as [ can make setting the cookie easy]

Note: If you don't use the "develop" script to bring up the environment you'll need to manually setup the correct environment variable to get XDebug to work correctly

Accessing the Database Directly

By default the database ports aren't exposed to your host machine as doing so can cause conflicts if multiple projects are run at the same time. To access the database directly first bring down your server ./develop down, then create docker-compose.override.yml and add the following to it:

version: '3'

      - "3306:3306"

Then bring up the environment again with the develop script. You can then access the database with the username root and the password password on Use Navicat, Sequel Pro, or any tool to import the starter database.

Editing the disclaimer copy

Use the ufhealth_alt_tag_disclaimer filter to edit the copy.


  • Updated plugin for newer coding standards, easier docker development and more.
  • Fixed bugs leading to false positives or a stuck modal in certain situations.
  • Add ufhealth_alt_tag_disclaimer filter to edit copy
  • Check for image as media type for standard insertion box to allow other file times to be added.
  • Better catch of edge cases in the image upload process.
  • Make all test i18n compatible
  • Add "Alt Text" column to media table to easily find missing alt tags.
  • Initial Release