---
title: "Get Bulk Image Optimizer Status Ability: Read Image Optimization Stats in WordPress"
url: https://nexterwp.com/docs/nexter-ability-get-bulk-image-optimizer-status/
date: 2026-05-29
modified: 2026-05-29
author: "sandip patel"
description: "The nexter/get-bulk-image-optimizer-status ability returns image optimization stats, monthly usage, and a queue of unoptimized attachments from Nexter Extension."
word_count: 462
---

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

## 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.

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 > 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)