WordPress API

WordPress API – WordPress से सम्बंधित विभिन्न प्रकार के Online Resources व Documentations Available हैं, जिनकी Theme या Plugin Development के समय काफी जरूरत पडती है। इन्हीं Online Documentations में से WordPress Codex भी एक है। ये एक प्रकार की Wiki-Based Web Site है, जहां WordPress से सम्बंधित विभिन्न Documentation को User स्वयं Create करते हैं।

WordPress Codex का सबसे महत्वपूर्ण हिस्सा http://codex.wordpress.org/Function_Reference का ही है क्योंकि यहीं पर WordPress API के सभी Functions की List Available है। साथ ही इसी Web Page पर विभिन्न WordPress API Functions, अलग-अलग Category में Defined होने की वजह से, हम विभिन्न Categories में Defined विभिन्न Functions की जानकारी भी प्राप्त कर सकते हैं।

इतना ही नहीं, हमें जिस किसी भी Function के बारे में जानना होता है, इस Web Page पर हमें केवल उस Function को Click करना होता है। जैसे ही हम किसी Function को Click करते हैं, उस Function का Example सहित Detailed Description प्राप्त हो जाता है।

WordPress में विभिन्न प्रकार के APIs को विभिन्न प्रकार की Categories में Divide किया गया है, ताकि किसी Specific काम से सम्बंधित Functions को एक Group के रूप में Categories किया जा सके, जो कि निम्नानुसार हैं:

Plugin API

इस API के अन्तर्गत उन Functions को Define किया गया है, जिनका प्रयोग मूल रूप से WordPress Plugin Develop करने के लिए किया जाता है। Plugin Development से सम्बंधित Hooks, Actions व Filters आदि से सम्बंधित Functions Codex के निम्न URL पर Available होते हैं:

        http://codex.wordpress.org/Plugin_API

Widget API

इस API के अन्तर्गत उन Functions को Define किया गया है, जिनका प्रयोग मूल रूप से WordPress Widgets Develop करने के लिए किया जाता है। Widgets Automatically WordPress Dashboard के Appearance Panel में Widgets SubPanel के रूप में दिखाई देते हैं। Widgets Development से सम्बंधित Functions Codex के निम्न URL पर Available होते हैं:

        http://codex.wordpress.org/Widgets_API

Shortcode API

इस API के अन्तर्गत उन Functions को Define किया गया है, जिनका प्रयोग मूल रूप से WordPress Shortcode Define करने के लिए किया जाता है। Shortcode एक प्रकार का Macro होता है, जिसे किसी Post में Add किया जा सकता है और जहां पर इसे Specify किया जाता है, वहां पर Shortcode के साथ Specified Code Expand हो जाता है।

Shortcode किसी Function की तरह काम करते हैं और Function की तरह ही हम किसी Shortcode को भी इस तरह से Specify कर सकते हैं, जो Parameters Accept करता हो और Parameters के आधार पर अलग-अलग तरह की Functionality Provide करता हो। Shortcode Development से सम्बंधित Functions Codex के निम्न URL पर Available होते हैं:

        http://codex.wordpress.org/Shortcode_API

HTTP API

इस API के अन्तर्गत उन Functions को Define किया गया है, जिनका प्रयोग मूल रूप से WordPress के माध्‍यम से HTTP Request Send करने के लिए किया जाता है। ये API किसी External URL से Content Grab करने का Standard तरीका Provide करता है।

सामान्‍यत: इस API में Use किया जाने वाला Function Argument के रूप में एक URL Accept करता है और Request Send करने के लिए विभिन्न प्रकार के तरीकों की एक Series Use करता है और जो तरीका सबसे Best होता है, उसी तरीके को Use करके WordPress Internally Request Send करता है।

Current HTTP API PHP Methods को cUrl, Streams, Fopen, FSockopen व HTTP Extension के लिए Test किया गया है और Request Send करने से पहले WordPress द्वारा भी Request Sending के लिए इन Methods को Exactly इसी Sequence में Check किया जाता है। हम Core-Control नाम के Plugin का प्रयोग करके WordPress द्वारा Send किए जाने वाले HTTP Request को Set भी कर सकते हैं।

इन APIs का प्रयोग करके हम बडी ही आसानी से Google Maps API से Interact करके Dynamically Maps व Plots Generate कर सकते हैं। Twitter API के साथ Interact करके WordPress से Directly Tweets को Post या Read कर सकते हैं। HTTP API से सम्बंधित Functions Codex के निम्न URL पर Available होते हैं:

        http://codex.wordpress.org/HTTP_API

Settings API

इस API के अन्तर्गत उन Functions को Define किया गया है, जिनका प्रयोग मूल रूप से WordPress Settings Page को Create करने के लिए किया जाता है। इस API को Use करने का मूल कारण Security Issues को Handle करना होता है।

ये API किसी User द्वारा Save किए जाने वाले विभिन्न प्रकार के Data के लिए Security Test करने की सुविधा देता है, ताकि User हमारी Website का Data Validation Standard उपयुक्त रहे तथा हमारी Web Site XSS जैसे Attacks से सुरिक्षत रहे। Settings API से सम्बंधित Functions Codex के निम्न URL पर Available होते हैं:

        http://codex.wordpress.org/Settings_API

Dashboard Widgets API

इस API के अन्तर्गत उन Functions को Define किया गया है, जिनका प्रयोग मूल रूप से WordPress Dashboard Admin Widgets Create करने के लिए किया जाता है। Create होने वाले इन Widgets में Automatically वे सभी jQuery Features Included होते हैं, जो कि Admin Dashboard के अन्‍य Widgets के लिए होते हैं। जैसे Drag/Drop, Minimize व Screen Options Show/Hide आदि। Dashboard Widgets API से सम्बंधित Functions Codex के निम्न URL पर Available होते हैं:

        http://codex.wordpress.org/Dashboard_Widgets_API

Rewrite API

इस API के अन्तर्गत उन Functions को Define किया गया है, जिनका प्रयोग मूल रूप से Rewrite Rules Create करने के लिए किया जाता है।

इस API के Functions का प्रयोग करके %postname% की तरह हम हमारे स्वयं के Custom Permalinks Structure Tags Create कर सकते हैं, URL के अन्त में Static Endpoints (जैसे /my-post/ ) Add कर सकते हैं अथवा Additional Feed Links Add कर सकते हैं।

Rewrite से सम्बंधित API Functions /wp-includs/rewrite.php” Core File में Exist होते हैं। जबकि Rewrite API से सम्बंधित Functions Codex के निम्न URL पर Available होते हैं:

        http://codex.wordpress.org/Rewrite_API

ध्‍यान रखने वाली बात ये है कि सभी WordPress APIs को Custom Plugin व Theme Development करते समय भी उपयोग में लिया जा सकता है, जो कि WordPress की Functionalities को Extend करने का मुख्‍य तरीका है। जबकि उपरोक्त APIs को Use करते हुए WordPress के साथ Interact करना, एक WordPress Friendly Standard तरीका है।