REST API وردپرس: راهنمای کامل

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

REST API وردپرس چیست؟

REST API وردپرس رابط کاربری است که توسعه‌دهندگان می‌توانند با استفاده از آن از بیرون از وردپرس به وردپرس دسترسی داشته باشند. این دسترسی با کمک جاوا اسکریپت انجام می‌شود.

REST مخفف عبارت انتقال بازنمودی حالت و API نیز مخفف واسط برنامه‌نویسی است.

API چیست؟

یک واسط برنامه‌نویسی یا API رابط یا پروتکل ارتباطی بین یک مشتری و یک سرور است و وظیفه آن ساده‌سازی ساخت نرم‌افزار سمت مشتری است.

رفع خطای WordPress Missing MySQL Extension

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

REST چیست؟

REST استانداردهایی را ارایه می‌کند که سیستم‌های تحت وب بتوانند با کمک آنها با یکدیگر ارتباط برقرار کنند. بدون REST دو سیستم قادر به درک یکدیگر نیستند و در نتیجه نمی‌توانند داده‌ای را بین خود رد و بدل کنند.

درک REST API وردپرس

قرار دادن REST و API در کنار یکدیگر برای سیستم مدیریت محتوای وردپرس به این معناست که مجموعه کدهایی طراحی شده‌اند تا این امکان را در اختیار سیستم‌های دیگر قرار می‌دهند تا با رابط کاربری وردپرس ارتباط برقرار کنند.

به عبارت دیگر یعنی اینکه وبسایت یا اپ دیگری امکان دسترسی به پایگاه‌داده وردپرس شما را خواهد داشت و داده‌هایی را از آن فرامی‌خواند و داده‌هایی را به آن اضافه می‌کند.

تاریخچه REST API وردپرس

REST API وردپرس در دسامبر 2016 با عرضه نسخه 4.7 ارایه شد. از این قابلیت به صورت گسترده بر روی WordPress.com استفاده می‌شود که از رابط جاوا اسکریپت برای تعامل با پایگاه داده وردپرس استفاده می‌شود.

کاربردهای REST API وردپرس برای کاربران و توسعه‌دهندگان

اگر توسعه دهنده وردپرس یا کاربر این سیستم مدیریت محتوا هستید، REST API وردپرس کاربردهای زیر را برای شما دارد.

برای کاربران:

• تغییر رابط از جمله ویرایشگر گوتنبرگ.
• تغییر و بهبود اپ موبایل وردپرس
• صفحه مدیریت وردپرس بر روی هاست‌های شخصی بیشتر به صفحات مدیریت WordPress.com شبیه شده است.

برای توسعه‌دهندگان امکانات و قابلیت‌های بیشتری ارایه می‌کند:

• قابلیت ساخت اپ‌های تک صفحه‌ای با استفاده از REST API
• قابلیت تعامل وردپرس با دیگر فناوری‌ها و سیستم‌ها.
• امکان توسعه وردپرس در صورتیکه توسعه‌دهنده فرانت‌اند هستید و علاقه‌ای هم به PHP ندارید.
• نیاز به تغییرات مشخص از جمله نیاز به ساخت بلوک‌های گوتنبرگ به جای ایجاد متاباکس در صفحات ویرایش نوشته و برگه.

اگر توسعه‌دهنده وردپرس هستید به این معناست که نیاز به یادگیری جاوا اسکریپت خواهید داشت.

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

برای دسترسی به REST API وردپرس بایستی به وبسایت خود از طریق خط فرمان دسترسی داشته باشید. در وردپرس این خط فرمان WP-CLI نامیده می‌شود و نیازی به صفحات مدیریت وبسایت ندارید.

دسترسی به REST API وردپرس از طریق WP-CLI

WP-CLI رابط خط فرمان در وردپرس است. این ابزار به شما اجازه دسترسی و کار با وردپرس از طریق رابط خط فرمان بر روی کامپیوتر شما را می‌دهد.

برای دسترسی به CLI صفحه CMD را در ویندوز خود باز کنید. برای دسترسی از راه دور به وبسایت بایستی ابتدا SSH بر روی سرور خود داشته باشید.

تایید اعتبار

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

توابع شرطی وردپرس: راهنمای کامل

برای تایید اعتبار به سایت از طریق WP-CLI بایستی یک افزونه تایید اعتبار بر روی وردپرس خود نصب کنید. برای اینکار می‌توانید افزونه Basic Auth را نصب و فعال کنید.

در مثال زیر با استفاده از curl برای آزمایش ارتباط با وردپرس تمام پست‌های پیش‌نویس بر روی وردپرس نمایش داده می‌شود:

curl -X GET --user username:password -i http://yoursite.com/wp-json/wp/v2/posts?status=draft

پست‌های پیش‌نویس اطلاعات عمومی نیستند در نتیجه برای دسترسی به آنها بایستی هویت شما تایید شود. اما اگر به دنبال اطلاعاتی هستید که عمومی هستند نیاز به تایید هویت شما نیست. بنابراین برای مشاهده لیستی از پست‌های منتشر شده می‌توانید از دستور زیر استفاده کنید:

curl -X GET http://yoursite.com/wp-json/wp/v2/posts

بررسی دستورات REST API وردپرس

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

دستورات مربوط به REST API وردپرس در زیر توضیح داده شده است.

• GET وظیفه بازیابی منابعی مانند پست یا داده‌های دیگر را دارد.
• POST منبعی را به سرور می‌افزاید مثلا یک پست، ضمیمه یا منبعی دیگر.
• PUT می‌تواند برای ویرایش یا به‌روزرسانی یک منبع که پیشتر بر روی سرور وجود دارد استفاده شود.
• DELETE منبعی را از سرور حذف می‌کند.

چرا نباید از REST API وردپرس استفاده کنیم

REST API وردپرس همیشه روش درستی برای توسعه یک وبسایت یا اپ به حساب نمی‌آید. در خصوص استفاده از REST API وردپرس نکاتی وجود دارد که بایستی به آنها دقت کنیم.

سازگاری

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

دسترس‌پذیری

وبسایت‌ها یا اپ‌هایی که با کمک جاوا اسکریپت توسعه داده می‌شوند همیشه به مانند خروجی HTML در دسترس نیستند.

این مساله بیشتر به این دلیل است که جاوا اسکریپت برای ارایه محتوای پویا استفاده می‌شود که احتمالا در صفحه‌خوان‌ها به خوبی عمل نمی‌کنند.

سئو

برنامه‌های تک صفحه‌ای برخی اوقات مسایلی با سئو دارند. در حال حاضر گوگل و سایر موتور جستجوها به این مساله دقت بیشتری دارند اما هنوز هم نیاز به دقت زیاد در خصوص سئو این صفحات است.

کرون جاب در وردپرس

چگونه REST API وردپرس را غیرفعال کنیم

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

برای اینکار بایستی افزونه Disable WP REST API را نصب و فعال کنید. این افزونه قابلیت REST API وردپرس را غیرفعال خواهد کرد.

در صورتیکه نمی‌خواهید از افزونه برای غیرفعال کردن این امکان بر روی وبسایت خود استفاده کنید می‌توانید از کد زیر در فایل functions.php قالب استفاده کنید.

add_filter( 'json_enabled', '__return_false' );
add_filter( 'json_jsonp_enabled', '__return_false' );