د ورڈپریس REST API لپاره د ګړندي پیل لارښود

 د ورڈپریس REST API لپاره د ګړندي پیل لارښود

Patrick Harvey

ویب پاڼه په تیره لسیزه کې یو څه وده کړې، او ورډپریس د پخوا په پرتله لږ څه شاته شوی. د جاواسکریپټ سره ویب ته ډیر او ډیر غوښتنلیکونه راوړل کیږي، او ډیر زیات متحرک ویب پاڼې د Python او Ruby په څیر ژبو سره جوړیږي.

د ورڈپریس کور جوړونکي، او حتی یو څو مسلکي ورڈپریس جوړونکي، احساس کوي دا چې ورڈپریس په PHP باندې ډیر تکیه کوي او د جاواسکریپټ لږترلږه کارول خورا زاړه شوي دي. دا هغه څه دي چې د ورډپریس REST API د حل کولو لپاره دی.

دا پدې معنی نه ده چې ورډپریس د PHP څخه لیرې کیږي، مګر دا پدې معنی ده چې پراختیا کونکي باید د جاوا سکریپټ زده کړه په پام کې ونیسي که دوی وغواړي د دې API څخه ګټه پورته کړي. د وړاندې کولو لپاره.

د ورڈپریس REST API څه شی دی؟

د REST API نوی مفهوم ندی. په حقیقت کې، رای فیلډینګ په 2000 کال کې د "استازیتوب دولت لیږد" اصطلاح تعریف کړه کله چې هغه دا د HTTP 1.1 او یونیفورم سرچینې پیژندونکو ډیزاین کولو لپاره کارولې، چې د "URIs" په نوم پیژندل کیږي.

تاسو شاید دمخه پوه شئ چې APIs دي. د سافټویر غوښتنلیکونو جوړښت چې د وسایلو او پروتوکولونو سیټ لري پراختیا کونکي کولی شي د دې غوښتنلیکونو جوړولو لپاره وکاروي. REST API ورته ورته دی پرته لدې چې دا خپلې غوښتنې ترسره کړي او د HTTP پروتوکول له لارې خپل ځوابونه ترلاسه کړي.

منظم APIs عموما د غوښتنلیکونو جوړولو لپاره PHP، Python او Ruby کاروي. تاسو کولی شئ نورې ژبې وکاروئ، مګر دا خورا مشهور دي. REST APIs، له لارېساده ویب پاڼې او بلاګونه.

د جاوا سکریپټ زده کول باید همدا اوس یو لوړ لومړیتوب وي، لکه څنګه چې مخکې وویل شول، ځکه چې دا هغه ژبه ده چې د ورډپریس جوړونکي غواړي چې پراختیا کونکي په ورڈپریس پروژو کې ډیر ځله شامل کړي.

تاسو باید د ورڈپریس REST API لارښود کتاب ته هم لاړشئ ترڅو د REST API په اړه د ورډپریس غوره پوهه ترلاسه کړئ. د REST API کارولو برخه کې لارښودونه لري چې څنګه د نړیوال پیرامیټرو کارولو څرنګوالی، پاڼه کول، ځای پرځای کول او لینک کول، او تصدیق کول، کوم چې د دې API ټول کلیدي مفکورې دي.

یوځل چې تاسو د ټولو په اړه ښه پوهه ترلاسه کړه د دې څخه، تاسو کولی شئ د REST API پراخولو برخې ته لاړ شئ ترڅو زده کړئ چې څنګه د API ژوره پراخه کړئ. تاسو به د دودیز پای ټکي اضافه کولو په اړه نور معلومات زده کړئ او دا به هم زده کړئ چې څنګه د دودیز مینځپانګې ډولونه وکاروئ او ځوابونه بدل کړئ.

د HTTP پروتوکول کارول، د نورو پروګرامینګ ژبو کارول اسانه کوي، لکه جاواسکریپټ.

WordPress REST API

ما دمخه تشریح کړی چې څنګه د ورڈپریس REST API د ورڈپریس ته نږدې کولو په اړه ډیر څه دي. چیرې چې پاتې ویب شتون لري او د PHP څخه د لیرې کیدو په اړه لږ دي. دا د پراختیا کونکو لپاره د JSON او JavaScript په څیر ژبو کارول اسانه کولو په اړه دي نو ورڈپریس کولی شي په بشپړ ډول جوړ شوی پلیټ فارم شي چې د دودیزو ویب پا andو او بلاګونو څخه ډیر څه جوړولو لپاره کارول کیدی شي.

دلته د JSON شاملولو لپاره د WordPress توضیحات دي په WordPress REST API کې:

د WordPress REST API د ورډپریس ډیټا ډولونو لپاره د API پای ټکي چمتو کوي چې پراختیا کونکو ته اجازه ورکوي چې د JSON (جاواسکریپټ آبجیکٹ نوټیشن) شیانو لیږلو او ترلاسه کولو له لارې له سایټونو سره اړیکه ونیسي. JSON یو خلاص معیاري ډیټا فارمیټ دی چې لږ وزن لري او د انسان لوستلو وړ دی ، او داسې ښکاري چې شیان په جاواسکریپټ کې کوي؛ له همدې امله نوم. کله چې تاسو API ته مینځپانګه واستوئ یا غوښتنه وکړئ ، ځواب به په JSON کې بیرته راشي. دا پراختیا کونکو ته دا توان ورکوي چې د مراجعینو اړخ جاوا سکریپټ یا د بهرني غوښتنلیکونو څخه د ورڈپریس مینځپانګې رامینځته کړي ، لوستل او تازه کړي ، حتی هغه چې د PHP څخه هاخوا ژبو کې لیکل شوي.

دا په اصل کې د PHP ورډپریس کور ترمینځ تشه ډکولو لپاره ډیزاین شوی. په جاوا سکریپټ باندې جوړ شوی او ډیری ویب غوښتنلیکونه نن ورځ کاروي. د ورڈپریس REST API لپاره زیربنا د WordPress کور کې اضافه شوېپه 4.4 نسخه کې (کوډ نوم "کلیففورډ") په دسمبر 2015 کې. تاسو په هغه وخت کې د REST API کارولو لپاره یو پلگ ان ته اړتیا لرئ. په هرصورت، د دې API پاتې برخه، د منځپانګې پای ټکي باید دقیق وي، د دسمبر په 2016 کې د 4.7 نسخه (کوډ نوم "ووان") کې د WordPress کور کې اضافه شوي، د WP REST API پلگ ان ته اړتیا ردوي.

څنګه د WordPress REST API کار کوي

د دې لپاره چې پوه شي چې د WordPress REST API څنګه کار کوي، تاسو اړتیا لرئ پوه شئ چې د HTTP غوښتنې او ځوابونه څنګه کار کوي. کله چې تاسو د براوزر په پته بار کې یو URL داخل کړئ، دا یوه غوښتنه ده. کله چې سرور د دې URL لپاره ویب پاڼه یا غوښتنلیک ښکاره کوي، دا یو ځواب دی.

تاسو به یو څو مختلف ډوله غوښتنې یا "HTTP میتودونه" وګورئ کله چې تاسو د WordPress REST API کارول پیل کړئ. دلته د HTTP میتودونو څلور اصلي ډولونه دي چې ویب یې کاروي:

  • GET – د سرور څخه د ډیټا بیرته ترلاسه کولو لپاره کارول کیږي
  • POST - سرور ته د ډیټا لیږلو لپاره کارول کیږي
  • PUT - په سرور کې ډیټا بدلولو یا تازه کولو لپاره کارول کیږي
  • حذف - د ډیټا لرې کولو لپاره کارول کیږي سرور

د دې ساده تعریفونو په پام کې نیولو سره، په براوزر کې د URL داخلول د GET غوښتنه ده. د ویب پاڼې لپاره ستاسو د ننوتلو معلوماتو داخلول د POST غوښتنه ده. خپل اوسني پټنوم ته نوي بدلول د PUT غوښتنه ده پداسې حال کې چې ستاسو حساب بندول د حذف غوښتنه ده.

اضافي شرایط چې تاسو به یې یادونه وکړئ هغه دي "لارونه" او "پای ټکي." یوه لاره معمولا URL یاد URL یوه برخه چې تاسو یې د لاسرسي هڅه کوئ پداسې حال کې چې پای ټکی عموما هغه ځواب دی چې تاسو یې له سرور څخه ترلاسه کوئ.

کله چې بهرنۍ سرچینې ستاسو د ورډپریس سایټ کوربه سرور ته HTTP غوښتنې لیږي، REST API ستاسو ډاټا افشا کوي په خوندي ډول دغو غوښتنو ته د یو عام جوړښت او د خپل پروتوکولونو د سیټ سره ځواب ویلو سره.

دا د ورڈپریس منځپانګې ته اجازه ورکوي، لکه پوسټونه، پاڼې، او تبصرې، د خام ډیټا په توګه پروسس شي. موږ به په یوه دقیقه کې دا یو نظر ترلاسه کړو. د دې عمومي ټکی دا دی چې تاسو ته اجازه درکوي د خپل سایټ مینځپانګې کې بدلونونه رامینځته کړئ پرته لدې چې د ورڈپریس اډمین ساحې ته لاسرسی ومومئ. دا څنګه تاسو کولی شئ په خپل سایټ کې د JSON په کارولو سره بدلونونه رامینځته کړئ چې ځوابونه پراختیا کونکو ته د دوی سایټونو سره د متقابل عمل کولو لپاره مختلفې لارې ورکوي.

راځئ چې خپل لاسونه یو څه ناپاک کړو ترڅو وګورو چې دا ټول څنګه کار کوي.

د ورډپریس REST API کارول

موږ به په حقیقت کې د ورډپریس REST API استعمال څرنګوالی ته ورسیږو، مګر له بده مرغه، یو څو کلیدي مفکورې شتون لري چې موږ ورته اړتیا لرو لومړی باید وګورو نو دا ټول معنی لري. دلته هغه کلیدي مفکورې دي چې دا API جوړوي:

  • لارې & پای ټکي
  • غوښتنې
  • ځوابونه
  • سکیما
  • کنټرولر ټولګي

راځئ چې دې ته ورسیږو.

هم وګوره: د اګوراپولس بیاکتنه 2023: د ټولنیزو رسنیو غوره مدیریت وسیله؟

لارې & پای ټکي

د لارې تخنیکي تعریف یو URL دی چې د مختلف HTTP میتودونو له لارې نقشه کیدی شي. د لارې او HTTP میتود تر مینځ نقشه کول د an په نوم یادیږي"پای ټکی." تاسو کولی شئ د WordPress REST API ته لاسرسی ومومئ او وګورئ چې ستاسو د URL په پای کې د "/wp-json/" لارې اضافه کولو سره ستاسو سایټ لپاره کومې لارې او پای ټکي شتون لري.

تاسو دا په WordPress.org کې لیدلی شئ. د لیدلو له لارې //www.wordpress.org/wp-json/:

د کروم لپاره د JSON ویویر په نوم یو توسیع نصب کړئ (د فایرفوکس لپاره د JSON لیدونکي دلته شتون لري) د دې ګډوډۍ پاکولو لپاره:

که تاسو ښکلي پرملینکس نه کاروئ، نو د "wp-json" پرځای "?rest_route=" وکاروئ. په هرصورت، هغه څه چې تاسو یې دلته ګورئ د لارې او پای ټکی مثال دی. "/wp-json/" او "/?rest_route=/" لارې دي. دوی تاسو ته اجازه درکوي د GET HTTP میتود له لارې WordPress REST API ته لاسرسی ومومئ. د WordPress REST API تاسو ته ښودل شوی، یا هغه معلومات چې تاسو یې غواړئ، د JSON ځواب له لارې موږ ته د پای ټکی دی.

غوښتنې

د WordPress REST API د WP_REST_Request په نوم ټولګي سره غوښتنې پروسس کوي . دا د ورڈپریس REST API زیربنا کې لومړنی ټولګی دی. دا د ټولو هغو غوښتنو لپاره چې تاسو یې کوئ د معلوماتو ذخیره کولو او ترلاسه کولو لپاره کارول کیږي.

تاسو کولی شئ د HTTP میتودونو په کارولو سره له لرې څخه غوښتنې واستوئ یا تاسو کولی شئ په داخلي توګه لکه څنګه چې تاسو د PHP له لارې غواړئ.

ځوابونه

ځوابونه د WP_REST_Response ټولګي سره پروسس کیږي. ځواب هغه معلومات دي چې تاسو یې د غوښتنې څخه ترلاسه کوئ، لکه څنګه چې مخکې وویل شول. API د پای ټکي څخه لیږل شوي ډاټا بیرته راستنولو لپاره دا ټولګي کاروي. دا هم کولی شي بیرته راشيتېروتنې.

سکیما

سکیما د WordPress REST API دننه یو مفهوم دی چې مختلف اهدافو ته خدمت کوي. د API سکیما د ډیټا جوړښت تعریفوي پای ټکي یې کارولی شي، او دا د هغو ملکیتونو لیست لري چې د WordPress REST API بیرته راستانه کیدی شي. دا هغه پیرامیټونه هم لري چې API یې منلی شي او د API لخوا ترلاسه شوي غوښتنې تاییدولو سره د دې لپاره امنیت چمتو کوي.

کنټرولر ټولګي

د ورډپریس REST API لارې او پای ټکي راجسټر کوي ، غوښتنې اداره کوي ، سکیما کاروي د ډیټا او ملکیتونو تعریف کولو لپاره چې دا یې کارولی شي ، او د دې ټولو په سر کې د API ځوابونه رامینځته کوي. API، او تاسو د پراختیا کونکي په توګه، د دې ټولو خوځنده برخو اداره کولو لپاره یوې لارې ته اړتیا لرئ. دا هغه څه دي چې کنټرولر ټولګي د دې لپاره دي. دوی تاسو ته اجازه درکوي چې دا ټول عناصر راټول کړئ او په یو ځای کې یې تنظیم کړئ.

د ورڈپریس REST API کارول ترڅو ستاسو مینځپانګې ته د پای ټکي له لارې لاسرسی ومومي

یو لار هغه URL دی چې تاسو یې د لاسرسي لپاره کاروئ پای ټکی، او پای ټکی هغه ځواب دی چې تاسو یې د سرور څخه ترلاسه کوئ. که تاسو غواړئ د خپل سایټ پوسټونه د ورڈپریس REST API له لارې ترلاسه کړئ ، نو لاره وکاروئ "/wp/v2/posts/". ورڈپریس تشریح کوي چې "/wp-json/" پدې اوږده لارو کې شامل ندي ځکه چې دا د "خود API لپاره اساس لاره" ده. د پای URL "example.com/wp-json/wp/v2/posts" دی.

که تاسو غواړئ د API له لارې یو ځانګړي پوسټ ته لاسرسی ومومئ، په ساده ډول د پوسټ ID د URL پای ته اضافه کړئ نو دا داسې ښکاري:"example.com/wp-json/wp/v2/posts/123"

که تاسو غواړئ هغه پوسټونه وپلټئ چې ځانګړې جمله یا کلیمه کاروي، دا لاره وکاروئ: "/wp/v2/posts؟ =لټون[ دلته کلیمې داخل کړئ ]” نو URL داسې ښکاري: "example.com/wp-json/wp/v2/posts?search[ دلته کلیمه داخل کړئ ].

که تاسو د API له لارې د یو ځانګړي کارونکي پروفایل ته لاسرسی غواړئ، روټ ته "/users/" اضافه کړئ او همدارنګه د هغه کارن کارن ID. URL داسې ښکاري: "example.com/wp-json/wp/v2/users/2". په ورته ډول، که تاسو غواړئ د سایټ کاروونکو ته لاسرسی ومومئ، ID پریږدئ نو URL داسې ښکاري: "example.com/wp-json/wp/v2/users/".

تاسو کولی شئ دلته نور پای ټکي وګورئ .

هم وګوره: څنګه د Pinterest سره ستاسو بلاګ ته ډیر ترافیک چلول

د REST API پراخول

موږ به یو څو مرحلې پریږدو او زده کړو چې څنګه د REST API ملکیتونه وکاروو ترڅو دا پراخه کړو. تاسو باید د شیانو په اړه زده کړئ لکه د نړیوال پیرامیټونو، مخ کولو، لینک کولو او ایمبیډ کولو، او تصدیق کولو څخه مخکې، مګر موږ به د دې چټک پیل لارښود موخو لپاره مخکې لاړ شو.

دلته یو څو شیان دي چې تاسو یې کولی شئ د REST API په غزولو سره بشپړ کړئ:

  • د ګمرک پای ټکي اضافه کړئ
  • د ګمرک پوسټ ډولونو او ګمرکي مالیاتو لپاره لارې رامینځته کړئ
  • ځوابونه بدل کړئ

که تاسو تجربه لرونکی جوړونکی یاست، نو تاسو احتمال لرئ چې لا دمخه د REST API کې د دودیز پای ټکی اضافه کولو لپاره اړین مفاهیمو سره آشنا یاست. دا یوازې د زده کړې مسله ده چې څنګه دواړه سره وصل کړئ.

تاسو به د فعالیت په جوړولو سره پیل وکړئدا د فعالیت پیچلتیا پورې اړه لري ساده یا پیچلي کیدی شي چې تاسو یې هڅه کوئ REST API کې اضافه کړئ. دلته یو ساده فنکشن دی چې ورډپریس په خپل لاسي کتاب کې چمتو کوي، یو فنکشن چې ستاسو د سایټ د وروستي پوسټونو سرلیکونو د لیکوال لخوا اخیستلو لپاره ډیزاین شوی:

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

له هغې وروسته، تاسو اړتیا لرئ چې د دې فنکشن د چمتو کولو لپاره یوه لاره راجستر کړئ. API د بل فنکشن په کارولو سره چې د register_rest_route په نوم یادیږي. دلته هغه فنکشن دی چې ورڈپریس د تیر فعالیت لپاره د لارې راجستر کولو لپاره کاروي:

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

دلته یو څو شیان پیښیږي. لومړی، د دې فنکشن له لارې درې ملکیتونه تیریږي. دا د نوم ځای دی ("myplugin/v1")، هغه لار چې موږ یې راجستر کولو ته اړتیا لرو ("my_awesome_func") او هغه اختیارونه چې موږ یې کارول غواړو ("لیکوال/(?P\d+)"). د راجستر_ریسټ_روټ فنکشن د کال بیک فنکشن ته هم ویل کیږي چې "rest_api_init" نومیږي. دا د غیر ضروري کار مقدار کموي کوم چې ترسره کیږي کله چې API نه کارول کیږي.

لکه څنګه چې ورڈپریس تشریح کوي، دا لاره د "/author/{id}" سره د هر څه سره سمون لپاره ډیزاین شوې چیرې چې "{id }" یو عدد دی. دا هغه URL دی چې تاسو به د دې لارې کارولو لپاره لیدنه وکړئ – //example.com/wp-json/myplugin/v1/author/(?P\d+) . دا ځانګړې لار یو پای ټکی کاروي، مګر لارې د څو پای ټکي درلودو وړ دي. تاسو کولی شئ وګورئ چې موږ د HTTP میتود هم تعریف کړی چې دا پای ټکی به کاروي.

نور مفکورې چې تاسو ورته اړتیا لرئ

یو څو شتون لرياضافي مفکورې چې تاسو به یې زده کولو ته اړتیا ولرئ که تاسو غواړئ REST API وغځوئ، په دې شرط چې تاسو دمخه له دوی سره بلد نه یاست. موږ په پورته فنکشن کې د نوم ځای کارولی، له همدې امله د پورته URL لومړۍ برخه "myplugin/v1" ده. دوی د دودیزو لارو سره د شخړو د مخنیوي لپاره د مخکینۍ په توګه کارول کیږي.

دلیلونه یو بل مفهوم دی چې تاسو باید ورسره آشنا اوسئ ځکه چې دوی تاسو ته اجازه درکوي د پاکولو او تصدیق کولو لپاره د دوی په راجستر کولو سره چې تاسو د لارو ثبت کوئ. تاسو باید خپل ځان د بیرته ستنیدو ارزښتونو سره هم وپیژنئ ځکه چې دا هغه څه دي چې تاسو به یې د ځواب ډول تعریف کولو لپاره وکاروئ چې تاسو یې له سرور څخه ترلاسه کوئ. تاسو حتی کولی شئ دوی د غلطیو بیرته راستنولو لپاره وکاروئ، لکه د 404 تېروتنه چې ښکاره کیږي که لیکوال هیڅ پوسټ نه وي خپور کړی.

کال بیکس یو بل مفهوم دی چې تاسو یې باید پوه شئ، لکه د اجازې کال بیک په نوم پیژندل شوي افعال چې وګوري ایا آیا یا نه یو کارن د دې وړتیا لري چې یو عمل ترسره کړي مخکې لدې چې فنکشن د ریښتیني کال بیک زنګ وهلو هڅه وکړي. په نهایت کې، خپل ځان د داخلي ټولګیو او کنټرولر نمونو سره آشنا کول به تاسو سره د پای ټکي هر اړخ اداره کولو کې مرسته وکړي چې تاسو یې رامینځته کوئ.

وروستی فکرونه او amp; له دې ځایه چیرته لاړ شئ

د ورډپریس REST API کلیدي مفاهیمو پوهیدل او د دې کارولو او غزولو څرنګوالي زده کول خورا لوی کیدی شي ، مګر د ورڈپریس جوړونکي په کافي اندازه ډاډه دي چې دا به د CMS ځواک وي. دا اړتیا لري چې د جوړولو لپاره د یو پلیټ فارم په توګه د خپلو وړتیاو څخه لرې وده وکړي

?>

Patrick Harvey

پیټریک هاروي یو تجربه لرونکی لیکوال او ډیجیټل بازار موندونکی دی چې په صنعت کې د 10 کلونو تجربه لري. هغه د مختلفو موضوعاتو پراخه پوهه لري لکه بلاګینګ، ټولنیز رسنۍ، ای کامرس، او ورڈپریس. د لیکلو او د خلکو سره آنلاین بریالي کولو کې د هغه لیوالتیا هغه دې ته هڅولی چې بصیرت لرونکي او ښکیل پوسټونه رامینځته کړي چې د هغه لیدونکو ته ارزښت ورکوي. د یو تکړه ورڈپریس کارونکي په توګه، پیټریک د بریالۍ ویب پاڼو د جوړولو په اړه پوهه لري، او هغه دا پوهه کاروي ترڅو د سوداګرۍ او افرادو سره په ورته ډول د دوی آنلاین شتون رامینځته کړي. د توضیحاتو لپاره د لیوالتیا او غوره والي لپاره د نه متقابل ژمنې سره ، پیټریک خپلو لوستونکو ته د ډیجیټل بازارموندنې صنعت کې وروستي رجحانات او مشورې چمتو کولو ته وقف شوی. کله چې هغه بلاګ نه وي، پیټریک د نوي ځایونو سپړلو، کتابونو لوستلو، یا د باسکیټبال لوبې موندلی شي.