نمایش زمینه های سفارشی در REST API وردپرس

نمایش زمینه های سفارشی در REST API با افزونه REST API Custom Fields

اگر تا به حال با قابلیت Rest API در وردپرس کار کرده باشید، شاید به این مشکل برخورد کرده باشید که زمینه های سفارشی در آن قرار نمی گیرند. در این آموزش نحوه  نمایش زمینه های سفارشی در REST API با افزونه REST API Custom Fields را به شما آموزش می دهیم.

در این آموزش مطالب زیر را بررسی خواهیم کرد:

1. REST API چیست ؟

2. چگونه در یک سایت وردپرس به REST API دسترسی داشته باشیم ؟

3. دانلود و نصب افزونه REST API Custom Fields

4. اضافه کردن زمینه های سفارشی به REST API

 

1. REST API چیست؟

اول معنی و مفهوم کلمه ی API را مشخص می کنیم:

API چیست؟

API مخفف عبارت Application Programming Interface است. API یک واسط کاربری بین دو برنامه ی دیگر است. به صورت ساده اگر قصد داشته باشیم میان وردپرس و برنامه اندروید ( مثلا اینستاگرام ) یک ارتباط برقرار کنیم، باید از یک برنامه سومی هم استفاده کنیم که بتواند اطلاعات را به خوبی میان این دو انتقال بدهد. به این برنامه سوم یا ثالث API می گوییم. در وردپرس از API ی استفاده می شود که بر اساس زبان جاوا اسکریپت می باشد و JSON نام دارد.

JSON چیست؟

مخفف عبارت JavaScript Object Notation می باشد. یک قالب ساده برای ذخیره و انتقال اطلاعات می باشد. JSON سبک و به سادگی قابل فهم می باشد.

اگر بخواهیم به یک مثال ساده از json اشاره کنیم، می توانیم کد زیر را مثال بزنیم:

{"firstName":"John", "lastName":"Doe"}

JSON به دلیل سادگی و سبک بودن به یکی از مشهورترین قالب ها برای API ها به کار می رود.

REST چیست؟

REST مخفف عبارت Representational State Transfer  و یک مدل طراحی برای API ها است که از پروتکل HTTP استفاده می کند.

حال که معنی REST ، JSON و API را مشخص کردیم…

WordPress REST API چیست؟

یک برنامه واسط در وردپرس است که اگر برنامه ای مانند یک اپلیکیشن اندروید قصد داشته باشد با وردپرس تعامل داشته باشد و ارتباط برقرار کند از این برنامه واسط استفاده می کند.

2. چگونه در یک سایت وردپرس به REST API دسترسی داشته باشیم ؟

حال که شما معنی و مفهوم WordPress REST API را یاد گرفتید اگر قصد داشته باشید با این API تعامل اشته باشید و از آن استفاده کنید، از طریق زیر به آن می توانید دسترسی داشته باشید:

آدرس سایت وردپرس خود را همراه با مقدار wp-json مانند زیر وارد کنید، به جای yoursite.com اسم سایت خود را قرار دهید:

سعی کنید از مرورگر فایرفاکس استفاده کنید.

http://yoursite.com/wp-json

به صفحه ای مانند زیر برخورد می کنید ( تصویر زیر مربوط به مرورگر فایرفاکس می باشد ) :

این صفحه فرمت مرتب JSON می باشد. اگر بر روی صفحه راست کلیک کنید و گزینه ی View Page Source را بزنید فرمت خطی JSON را خواهید دید.

برای این که به پست های سایت خود از طریق REST API دسترسی داشته باشید آدرس زیر را وارد کنید.

به جای yoursite.com آدرس سایت خود را وارد کنید:

http://yoursite.com/wp-json/wp/v2/posts

که با صفحه ی زیر روبه رو می شویم:

اگر قصد داشته باشیم اطلاعات یک نوشته خاص در وردپرس را مشاهده کنیم. کافی است با استفاده از id آن پست و آدرس زیر استفاده کنیم.

به جای yoursite.com و id آدرس سایت خود و id پستی که قصد مشاهده آن را دارید قرار بدهید:

http://yoursite.com/wp-json/wp/v2/posts/id

که نتیجه را در تصویر زیر می بینید، همان طور که می بینید تمام اطلاعات نوشته ی شما قابل مشاهده است:

اگر در سایت خود از زمینه های سفارشی بوسیله ی افزونه advanced custom fields و یا دیگر افزونه ها برای تولید زمینه های سفارشی استفاده می کنید. خواهید دید که این زمینه ها در اطلاعات پست قابل مشاهده نیست.

برای افزودن این زمینه ها به REST API به ادامه آموزش توجه کنید.

3. دانلود و نصب افزونه REST API Custom Fields

با استفاده از این افزونه می توانید زمینه های سفارشی که قصد دارید به REST API خود اضافه کنید را انتخاب کنید تا از این پس در REST API نمایش داده شوند.

با استفاده از صفحه ی آموزش نصب افزونه در وردپرس نحوه ی نصب افزونه ها در وردپرس را مشاهده کنید .

در آدرس زیر و با استفاده از آموزش بالا افزونه ی REST API Custom fields را دانلود و نصب کنید:

دانلود افزونه REST API Custom Fields از مخزن وردپرس

بعد از نصب و فعال کردن افزونه در داشبورد وردپرس خود به آدرس تنظیمات / REST API Custom fields که بعد از نصب افزونه اضافه شده است بروید که مانند تصویر زیر است:

4. اضافه کردن زمینه های سفارشی به REST API

در صفحه ی باز شده در بالا در وب سایت خود ، هر زمینه ی سفارشی که مایل هستید را به WordPress REST API اضافه کنید را تیک بزنید و تنظیمات را ذخیره کنید.

از این به بعد این زمینه های اضافه شده با اسم خودشان در صفحه ی هر پست در REST API قابل مشاهده است.

امیدوارم که این آموزش برای شما مفید واقع شده باشد .