Skip to content

A WordPress plugin that generates an alt text on upload, or when editing existing images. Uses GPT-4o to understand and analyze the images.

License

Notifications You must be signed in to change notification settings

KimBranzell/WP-Auto-Alt-Text

Repository files navigation

WP Auto Alt Text

Generate high-quality, AI-powered alternative text for your WordPress images automatically using OpenAI's advanced image recognition capabilities.

Description

WP Auto Alt Text is a powerful WordPress plugin that leverages artificial intelligence to automatically generate meaningful and descriptive alt text for your images. This improves your site's accessibility, SEO, and user experience with minimal effort.

Key Features

  • One-click AI-powered alt text generation
  • WP CLI and REST API support for bulk processing in the terminal
  • Bulk processing capabilities
  • Rate limiting to manage API costs
  • Simple integration with WordPress media library
  • Support for multiple image formats (including AVIF and WebP)
  • Clean and intuitive user interface
  • Statistics dashboard showing usage metrics and generation history
  • Visual diff view for edited alt text changes
  • Support for WooCommerce product images
  • Automatic alt text generation on image upload (configurable)
  • Secure API key encryption
  • Generation type tracking (Manual, Upload, Batch)
  • Image caching system to prevent duplicate API calls

API Key Responsibility

Users must provide their own OpenAI API key. This plugin does not include or share API keys. Protect your API key by keeping it private and not sharing it with others.

Compliance with OpenAI Terms of Use

By using this plugin, you agree to comply with OpenAI’s Terms of Use. Ensure that your use of the OpenAI API aligns with OpenAI’s guidelines and restrictions.

No Liability

The developers of this plugin are not responsible for any misuse of the OpenAI API or non-compliance with OpenAI’s policies by end-users.

Installation

Standard Installation

  1. Download the plugin files
  2. Upload the plugin files to your /wp-content/plugins/ directory
  3. Install the plugin through the WordPress plugins screen directly
  4. Activate the plugin through the 'Plugins' screen in WordPress

API Key Setup

  1. Navigate to the 'Auto Alt Text' option in your WordPress settings menu
  2. Enter your OpenAI API key
  3. Save the settings
  4. Test the connection using the provided test button

Usage

Individual Images

  1. Open any image in your Media Library
  2. Look for the "Generate Alternative Text with AI" button
  3. Click the button to generate alt text
  4. Review and save the generated text

Best Practices

  • Always review generated alt text before saving
  • Consider manual adjustments for brand-specific terminology
  • Monitor API usage through the dashboard
  • Use bulk processing for large image libraries

Configuration

Available Settings

  • API Key management
  • Rate limiting controls
  • Default alt text prompt templates
  • Processing preferences

Advanced Options

  • Custom API endpoints
  • Error logging preferences
  • Backup settings

Technical Requirements

  • WordPress 5.0 or higher
  • PHP 7.4 or higher
  • Active OpenAI API key
  • Valid SSL certificate

Contributing

We welcome contributions to improve WP Auto Alt Text!

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Open a Pull Request

Support

  • Create an issue in the GitHub repository

License

This project is licensed under the Apache License v2.0 or later - see the LICENSE file for details.

Changelog

Yet to come...

Credits

  • Developed by Kim Branzell
  • Powered by OpenAI's API
  • Special thanks to all contributors

About

A WordPress plugin that generates an alt text on upload, or when editing existing images. Uses GPT-4o to understand and analyze the images.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published