Dashboard Card API Reference

Card ID rules

  • Lowercase letters, numbers, underscore, hyphen (sanitize_key)
  • Globally unique

Registration arguments

KeyTypeDefaultDescription
titlestringidPicker title
descriptionstring''Picker subtitle
iconstringdashicons-admin-genericDashicons class
rendercallablerequired( string $card_id, array $card ) — echo HTML
enqueuecallableoptional( string $card_id ) — enqueue assets
capabilitystringreadMinimum capability
placementsstring[]main, asideAllowed columns
priorityint10Catalog sort (lower first)
categorystring''Picker grouping
builtinboolfalseTheme/core — shows Included

Functions

FunctionPurpose
yooadmin_register_dashboard_card( $id, $args )Register
yooadmin_unregister_dashboard_card( $id )Remove
yooadmin_is_dashboard_card( $id )Exists check
yooadmin_get_dashboard_cards()All registered
yooadmin_get_dashboard_cards_catalog()Picker rows
yooadmin_render_dashboard_card( $id )Render HTML
yooadmin_capture_dashboard_card_assets( $id )Styles/scripts for AJAX inject

Hooks

HookWhen
yooadmin_dashboard_cards_initRegister here (init priority 15)
yooadmin_register_dashboard_cardFilter args before storage
yooadmin_dashboard_cards_catalogFilter picker catalog
yooadmin_studio_hub_dashboard_widgets_catalogStudio Hub catalog filter
yooadmin_dashboard_slugFilter dashboard page slug
yooadmin-studio-hub-widget-renderedJS event after AJAX render

Render flow

  1. User adds card from catalog
  2. Section created with data-widget-id
  3. HTML via admin-ajax or REST yooadmin/v1/studio-hub/widgets/{id}/render
  4. enqueue then render; assets captured for injection
  5. Client fires yooadmin-studio-hub-widget-rendered

Built-in sidebar cards cannot be duplicated. Empty render shows: "This dashboard card returned no content."

Support: support@yooadmin.io — subject Studio Hub dashboard card

Was this article helpful?

Help us improve this article

By submitting this form you agree to our Privacy Policy