چرا پاسخ REST API شما ناقص است؟ راهنمای تخصصی register_rest_field

چرا فیلد سفارشی در REST API یک نیاز جدی است؟

تابع register_rest_field چیست؟

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

function register_rest_field( $object_type, $attribute, $args = array() ) {
    // ...
}

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

add_action( 'rest_api_init', 'myplugin_register_rest_fields' );
function myplugin_register_rest_fields() {
    register_rest_field( 'post', 'myplugin_featured', array(
        'get_callback'    => 'myplugin_get_featured_field',
        'update_callback' => 'myplugin_update_featured_field',
        'schema'          => array(
            'description' => 'آیا این نوشته ویژه است',
            'type'        => 'boolean',
            'context'     => array( 'view', 'edit' ),
        ),
    ) );
}

get_callback و update_callback

function myplugin_get_featured_field( $object, $field_name, $request ) {
    $post_id = absint( $object['id'] );
    $value = get_post_meta( $post_id, '_myplugin_featured', true );

    return (bool) $value;
}

function myplugin_update_featured_field( $value, $object, $field_name, $request ) {
    $post_id = absint( $object['id'] );

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

    update_post_meta( $post_id, '_myplugin_featured', (bool) $value );

    return true;
}

schema و مستندسازی فیلد

'schema' => array(
    'description' => 'قیمت محصول به تومان',
    'type'        => 'integer',
    'minimum'     => 0,
    'context'     => array( 'view', 'edit' ),
    'arg_options' => array(
        'sanitize_callback' => 'absint',
    ),
),

permission_callback برای ویرایش

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

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

add_action( 'rest_api_init', 'myplugin_register_product_fields' );
function myplugin_register_product_fields() {
    register_rest_field( 'product', 'price', array(
        'get_callback'    => function( $object ) {
            return (int) get_post_meta( $object['id'], '_myplugin_price', true );
        },
        'update_callback' => function( $value, $object ) {
            if ( ! current_user_can( 'edit_post', $object['id'] ) ) {
                return new WP_Error( 'rest_cannot_edit', 'دسترسی غیرمجاز', array( 'status' => 403 ) );
            }
            update_post_meta( $object['id'], '_myplugin_price', absint( $value ) );
            return true;
        },
        'schema'          => array(
            'description' => 'قیمت محصول به تومان',
            'type'        => 'integer',
            'minimum'     => 0,
            'context'     => array( 'view', 'edit' ),
        ),
    ) );
}

register_rest_field( 'user', 'myplugin_phone', array(
    'get_callback'    => function( $user ) {
        $current_user_id = get_current_user_id();

        if ( $current_user_id !== (int) $user['id'] && ! current_user_can( 'list_users' ) ) {
            return null;
        }

        return get_user_meta( $user['id'], 'myplugin_phone', true );
    },
    'update_callback' => function( $value, $user ) {
        $current_user_id = get_current_user_id();

        if ( $current_user_id !== (int) $user['id'] && ! current_user_can( 'edit_users' ) ) {
            return new WP_Error( 'rest_cannot_edit', 'دسترسی غیرمجاز', array( 'status' => 403 ) );
        }

        update_user_meta( $user['id'], 'myplugin_phone', sanitize_text_field( $value ) );
        return true;
    },
    'schema'          => array(
        'description' => 'شماره تلفن کاربر',
        'type'        => 'string',
        'context'     => array( 'view', 'edit' ),
    ),
) );

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

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

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

ادامه مسیر