آشنایی با کلاس WP_REST_Request و متد set_body()
سلام! امروز میخواهیم درباره یکی از کلاسهای مهم در WordPress به نام WP_REST_Request
صحبت کنیم. به طور کلی، این کلاس به ما اجازه میدهد که درخواستهای REST API را مدیریت کنیم. با استفاده از این کلاس، میتوانیم به راحتی دادهها را ارسال و دریافت کنیم.
متد set_body()
در این کلاس وجود دارد که برای مشخص کردن بدنه یک درخواست استفاده میشود. این بدنه میتواند شامل دادههایی باشد که میخواهیم در درخواست ارسال کنیم. به عنوان مثال، زمانی که دادهای را به سرور ارسال میکنیم، بدنه درخواست حاوی اطلاعاتی است که در آن وجود دارد.
استفاده از این متد در زمانی کاربرد دارد که شما نیاز دارید تا اطلاعات خاصی را در زمان ارسال درخواست به سرور همراه با آن ارسال کنید. این اطلاعات معمولاً به صورت JSON فرمت میشوند. بنابراین، هر زمان که احساس کردید که باید دادهای را به API ارسال کنید، میتوانید از set_body()
استفاده کنید.
در ادامه، یک مثال ساده برای شما میآوریم که چگونه میتوانید از set_body()
استفاده کنید. این مثال، در واقع نشان میدهد که چطور میتوانیم یک درخواست جدید بسازیم و بدنه آن را تنظیم کنیم.
مثال کد برای استفاده از متد set_body()
$request = new WP_REST_Request();
$request->set_body( json_encode( [ 'key' => 'value' ] ) );
توضیح خط به خط کد
خط 1:
$request = new WP_REST_Request();
این خط یک نمونه جدید از کلاس
WP_REST_Request
ایجاد میکند که به ما امکان میدهد یک درخواست جدید بسازیم.خط 2:
$request->set_body( json_encode( [ 'key' => 'value' ] ) );
در این خط، ما بدنه درخواست را با استفاده از متد
set_body()
تنظیم میکنیم. دادهها به فرمت JSON تبدیل میشوند تا به طور صحیح ارسال شوند.