Pro module32 abilities
Meta Box ability reference
Reference for the GoBuildWP Pro 1.12.4 source. Installed schemas and policy remain authoritative.
This Meta Box ability reference lists every call GoBuildWP Pro registers for Meta Box fields, relationships and settings pages, with the exact slug an agent sends and what the plugin's own contract says it does. Of the 32, 14 read, 10 write and 8 are marked destructive in the source.
Read-only, write and destructive groups describe the source annotations. They do not establish a minimum safety profile, human approval or undo support. Those controls are separate: check the installed ability, the connected user and the active site policy before calling it. A read can still return sensitive data. These pages are not evidence that every operation passed an end-to-end runtime test.
What Meta Box needs before these load
These 32 abilities come with GoBuildWP Pro 1.12.4. Pro registration requires the Freemius SDK to permit premium code and any companion dependency the module checks to be available. The floors below apply to the named dependencies or features; an optional add-on or newer feature floor does not necessarily disable the base module. wppilot/integration-health and the module's setup call describe the installed availability.
- Minimum (base)
- 5.11.2
WPPILOT_PRO_METABOX_MIN_VERSION - Meta Box editions
- free, pro
- Agent skills shipped
metabox-integration,content-model-schema,content-model-migration,dynamic-data-binding
Meta Box reads
| Ability | What it does |
|---|---|
wppilot/metabox-check-setupCheck Meta Box Setup | Reports the Meta Box environment: whether the core is active, the version, whether the minimum version is satisfied, which extensions are loaded (builder, cpt, settings page, relationships, term meta, comment meta, user meta, group field, custom table), and counts of field groups split by source (php-registered vs db-stored). Call BEFORE any other Meta Box ability - each *_active flag gates a specific ability group. |
wppilot/metabox-get-field-group-schemaGet Meta Box Field Group Schema | Returns the schema of a single Meta Box field group identified by key. By default returns identity (key, title, source, post_types, context, priority) plus field_count - pass include_fields=true to inflate the fields[] array. Works for both PHP-registered and DB-stored groups. Use key from metabox-list-field-groups. |
wppilot/metabox-get-field-type-schemaGet Meta Box Field Type Schema | Returns the option matrix for a single Meta Box field type. Call this before creating or editing a field to understand which settings are supported. Pass field_type as one of: text, textarea, wysiwyg, image, file, single_image, file_upload, image_upload, date, color, taxonomy, post, user, group, switch, checkbox, checkbox_list, radio, select, select_advanced, number, range, slider, password, email, url, hidden, autocomplete, time, datetime, week, month, oembed, button, key_value, custom_html, divider, heading, map, osm, sidebar, fieldset_text. Returns name, description, and an options object describing each supported key with its type, description, and default. |
wppilot/metabox-get-post-typeGet Meta Box Post Type | Returns the full settings payload for a single MB Custom Post Type entry identified by slug. The payload mirrors the MB CPT internal format (slug, labels, public, hierarchical, supports, taxonomies, menu_icon, etc.) and can be used as a reference for metabox-edit-post-type. |
wppilot/metabox-get-relationshipGet Meta Box Relationship | Returns the full settings for a single MB Relationships definition identified by id. The payload includes from/to configuration (object_type, post_types, empty_message, meta_box settings), source (this reader always reports php, because every relationship is registered at runtime through MB_Relationships_API::register() - including one the relationships builder stores in the database, which create/edit report as source db). Pass include_objects=true to get the first page of connected object pairs (delegated to metabox-list-connected-objects internally). |
wppilot/metabox-get-settings-pageGet Meta Box Settings Page | Returns the full settings for a single MB Settings Page entry identified by id. The payload includes id, menu_title, page_title, option_name, parent, capability, icon_url, position, style, columns, source (php|db). Use id with metabox-read-values (target.type=settings, target.id=<id>) to read the stored option values. |
wppilot/metabox-get-taxonomyGet Meta Box Taxonomy | Returns the full settings payload for a single custom taxonomy registered via MB Custom Post Type, identified by slug. The payload mirrors the MB CPT internal format (slug, labels, hierarchical, object_type, public, etc.) and can be used as a reference for metabox-edit-taxonomy. |
wppilot/metabox-list-connected-objectsList Meta Box Connected Objects | Returns a paginated list of objects connected via an MB Relationships type. Pass relationship_id plus one of from_id or to_id to query from/to connections; or pass both to check if a specific pair is connected. Results include object IDs (and post titles for posts). Pagination: limit (default 25, max 200) and offset. |
wppilot/metabox-list-field-groupsList Meta Box Field Groups | Returns a lightweight overview of all Meta Box field groups from both PHP-registered and DB-stored (MB Builder) sources: key, title, source (php|db), post_types the group applies to, and field_count. Use to discover available groups before calling metabox-get-field-group-schema for the full schema. Accepts an optional post_type filter. |
wppilot/metabox-list-post-typesList Meta Box Post Types | Returns a lightweight overview of all post types registered via MB Custom Post Type: slug, title, source (db), public flag, hierarchical flag, menu_icon, and active flag. Use to discover available post types before calling metabox-get-post-type for the full payload. |
wppilot/metabox-list-relationshipsList Meta Box Relationships | Returns a lightweight overview of all registered MB Relationships definitions: id, from (object type and post types), to (object type and post types), source (always reported as php, since every relationship is registered at runtime via MB_Relationships_API::register(); one the relationships builder saved is still stored in the database - see metabox-create-relationship). Use id with metabox-get-relationship for the full settings payload. |
wppilot/metabox-list-settings-pagesList Meta Box Settings Pages | Returns a lightweight overview of all settings pages registered via MB Settings Page: id, menu_title, page_title, source (php|db), option_name, parent (parent page id if any). Use id with metabox-get-settings-page for the full payload. |
wppilot/metabox-list-taxonomiesList Meta Box Taxonomies | Returns a lightweight overview of all custom taxonomies registered via MB Custom Post Type: slug, title, source (db), object_type (array of post types the taxonomy applies to), hierarchical flag. Use slug with metabox-get-taxonomy for the full payload. |
wppilot/metabox-read-valuesRead Meta Box Values | Reads Meta Box field values from any target: post (target.type=post, target.id=<post_id>), term (type=term, id=<term_id>), user (type=user, id=<user_id>), comment (type=comment, id=<comment_id>), or settings page (type=settings, id=<settings_page_slug>). Pass fields[] to read specific field IDs; omit to read all Meta Box metadata on the target. Returns a values map keyed by field ID. |
Meta Box writes
| Ability | What it does |
|---|---|
wppilot/metabox-connect-objectsConnect Meta Box Objects | Creates a connection between two objects via an MB Relationships type. Pass relationship_id, from_id (the origin object ID), and to_id (the destination object ID). The connection is persistent (written to the MB relationships table). Calling this on an already-connected pair is a no-op (idempotent). |
wppilot/metabox-create-field-groupCreate Meta Box Field Group | Creates a new Meta Box field group stored in the database (MB Builder). Requires MB Builder to be active (metabox-check-setup builder_active=true). Pass key (used as post_name and as the id in the field group config), title, post_types[], and fields[]. Each field must have at minimum an id and a type. Returns the new DB post ID and key. Source will always be "db". |
wppilot/metabox-create-post-typeCreate Meta Box Post Type | Creates a new post type via MB Custom Post Type. Required: slug (also accepted as post_type, WordPress-native alias for slug) and title (also accepted as singular_name). Optional: labels (name, singular_name, etc.), public (default true), hierarchical (default false), supports (array of feature strings), menu_icon, rewrite (object), show_in_rest (default true), taxonomies (array). Reserved slugs (post, page, meta-box, mb-post-type, mb-taxonomy, mb-settings-page, mb-relationship) are rejected. Rewrite rules are soft-flushed on create/edit/delete, so the new URLs resolve from the NEXT request; on CDN/edge-cached sites a 404 fetched before that may linger in cache until purged. |
wppilot/metabox-create-relationshipCreate Meta Box Relationship | Creates an MB Relationships type. When the MB Relationships builder is active (the mb-relationship CPT, shipped with Meta Box AIO / MB Core) the relationship is persisted as a published mb-relationship post - editable under Meta Box and re-registered every request - like the other metabox-create-* abilities; the response carries source:"db" plus db_post_id. On the free, API-only MB Relationships it falls back to an in-memory register for the current request only (source:"php" plus persistence_warning). Required: id, from, to. from/to take a post type slug or {object_type: post|term|user, post_type/taxonomy}. Optional: reciprocal, label_from, label_to. |
wppilot/metabox-create-settings-pageCreate Meta Box Settings Page | Creates a new settings page via MB Settings Page (stored in the mb-settings-page CPT). Required: id (unique page identifier used as slug and option_name unless overridden), menu_title. Optional: page_title, option_name, parent (parent page id), capability (default edit_theme_options), icon_url, position, style (boxes|no-boxes), columns (1 or 2). The settings page values are readable via metabox-read-values with target.type=settings and target.id=<id>. |
wppilot/metabox-create-taxonomyCreate Meta Box Taxonomy | Creates a new custom taxonomy via MB Custom Post Type. Required: slug (also accepted as taxonomy, WordPress-native alias) and title (also accepted as singular_name). Optional: object_type (array of post type slugs to attach to), hierarchical (default false), public (default true), show_in_rest (default true), labels, rewrite. Rewrite rules are soft-flushed on create/edit/delete, so the new URLs resolve from the NEXT request; on CDN/edge-cached sites a 404 fetched before that may linger in cache until purged. |
wppilot/metabox-edit-post-typeEdit Meta Box Post Type | Edits an existing MB Custom Post Type entry. Required: slug (or post_type as alias) to identify the record. All other fields follow PATCH semantics - omitted keys are preserved. Changing the slug renames the post type but does NOT migrate existing posts. |
wppilot/metabox-edit-relationshipEdit Meta Box Relationship | Edits an existing MB Relationships type. When the relationships builder is active this patches the DB-backed mb-relationship post in place (source:"db"); on the free API-only build it re-registers in memory for the current request (source:"php"). Supply only the fields to change: from, to, reciprocal, label_from, label_to. |
wppilot/metabox-edit-settings-pageEdit Meta Box Settings Page | Edits an existing DB-stored MB Settings Page. Required: id to identify the record. All other fields follow PATCH semantics. PHP-registered settings pages return metabox_php_registered. |
wppilot/metabox-edit-taxonomyEdit Meta Box Taxonomy | Edits an existing MB Custom Post Type taxonomy. Required: slug (or taxonomy alias) to identify the record. All other fields follow PATCH semantics - omitted keys are preserved. |
Destructive Meta Box calls
| Ability | What it does |
|---|---|
wppilot/metabox-delete-field-groupDelete Meta Box Field Group | Permanently deletes a DB-stored Meta Box field group. PHP-registered groups cannot be deleted (returns metabox_php_registered). Values previously stored under fields of this group remain in postmeta but become orphaned. Requires MB Builder. |
wppilot/metabox-delete-post-typeDelete Meta Box Post Type | Permanently deletes an MB Custom Post Type entry. Pass force=true to delete even when posts of that type exist (posts are orphaned in the database with the old post_type value). Idempotent: deleting a non-existent slug returns deleted=false. |
wppilot/metabox-delete-relationshipDelete Meta Box Relationship | Permanently deletes all connections for an MB Relationships type. When the builder is active it also deletes the DB-backed mb-relationship post, so the type is fully gone (php_cleanup_required is empty). On the free API-only build the definition is PHP-registered, so php_cleanup_required tells you to remove the register() call from your code. |
wppilot/metabox-delete-settings-pageDelete Meta Box Settings Page | Permanently deletes a DB-stored MB Settings Page. The WP option storing field values is NOT deleted - it remains in wp_options as an orphan. PHP-registered pages return metabox_php_registered. |
wppilot/metabox-delete-taxonomyDelete Meta Box Taxonomy | Permanently deletes an MB Custom Post Type taxonomy. Pass force=true to delete even when terms exist under that taxonomy. Idempotent: deleting a non-existent slug returns deleted=false. |
wppilot/metabox-disconnect-objectsDisconnect Meta Box Objects | Removes a connection between two objects in an MB Relationships type. Pass relationship_id, from_id, and to_id. Idempotent: disconnecting a pair that is not currently connected returns disconnected=false without error. |
wppilot/metabox-edit-field-groupEdit Meta Box Field Group | Edits an existing DB-stored Meta Box field group. Only DB-source field groups can be edited (PHP-registered groups return metabox_php_registered). PATCH semantics: top-level keys you omit are preserved; the fields[] array follows REPLACE semantics - any field not in the payload is removed. Requires MB Builder to be active. |
wppilot/metabox-write-valuesWrite Meta Box Values | Writes a batch of Meta Box field values to a target (post, term, user, comment, or settings page). Pass target with type and id, and a values map keyed by field ID. For settings targets pass type=settings and id=<settings_page_slug>. Each value is written via rwmb_set_meta() for posts, or the appropriate meta update function for other object types. Optionally pass field_group_key (same as metabox-read-values) to fail fast when a values key does not belong to that group. Returns a results array with per-field status. |
For the task-level view of Meta Box, with worked requests and what to check afterwards, see Meta Box integration page.