API & CLI

fetch( '/wp-json/apd/v1/favorites', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'X-WP-Nonce': wpApiSettings.nonce,
    },
    body: JSON.stringify( { listing_id: 42 } ),
} );

# Public GET — no authentication needed
curl https://example.com/wp-json/apd/v1/listings

# Authenticated GET — pass WordPress auth cookie
curl https://example.com/wp-json/apd/v1/favorites \
  -b wordpress_logged_in_xxx=COOKIE_VALUE

# State-changing POST — cookie + X-WP-Nonce required
curl -X POST https://example.com/wp-json/apd/v1/favorites \
  -b wordpress_logged_in_xxx=COOKIE_VALUE \
  -H "X-WP-Nonce: NONCE_VALUE" \
  -H "Content-Type: application/json" \
  -d '{"listing_id": 42}'

add_action( 'apd_register_rest_routes', function( $controller ) {
    // Read-only private endpoint (auth required, no nonce)
    register_rest_route( 'apd/v1', '/custom', [
        'methods'             => 'GET',
        'callback'            => 'my_custom_read',
        'permission_callback' => [ $controller, 'permission_authenticated' ],
    ] );

    // Write endpoint (auth + nonce required)
    register_rest_route( 'apd/v1', '/custom', [
        'methods'             => 'POST',
        'callback'            => 'my_custom_write',
        'permission_callback' => [ $controller, 'permission_authenticated_with_nonce' ],
    ] );
} );

function my_custom_read( WP_REST_Request $request ) {
    return apd_rest_response( [ 'data' => 'value' ] );
}

function my_custom_write( WP_REST_Request $request ) {
    // Safe to mutate state — nonce already verified
    return apd_rest_response( [ 'created' => true ], 201 );
}

// Success response
return apd_rest_response( $data, 200, $headers );

// Error response
return apd_rest_error( 'error_code', 'Error message', 400 );

// Paginated response
return apd_rest_paginated_response( $items, $total, $page, $per_page );

apd_get_listing_field( $listing_id, $field_name, $default );
apd_set_listing_field( $listing_id, $field_name, $value );
apd_get_listing_views( $listing_id );
apd_increment_listing_views( $listing_id );
apd_get_related_listings( $listing_id, $limit, $args );

apd_get_listing_categories( $listing_id );
apd_get_listing_tags( $listing_id );
apd_get_category_listings( $category_id, $args );
apd_get_categories_with_count( $args );
apd_get_category_icon( $category );
apd_get_category_color( $category );

apd_add_favorite( $listing_id, $user_id );
apd_remove_favorite( $listing_id, $user_id );
apd_toggle_favorite( $listing_id, $user_id );
apd_is_favorite( $listing_id, $user_id );
apd_get_user_favorites( $user_id );
apd_get_favorites_count( $user_id );
apd_get_listing_favorites_count( $listing_id );

apd_get_listing_reviews( $listing_id, $args );
apd_get_listing_rating( $listing_id );
apd_get_listing_review_count( $listing_id );
apd_create_review( $listing_id, $data );
apd_update_review( $review_id, $data );
apd_delete_review( $review_id );
apd_current_user_has_reviewed( $listing_id );

apd_get_setting( $key, $default );
apd_set_setting( $key, $value );
apd_get_all_settings();
apd_reviews_enabled();
apd_favorites_enabled();
apd_contact_form_enabled();
apd_format_price( $amount );

apd_get_template( $template, $args );
apd_get_template_part( $slug, $name, $args );
apd_get_template_html( $template, $args );
apd_template_exists( $template );
apd_locate_template( $template );

apd_cache_remember( $key, $callback, $expiration );
apd_cache_get( $key );
apd_cache_set( $key, $value, $expiration );
apd_cache_delete( $key );
apd_cache_clear_all();

# Generate all demo data with default quantities
wp apd demo generate

# Generate with custom quantities
wp apd demo generate --users=10 --listings=50

# Generate only specific data types
wp apd demo generate --types=categories,tags,listings

# Show current demo data counts
wp apd demo status

# Show counts as JSON
wp apd demo status --format=json

# Delete all demo data (with confirmation)
wp apd demo delete

# Delete without confirmation prompt
wp apd demo delete --yes

// Register a module with array configuration
apd_register_module( $slug, $config );

// Register a class-based module (implements ModuleInterface)
apd_register_module_class( $module );

// Unregister a module
apd_unregister_module( $slug );

// Get a registered module by slug
apd_get_module( $slug );

// Get all registered modules (supports orderby, order, feature args)
apd_get_modules( $args );

// Check if a module is registered
apd_has_module( $slug );

// Get modules that support a specific feature
apd_get_modules_by_feature( $feature );

// Check if module requirements are met
apd_module_requirements_met( $requires );

/**
 * Plugin Name: My APD Module
 * Description: Custom module for DamDir Directory.
 * Requires Plugins: damdir-directory
 */

add_action( 'apd_modules_init', function() {
    apd_register_module( 'my-module', [
        'name'        => 'My Module',
        'description' => 'Adds custom functionality to APD.',
        'version'     => '1.0.0',
        'author'      => 'Your Name',
        'requires'    => [ 'core' => '1.0.0' ],
        'features'    => [ 'my_feature' ],
        'icon'        => 'dashicons-admin-generic',
    ] );
} );

use APD\Module\ModuleInterface;

class My_Module implements ModuleInterface {

    public function get_slug(): string {
        return 'my-module';
    }

    public function get_name(): string {
        return 'My Module';
    }

    public function get_description(): string {
        return 'Adds custom functionality to APD.';
    }

    public function get_version(): string {
        return '1.0.0';
    }

    public function get_config(): array {
        return [
            'requires' => [ 'core' => '1.0.0' ],
            'features' => [ 'my_feature' ],
            'icon'     => 'dashicons-admin-generic',
        ];
    }

    public function init(): void {
        // Hook into WordPress and APD actions/filters here.
    }
}

add_action( 'apd_modules_init', function() {
    apd_register_module_class( new My_Module() );
} );