Web telah berkembang sedikit sepanjang dekad yang lalu, dan WordPress telah ketinggalan sedikit. Semakin banyak aplikasi dibawa ke web dengan JavaScript, dan semakin banyak tapak web dinamik sedang dibina dengan bahasa seperti Python dan Ruby.

Pembangun teras WordPress, malah beberapa pembangun WordPress profesional, merasakan bahawa pergantungan berat WordPress pada PHP dan penggunaan JavaScript yang minimum telah menjadi terlalu ketinggalan zaman. Ini adalah sesuatu yang ingin diselesaikan oleh WordPress REST API.

Ini tidak bermakna WordPress beralih daripada PHP, tetapi ini bermakna pembangun harus mempertimbangkan untuk mempelajari JavaScript jika mereka ingin memanfaatkan apa yang ada pada API ini untuk ditawarkan.

Apakah itu WordPress REST API?

REST API bukanlah konsep baharu. Malah, Roy Fielding mentakrifkan istilah "pemindahan keadaan perwakilan" pada tahun 2000 apabila dia menggunakannya untuk mereka bentuk HTTP 1.1 dan Pengecam Sumber Seragam, lebih dikenali sebagai "URI".

Anda mungkin sudah tahu bahawa API adalah struktur aplikasi perisian yang mengandungi set alat dan protokol yang boleh digunakan oleh pembangun untuk membina aplikasi tersebut. REST API adalah serupa dengan itu kecuali ia melaksanakan permintaannya dan menerima responsnya melalui protokol HTTP.

API biasa biasanya menggunakan PHP, Python dan Ruby untuk membina aplikasi. Anda boleh menggunakan bahasa lain, tetapi ini adalah yang paling popular. REST API, melaluilaman web dan blog yang ringkas.

Pembelajaran JavaScript harus menjadi keutamaan sekarang, seperti yang dinyatakan sebelum ini, kerana ini adalah bahasa yang diingini oleh pembuat WordPress untuk digunakan oleh pembangun dengan lebih kerap dalam projek WordPress.

Anda juga harus membaca buku panduan WordPress REST API untuk mendapatkan pemahaman yang lebih baik tentang pandangan WordPress terhadap API REST. Bahagian Menggunakan API REST mengandungi panduan tentang cara menggunakan parameter global, penomboran, pembenaman dan pemautan serta pengesahan, yang kesemuanya merupakan konsep utama API ini.

Setelah anda mendapat pemahaman yang cukup baik tentang semua daripada itu, anda boleh melalui bahagian Memanjangkan API REST untuk mengetahui cara memanjangkan API secara mendalam. Anda akan mengetahui lebih lanjut tentang menambah titik akhir tersuai dan juga akan mempelajari cara menggunakan jenis kandungan tersuai dan mengubah suai respons.

WordPress REST API

Saya telah menjelaskan bagaimana WordPress REST API lebih kepada mendekatkan WordPress kepada di mana seluruh web berada dan kurang tentang beralih daripada PHP. Ini mengenai memudahkan pembangun menggunakan bahasa seperti JSON dan JavaScript supaya WordPress boleh menjadi platform sepenuhnya yang mampu digunakan untuk membina lebih banyak daripada tapak web dan blog tradisional.

Berikut ialah penjelasan WordPress untuk menggabungkan JSON dalam WordPress REST API:

API REST WordPress menyediakan titik akhir API untuk jenis data WordPress yang membolehkan pembangun berinteraksi dengan tapak dari jauh dengan menghantar dan menerima objek JSON (JavaScript Object Notation). JSON ialah format data standard terbuka yang ringan dan boleh dibaca manusia, dan kelihatan seperti Objects lakukan dalam JavaScript; maka nama itu. Apabila anda menghantar kandungan atau membuat permintaan kepada API, respons akan dikembalikan dalam JSON. Ini membolehkan pembangun mencipta, membaca dan mengemas kini kandungan WordPress daripada JavaScript sisi klien atau daripada aplikasi luaran, malah yang ditulis dalam bahasa di luar PHP.

Ia pada asasnya direka untuk merapatkan jurang antara teras PHP WordPress dibina pada dan JavaScript banyak aplikasi web digunakan hari ini. Infrastruktur untuk WordPress REST API telah ditambahkan pada teras WordPressdalam versi 4.4 (nama kod “Clifford”) pada Disember 2015. Anda memerlukan pemalam untuk menggunakan API REST pada masa itu. Walau bagaimanapun, selebihnya API ini, tepatnya titik akhir kandungan, telah ditambahkan pada teras WordPress dalam versi 4.7 (nama kod “Vaughan”) pada Disember 2016, menafikan keperluan untuk pemalam WP REST API.

Bagaimana WordPress REST API berfungsi

Untuk memahami cara WordPress REST API berfungsi, anda perlu memahami cara permintaan dan respons HTTP berfungsi. Apabila anda memasukkan URL dalam bar alamat penyemak imbas, itu adalah permintaan. Apabila pelayan memaparkan tapak web atau aplikasi untuk URL itu, itu adalah jawapan.

Anda akan melihat beberapa jenis permintaan atau "kaedah HTTP" yang berbeza apabila anda mula menggunakan WordPress REST API. Berikut ialah empat jenis utama kaedah HTTP yang digunakan web:

• DAPATKAN – Digunakan untuk mendapatkan semula data daripada pelayan
• POST – Digunakan untuk menghantar data ke pelayan
• PUT – Digunakan untuk menukar atau mengemas kini data pada pelayan
• DELETE – Digunakan untuk mengalih keluar data daripada pelayan

Dengan mengambil kira takrifan mudah tersebut, memasukkan URL dalam penyemak imbas ialah permintaan GET. Memasukkan maklumat log masuk anda untuk tapak web adalah permintaan POST. Menukar kata laluan semasa anda kepada yang baharu ialah permintaan PUT manakala penamatan akaun anda ialah permintaan PADAM.

Istilah tambahan yang anda akan perhatikan ialah "laluan" dan "titik tamat". Laluan biasanya URL atausebahagian daripada URL yang anda cuba akses manakala titik akhir lazimnya ialah respons yang anda terima daripada pelayan.

Apabila sumber luaran menghantar permintaan HTTP kepada pelayan yang mengehos tapak WordPress anda, API REST mendedahkan data anda dengan cara yang selamat dengan membalas permintaan tersebut dengan seni bina biasa dan set protokolnya sendiri.

Ini membolehkan kandungan WordPress, seperti siaran, halaman dan ulasan, diproses sebagai data mentah. Kami akan mendapat gambaran tentang ini dalam satu minit. Perkara keseluruhan ini adalah untuk membolehkan anda membuat perubahan pada kandungan tapak anda tanpa perlu mengakses kawasan pentadbir WordPress. Beginilah cara anda boleh membuat perubahan pada tapak anda menggunakan JSON yang responsnya memberikan pembangun beberapa cara berbeza untuk berinteraksi dengan tapak mereka.

Mari kita sedikit kotor untuk melihat cara ini semua berfungsi.

Menggunakan WordPress REST API

Kita akan mempelajari cara sebenarnya menggunakan WordPress REST API, tetapi malangnya, terdapat beberapa konsep utama yang perlu kita teliti terlebih dahulu jadi semuanya masuk akal. Berikut ialah konsep utama yang membentuk API ini:

• Laluan & Titik Tamat
• Permintaan
• Respons
• Skema
• Kelas Pengawal

Mari kita lakukannya.

Laluan & Titik akhir

Takrif teknikal laluan ialah URL yang boleh dipetakan melalui kaedah HTTP yang berbeza. Pemetaan antara laluan dan kaedah HTTP dipanggil an“titik akhir.” Anda boleh mengakses WordPress REST API dan melihat laluan dan titik akhir yang tersedia untuk tapak anda dengan menambahkan laluan “/wp-json/” pada penghujung URL anda.

Anda boleh melihatnya di WordPress.org dengan melawati //www.wordpress.org/wp-json/:

Pasang sambungan yang dipanggil JSON Viewer untuk Chrome (JSON viewer untuk Firefox tersedia di sini) untuk membersihkan kekacauan ini:

Jika anda tidak menggunakan pautan kekal yang cantik, gunakan “?rest_route=” dan bukannya “wp-json”. Walau apa pun, perkara yang anda lihat di sini ialah contoh laluan dan titik akhir. “/wp-json/” dan “/?rest_route=/” ialah laluan. Mereka membenarkan anda mengakses API REST WordPress melalui kaedah GET HTTP. API REST WordPress yang dipaparkan kepada anda, atau data jika anda mahu, adalah titik akhir yang disampaikan kepada kami melalui respons JSON.

Permintaan

API REST WordPress memproses permintaan dengan kelas bernama WP_REST_Request . Ia adalah kelas utama dalam infrastruktur WordPress REST API. Ia digunakan untuk menyimpan dan mendapatkan maklumat untuk semua permintaan yang anda buat.

Anda boleh menghantar permintaan dari jauh menggunakan kaedah HTTP yang kami lalui atau anda boleh membuatnya secara dalaman seperti biasa melalui PHP.

Respons

Respons diproses dengan kelas WP_REST_Response. Respons ialah data yang anda terima daripada permintaan, seperti yang dinyatakan sebelum ini. API menggunakan kelas ini untuk mengembalikan data yang dihantar dari titik akhir. Ia juga boleh kembaliralat.

Skema

Skema ialah konsep dalam WordPress REST API yang menyediakan pelbagai tujuan. Skema API mentakrifkan struktur data yang boleh digunakan oleh titik akhir dan ia mengandungi senarai sifat yang boleh dikembalikan oleh WordPress REST API. Ia juga mengandungi parameter yang boleh diterima oleh API dan menyediakan keselamatan untuknya dengan mengesahkan permintaan yang diterima oleh API.

Kelas Pengawal

API REST WordPress mendaftarkan laluan dan titik akhir, mengendalikan permintaan, menggunakan Skema untuk menentukan data dan sifat yang boleh digunakannya, dan menjana respons API di atas semua itu. API, dan anda sebagai pembangun, memerlukan cara untuk mengurus semua bahagian bergerak ini. Itulah gunanya kelas pengawal. Ia membenarkan anda mengumpulkan semua elemen ini dan menyusunnya di satu tempat.

Menggunakan WordPress REST API untuk mengakses kandungan anda melalui titik akhir

Laluan ialah URL yang anda gunakan untuk mengakses titik akhir, dan titik akhir ialah respons yang anda terima daripada pelayan. Jika anda ingin mendapatkan siaran tapak anda melalui WordPress REST API, gunakan laluan "/wp/v2/posts/". WordPress menerangkan bahawa "/wp-json/" tidak disertakan dalam laluan yang lebih panjang ini kerana ia adalah "laluan asas untuk API itu sendiri." URL penamat ialah “example.com/wp-json/wp/v2/posts”.

Jika anda ingin mengakses siaran tertentu melalui API, cuma tambahkan ID siaran pada penghujung URL supaya ia kelihatan seperti ini:“example.com/wp-json/wp/v2/posts/123”

Jika anda ingin mencari siaran yang menggunakan frasa atau kata kunci tertentu, gunakan laluan ini: “/wp/v2/posts? =search[ masukkan kata kunci di sini ]” supaya URL kelihatan seperti ini: “example.com/wp-json/wp/v2/posts?search[ masukkan kata kunci di sini ].

Jika anda ingin mengakses profil pengguna tertentu melalui API, tambahkan “/users/” pada laluan serta ID pengguna pengguna tersebut. URL kelihatan seperti ini: "example.com/wp-json/wp/v2/users/2". Begitu juga, jika anda ingin mengakses pengguna tapak, lepaskan ID supaya URL kelihatan seperti ini: “example.com/wp-json/wp/v2/users/”.

Anda boleh melihat lebih banyak titik akhir di sini .

Memperluas API REST

Kami akan melangkau beberapa langkah dan mempelajari cara menggunakan sifat API REST untuk melanjutkannya. Anda harus belajar tentang perkara seperti parameter global, penomboran, pemautan dan pembenaman serta pengesahan sebelum melakukan ini, tetapi kami akan melangkau ke hadapan untuk tujuan panduan mula pantas ini.

Berikut ialah beberapa perkara yang anda boleh capai dengan memanjangkan REST API:

• Tambah Titik Akhir Tersuai
• Buat Laluan untuk Jenis Catatan Tersuai dan Taksonomi Tersuai
• Ubah Suai Respons

Jika anda seorang pembangun yang berpengalaman, anda mungkin sudah biasa dengan konsep yang diperlukan untuk menambahkan titik akhir tersuai pada REST API. Ia hanya perlu mempelajari cara menyambungkan kedua-duanya.

Anda akan bermula dengan mencipta fungsiyang boleh menjadi mudah atau rumit bergantung pada kecanggihan fungsi yang anda cuba tambahkan pada REST API. Berikut ialah fungsi mudah yang disediakan oleh WordPress dalam buku panduan mereka, fungsi yang direka untuk merebut tajuk siaran terbaharu tapak anda oleh pengarang:

 $data['id'], ) ); if ( empty( $posts ) ) { return null; } return $posts[0]->post_title; } 

Selepas itu, anda perlu mendaftar laluan untuk menjadikan fungsi ini tersedia kepada API dengan menggunakan fungsi lain yang dipanggil register_rest_route. Berikut ialah fungsi yang digunakan WordPress untuk mendaftarkan laluan bagi fungsi sebelumnya:

 'GET', 'callback' => 'my_awesome_func', ) ); } );

Terdapat beberapa perkara yang berlaku di sini. Pertama, terdapat tiga sifat yang melalui fungsi ini. Ia adalah ruang nama (“myplugin/v1”), laluan yang perlu kami daftarkan (“my_awesome_func”) dan pilihan yang ingin kami gunakan (“pengarang/(?P\d+)”). Fungsi register_rest_route juga sedang dipanggil pada fungsi panggil balik yang dipanggil "rest_api_init". Ini mengurangkan jumlah kerja tidak perlu yang dilakukan apabila API tidak digunakan.

Seperti yang dijelaskan oleh WordPress, laluan ini direka bentuk untuk memadankan apa-apa sahaja dengan “/author/{id}” di mana “{id }” ialah integer. Ini ialah URL yang anda akan lawati untuk menggunakan laluan ini – //example.com/wp-json/myplugin/v1/author/(?P\d+) . Laluan khusus ini menggunakan satu titik akhir, tetapi laluan mampu mempunyai berbilang titik akhir. Anda boleh lihat kami juga menentukan kaedah HTTP yang akan digunakan oleh titik akhir ini.

Konsep lain yang anda perlukan

Terdapat beberapakonsep tambahan yang anda perlu pelajari jika anda ingin melanjutkan API REST, dengan syarat anda belum biasa dengannya. Kami menggunakan ruang nama dalam fungsi di atas, itulah sebabnya bahagian pertama URL di atas ialah "myplugin/v1". Ia digunakan sebagai awalan untuk mengelakkan pertembungan dengan laluan tersuai.

Argumen ialah satu lagi konsep yang anda harus kenali kerana ia membenarkan anda menjalankan sanitasi dan pengesahan dengan mendaftarkannya apabila anda mendaftar laluan. Anda juga harus membiasakan diri dengan nilai pulangan kerana ini adalah perkara yang akan anda gunakan untuk menentukan jenis respons yang anda terima daripada pelayan. Anda juga boleh menggunakannya untuk mengembalikan ralat, seperti ralat 404 yang dipaparkan jika pengarang belum menerbitkan sebarang siaran.

Panggil balik ialah konsep lain yang perlu anda ketahui, seperti fungsi yang dikenali sebagai panggilan balik kebenaran yang menyemak sama ada atau tidak pengguna dapat melakukan tindakan sebelum fungsi cuba memanggil panggilan balik sebenar. Akhir sekali, membiasakan diri dengan kelas dalaman dan corak pengawal akan membantu anda mengurus setiap aspek titik akhir yang anda buat.

Fikiran akhir & ke mana hendak pergi dari sini

Memahami konsep utama WordPress REST API dan mempelajari cara menggunakan serta memanjangkannya boleh menjadi sukar, tetapi pembuat WordPress agak yakin ia akan menjadi kekuatan CMS dalam cara ia perlu berkembang jauh melebihi kemampuannya sebagai platform untuk membina