API Documentation

Getting Started

The uiXpress plugin provides several extensible APIs that allow developers to integrate custom functionality. All APIs use a WordPress-style filter hook system for consistency and familiarity.

Available APIs

1. Dashboard Cards API

Create custom dashboard cards using Vue.js or React components.

• Dashboard Cards API - Complete guide to creating dashboard cards
• Location: docs/api/dashboard-cards-api.md
• Use Case: Add custom widgets, charts, or data displays to the dashboard
• Framework Support: Vue.js 3 and React (via veaury)
• Key Features:
  • 12-column grid system
  • Self-contained card components
  • Capability-based access control
  • Date range integration
  • Recursive groups

2. Sidebar Render API

Inject Vue or React components into the admin sidebar menu.

• Sidebar Render API - Guide to sidebar component injection
• Location: docs/api/sidebar-render-api.md
• Use Case: Add custom widgets, navigation, or content to the sidebar
• Framework Support: Vue.js 3 and React (via veaury)
• Key Features:
  • Pre-menu component injection
  • Post-menu component injection
  • Capability-based rendering
  • Event system for registration timing

3. Toolbar Render API

Inject Vue or React components into the admin toolbar.

• Toolbar Render API - Guide to toolbar component injection
• Location: docs/api/toolbar-render-api.md
• Use Case: Add custom buttons, widgets, or controls to the toolbar
• Framework Support: Vue.js 3 and React (via veaury)
• Key Features:
  • Left-side component injection
  • Right-side component injection
  • Modify or remove default components
  • Capability-based rendering

4. Global Search Quick Actions API

Register, modify, or remove quick actions from the global search interface.

• Quick Actions API - Guide to quick actions registration
• Location: docs/api/quick-actions-api.md
• Use Case: Add custom quick actions to the global search modal
• Framework Support: JavaScript (no framework required)
• Key Features:
  • Register custom actions
  • Modify existing actions
  • Remove actions
  • Priority-based ordering

5. User Details Components API

Create custom components for the user details view using Vue.js or React components.

• User Details Components API - Complete guide to creating user details components
• Location: docs/api/user-details-components-api.md
• Use Case: Add custom tabs, forms, or data displays to the user details view
• Framework Support: Vue.js 3 and React (via veaury)
• Key Features:
  • Tabbed interface organization
  • Self-contained components
  • Capability-based access control
  • Dynamic user data props
  • Category registration system

6. UiXpress Core Stop Filter

Control when UiXpress stops running using WordPress filter hooks.

• UiXpress Core Stop Filter - Guide to controlling UiXpress initialization
• Location: docs/api/uixpress-core-stop-filter.md
• Use Case: Disable UiXpress on specific pages, for certain users, or based on custom conditions
• Framework Support: PHP (WordPress filter hook)
• Key Features:
  • Programmatic control of UiXpress initialization
  • Context-aware stop conditions
  • Priority-based execution
  • WordPress filter hook system

API Overview

Common Patterns

Most uiXpress APIs follow similar patterns:

1. Filter Hook System: WordPress-style filter hooks (JavaScript addFilter or PHP add_filter)
2. Priority System: Control execution order with priority numbers
3. Component-Based: Vue.js or React components (where applicable)
4. Capability Checks: Built-in permission handling
5. Event System: Custom events for registration timing (JavaScript APIs)

Note: The UiXpress Should Bail Filter uses PHP's native add_filter() function, while most other APIs use JavaScript's addFilter() function.

Related Documentation

• Dashboard Features - Dashboard feature overview
• Global Search Features - Global search feature overview
• General Features - General plugin features

Getting Help

For questions or issues with the APIs:

1. Check the specific API documentation
2. Review the examples in each API guide
3. Check the troubleshooting sections
4. Review the best practices

API Reference Quick Links

• Dashboard Cards API
• Sidebar Render API
• Toolbar Render API
• Quick Actions API
• User Details Components API
• UiXpress Core Stop Filter