learndash/get-certificate-template fetches a certificate template: its post fields, its kind, its builder settings, and which courses, quizzes or groups use it.
It flags when the template has no background image.
At a glance
| Ability | learndash/get-certificate-template |
| Toolset | LearnDash — toolset/learndash |
| Group | LearnDash › Certificates |
| Requires | AcrossAI Pro, plus LearnDash LMS active on the site |
| Capability | manage_options |
| Safety | Read-only — changes nothing |
| Repeatable | Idempotent — running it twice leaves the same result |
| Ships in | AcrossAI Pro 0.9.16 and later |
How it works
Certificate Builder hard-fails at render time without a background image. A template without one does not produce a plain certificate — it produces an error, when a learner completes a course and tries to download it.
That is a failure that happens at the worst possible moment, to somebody who has just finished, and it is invisible until then.
So the flag is prominent. A template with no background is broken and should be treated as such.
The builder settings are page size, orientation, font and container width. Page size and orientation have to match the background image’s proportions or the result is stretched or cropped.
The font must be one the site actually has — learndash/list-certificate-fonts lists them, and an unrecognised key falls back silently to the default.
The usage list says what would be affected by changing or deleting this template.
Input
| Name | Type | Required | What it is |
|---|---|---|---|
certificate_id | integer | Yes | The template. |
What comes back
| Name | Type | What it is |
|---|---|---|
template | object | Post fields, kind and builder settings. |
has_background | boolean | False means the template will fail at render time. |
used_by | array | Courses, quizzes and groups using it. |
success | boolean | Whether the call completed. |
message | string | A one-line summary of what happened, suitable for showing a human. |
error_code | string | Present only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation. |
Example
Ask your assistant:
Is this certificate template usable?
It resolves to one call:
{
"ability": "learndash/get-certificate-template",
"parameters": {
"certificate_id": 810
}
}Worth knowing
- No background image means a render error, not a plain certificate.
- The failure happens when a learner tries to download, and not before.
- Page size and orientation must match the background proportions.
- An unrecognised font falls back silently.
Related abilities
- LearnDash Manage Certificate Template — fix it
- LearnDash List Certificate Fonts — the valid font keys
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category