چرا API شما در دسترس همه است؟ راهنمای تخصصی register_rest_route

چرا endpoint سفارشی یک نیاز جدی است؟

تابع register_rest_route چیست؟

امضای تابع و پارامترها

function register_rest_route( $route_namespace, $route, $args = array(), $override = false ) {
    // ...
}

هوک rest_api_init و زمان ثبت

add_action( 'rest_api_init', 'myplugin_register_routes' );
function myplugin_register_routes() {
    register_rest_route(
        'myplugin/v1',
        '/items',
        array(
            'methods'             => 'GET',
            'callback'            => 'myplugin_get_items',
            'permission_callback' => '__return_true',
        )
    );
}

namespace و مسیردهی

آرگومان‌های args و اعتبارسنجی

'args' => array(
    'id' => array(
        'required'          => true,
        'validate_callback' => function( $param ) {
            return is_numeric( $param ) && $param > 0;
        },
        'sanitize_callback' => 'absint',
    ),
    'title' => array(
        'required'          => true,
        'type'              => 'string',
        'sanitize_callback' => 'sanitize_text_field',
    ),
),

permission_callback و کنترل دسترسی

'permission_callback' => '__return_true',

'permission_callback' => function() {
    return is_user_logged_in();
},

'permission_callback' => function() {
    return current_user_can( 'manage_options' );
},

'permission_callback' => function( $request ) {
    if ( ! is_user_logged_in() ) {
        return new WP_Error( 'rest_forbidden', 'ابتدا وارد شوید', array( 'status' => 401 ) );
    }

    if ( ! current_user_can( 'edit_posts' ) ) {
        return new WP_Error( 'rest_forbidden', 'دسترسی غیرمجاز', array( 'status' => 403 ) );
    }

    return true;
},

کاربردهای عملی در افزونه

add_action( 'rest_api_init', 'myplugin_register_settings_route' );
function myplugin_register_settings_route() {
    register_rest_route(
        'myplugin/v1',
        '/settings',
        array(
            array(
                'methods'             => 'GET',
                'callback'            => 'myplugin_get_settings_route',
                'permission_callback' => function() {
                    return current_user_can( 'manage_options' );
                },
            ),
            array(
                'methods'             => 'POST',
                'callback'            => 'myplugin_update_settings_route',
                'permission_callback' => function() {
                    return current_user_can( 'manage_options' );
                },
                'args' => array(
                    'enabled' => array(
                        'required'          => true,
                        'type'              => 'boolean',
                        'sanitize_callback' => 'rest_sanitize_boolean',
                    ),
                    'threshold' => array(
                        'required'          => false,
                        'type'              => 'integer',
                        'validate_callback' => function( $param ) {
                            return is_numeric( $param ) && $param >= 0 && $param <= 100;
                        },
                        'sanitize_callback' => 'absint',
                    ),
                ),
            ),
        )
    );
}

function myplugin_get_settings_route() {
    return rest_ensure_response( array(
        'enabled'   => (bool) get_option( 'myplugin_enabled', true ),
        'threshold' => (int) get_option( 'myplugin_threshold', 50 ),
    ) );
}

function myplugin_update_settings_route( WP_REST_Request $request ) {
    update_option( 'myplugin_enabled', (bool) $request->get_param( 'enabled' ) );
    update_option( 'myplugin_threshold', (int) $request->get_param( 'threshold' ) );

    return rest_ensure_response( array( 'updated' => true ) );
}

نکات امنیتی و اشتباهات رایج

تحلیل فنی پیشرفته

پرسش‌های پرتکرار

ادامه مسیر