Get Bulk Image Optimizer Status Ability: Read Image Optimization Stats in WordPress

Updated On : May 29, 2026By : Reading Time : 2 minutes

Key Takeaways

  • nexter/get-bulk-image-optimizer-status returns total image counts, optimized and skipped counts, storage saved, monthly usage, and a batch of unoptimized attachments.
  • The limit parameter controls the number of unoptimized attachments returned, accepting values from 1 to 50 with a default of 6.
  • The ability is read-only and does not modify any images or settings; it returns enabled: false if the Image Optimization extension is disabled.
Table of Contents

The nexter/get-bulk-image-optimizer-status ability returns the current state of your Bulk Image Optimizer in WordPress. It reads total image counts, optimized and skipped counts, storage saved, monthly usage, and a batch of unoptimized attachments. This is a read-only ability — it does not change any settings or trigger any optimization. Use it to check progress or build automations around your image optimization workflow.

Key Takeaways

This is a read-only ability — it does not modify any images, files, or settings.

It returns the same data shown on the Media u0026gt; Bulk Images dashboard inside WordPress.

If the Image Optimization extension is disabled, the ability returns enabled: false instead of stats.

The limit parameter controls how many unoptimized attachments appear in the returned queue. The default is 6.

Use exclude_ids to paginate through the unoptimized queue across multiple calls without repeating results.

Required Setup

The Image Optimization extension must be enabled in Nexter Extension settings before this ability returns data. If it is off, the ability returns enabled: false. You can turn it on by calling nexter/update-image-optimization with enabled set to true.

Parameters

Both parameters are optional. The ability works without any input and returns the default 6-item queue.

limit (integer, optional) sets the maximum number of unoptimized attachments returned in the queue. Accepts values from 1 to 50. Defaults to 6.

exclude_ids (array of integers, optional) accepts a list of attachment IDs to skip in the queue. Pass the IDs from a previous call to move to the next batch of unoptimized images.

What It Returns

The ability returns an object with optimization stats, usage data, and a queue of unoptimized attachments ready for processing.

enabled (boolean) — false if the Image Optimization extension is off. All other fields are absent when this is false.

total (integer) — total number of images in your Media Library.

optimized (integer) — number of images that have been successfully optimized.

skipped (integer) — number of images skipped during optimization.

savings — total storage saved across all optimized images.

monthly_usage and monthly_limit — how many optimizations you have used this month and the cap for your current plan.

queue (array) — a list of unoptimized attachments, each with id, filename, original_size, and thumbnail_url.

When to Use This Ability

Check optimization progress before calling nexter/bulk-optimize-images to confirm there are unoptimized images waiting.

Build an automation that checks for unoptimized images and triggers a bulk compress only when the queue is not empty.

Monitor monthly usage to avoid hitting your plan limit before running large batch operations.

Paginate through all unoptimized images by passing returned IDs to exclude_ids on each subsequent call.

Related Documentation

nexter/bulk-optimize-images: Run bulk image compression on your WordPress Media Library (coming next)

nexter/update-image-optimization: Enable or configure the Image Optimization extension in Nexter Extension (coming next)

Bulk Image Optimizer Feature Guide: Activate and use the Bulk Image Optimizer inside WordPress (coming next)

About the Author

sandip patel

WordPress Developer at POSIMYTH Innovations I am a passionate WordPress Developer at POSIMYTH Innovations, where I focus on building high-performance products and cutting-edge web experiences. Currently, I contribute to the development of major projects including The Plus Addons for Elementor, Sticky Header for Elementor, RankReady AI (LLM & SEO), and the SproutOS MCP server integration. I love bridging the gap between WordPress core functionality and modern AI capabilities. Beyond standard development.

Share your Thoughts

Get Instant Answers to all your questions about Nexter Blocks,
Extensions & Theme trained on 1000+ Docs and Videos

Still in Doubt? Let’s Assist You

Raise a ticket Now

Have Feedback or Questions?

Join our WordPress Community on Facebook!

Join Us

Related Docs

Bulk Optimize Images Ability: Compress WordPress Media Library Images
icon
Content Protection for WordPress – Overview
icon
Create Code Snippet Ability: Add PHP CSS JS and HTML in WordPress
icon
Create Theme Builder Template Ability: Add Headers Footers and More in WordPress
icon
Delete Code Snippet Ability: Permanently Remove a Snippet in WordPress
icon
Delete Theme Builder Template Ability: Permanently Remove a Template in WordPress
icon
123……………………21