claudeus-wp-mcp/dist/api/widgets.d.ts

The most comprehensive WordPress MCP server - 145 production-ready tools for complete WordPress management with AI

/**
 * WordPress Widgets & Sidebars API Client
 * Handles widget and sidebar management operations
 */
import { BaseApiClient } from './base-client.js';
import { Sidebar, Widget, WidgetData, SidebarFilters, WidgetFilters } from '../types/widget.js';
export declare class WidgetsApiClient extends BaseApiClient {
    /**
     * Get all registered sidebars
     * @param filters Optional filters
     */
    getSidebars(filters?: SidebarFilters): Promise<Sidebar[]>;
    /**
     * Get a specific sidebar by ID
     * @param id Sidebar ID
     */
    getSidebar(id: string): Promise<Sidebar>;
    /**
     * Update a sidebar (replace all widgets)
     * @param id Sidebar ID
     * @param widgets Array of widget IDs to place in sidebar
     */
    updateSidebar(id: string, widgets: string[]): Promise<Sidebar>;
    /**
     * Get all widgets
     * @param filters Optional filters (sidebar, context)
     */
    getWidgets(filters?: WidgetFilters): Promise<Widget[]>;
    /**
     * Get a specific widget by ID
     * @param id Widget ID
     */
    getWidget(id: string): Promise<Widget>;
    /**
     * Create a new widget
     * @param data Widget data (id_base, sidebar, instance)
     */
    createWidget(data: WidgetData): Promise<Widget>;
    /**
     * Update an existing widget
     * @param id Widget ID
     * @param data Widget data to update
     */
    updateWidget(id: string, data: Partial<WidgetData>): Promise<Widget>;
    /**
     * Delete a widget
     * @param id Widget ID
     * @param force Whether to force delete (bypass trash)
     */
    deleteWidget(id: string, force?: boolean): Promise<{
        deleted: boolean;
        previous: Widget;
    }>;
}