Abilities Reference
Advanced Media Offloader adds nine abilities to the WordPress Abilities API. This page lists them, explains their results, and shows their limits.
Available abilities
All abilities are in the advmo-media category.
Abilities that only read data
These change nothing on your site.
advmo/get-status— Shows the selected provider, main settings, media counts, and the last connection test.advmo/get-attachment-status— Shows the offload status of 1–50 files: cloud location, URL, offload date, and errors.advmo/list-offload-errors— Lists files with offload errors. 20 per page by default, up to 100.advmo/get-bulk-offload-status— Shows the current or last bulk offload: status, run ID, progress, and errors.
Abilities that take action
advmo/test-connection— Tests access to your saved cloud storage and saves the result. It changes nothing else.advmo/offload-attachments— Offloads 1–20 files right away. Follows your retention policy.advmo/reoffload-attachments— Uploads 1–20 offloaded files again from their local copies and replaces their cloud copies.advmo/start-bulk-offload— Starts a bulk offload, or returns the run already in progress.advmo/cancel-bulk-offload— Cancels a bulk offload by its run ID. The remaining work stops.
Safety and permissions
- Only administrators can use these abilities. Abilities that work with specific files also check that you can edit each file. Offloading and re-offloading also need permission to upload files.
- Abilities always use your saved provider, bucket, and settings. A request cannot change the provider, bucket, path, credentials, or retention policy.
- No ability changes your settings or deletes media.
- Results do not include your access keys. Error messages hide saved credentials and your server path.
- Offloading follows your retention policy, just like the Offload Now button. With Smart Local Cleanup or Full Cloud Migration, local copies are removed after upload.
- Cancelling a bulk offload does not undo finished uploads or bring back local files.
Offload and re-offload results
A valid request returns one result for each file, in the order you sent them. A successful request does not mean every file worked. Check the status of each file:
offloaded— The file was uploaded and recorded as offloaded.reoffloaded— The file was uploaded again and its cloud copies were replaced.already_offloaded— The file was already offloaded. Nothing was done.cleanup_pending— The upload is done. Removing local copies under your retention policy is still waiting to finish.skipped— Nothing was uploaded. Checkcodeandmessagefor the reason.failed— Something went wrong. Some cloud files may already have changed.
If any file ID is invalid, or you cannot edit one of the files, the whole request fails and nothing is uploaded. A failed result is not rolled back. Use advmo/get-attachment-status to check the saved state and errors before you try again.
Bulk offload status
idle— No bulk offload is running or recorded.starting— The run is being set up.processing— Files are being offloaded.paused— The run stopped because of a problem with the saved settings or the destination. Fix the problem, then start again to resume.cancelling— Cancel was requested. The current upload may finish first.completed— The run finished.cancelled— The run was cancelled.
An interrupted run can also report timeout_cleanup, recovered_from_stall, or unknown. Check the Media Overview page, then start a new bulk offload if needed.
- Keep the
run_idfrom the start response. You need it to cancel. An oldrun_idcannot cancel a newer run. - Starting again while a run is active returns the same run with
"already_running": true. - After you cancel, wait for
cancelledbefore you start new work.
Good to know
- Status and counts come from what the plugin recorded. They do not check that files still exist in the cloud.
- The saved connection test is history, not a live check. Run
advmo/test-connectionfor a fresh result. - The connection test checks access to your bucket. It does not test uploads, deletes, or public delivery.
Limits
- Offload and re-offload: up to 20 files per request, 25 MB per main file, and 150 MB of main files per request. No new file starts after 20 seconds. The request runs right away, not in the background.
- Bulk offload: up to 50 files per run, with the same size limits as the Media Overview page.
- Re-offload needs the local file. It cannot bring back missing local files. The recorded provider and bucket must match your current settings, so it is not a tool for moving files to another bucket.
- Large libraries: use the WP-CLI command
wp advmo offload. Learn more.
Related
Need More Help?
Can't find what you're looking for? We're here to help!