WordPress Core as Reference

WordPress Core as Reference – WordPress की हर Core File में Define की गई सभी Functionalities को Comments के रूप में Document किया गया है, जो कि सामान्‍यत: Header के रूप में दिखाई देता है और Current Core File की पूरी Summary Show करता है।

लगभग सभी Core Files में Current File में Defined Functionalities को Describe करने के लिए Inline Documentation होता है। यानी Current File में जो भी Functionality होती है, उसे पहले एक Comment Block के रूप में Describe किया गया होता है, जिसका Format निम्नानुसार होता है:

	/**
	* Short Description
	*
	* Long Description
	*
	* @package WordPress
	* @since version
	*
	* @param  	type  	$varname  	Description
	* @return  	type  	Description
	*/

चूंकि हर Core File का Documentation इसी तरह से होता है, इसलिए हम किसी भी Core File में Define किए गए किसी Function की Basic Details इस Documentation प्राप्त कर सकते हैं।

इस Documentation में Short व Long Description, Current Core File में Defined Function के बारे में बताते हैं कि Function वास्तव में किस जरूरत को पूरा करेगा। जबकि @version Current Function की Availability की अविध बताता है कि Current Function को WordPress के किस Version से Core File में Include किया गया है।

Function में जो Data Parameter के में Pass किया गया होता है, उस Parameter की Information @param के साथ Specified Information से प्राप्त होती है। उदाहरण के लिए यदि किसी Function में ID Parameter को Use किया जा रहा हो, तो Documentation में इसे निम्नानुसार दिखाया जा सकता है:

* @param  int           $ID         ID of the current post

NetBeans व DreamWeaver में हम जैसे ही किसी Function को Specify करते हैं, हमें उस Function की Source File का नाम व Basic Description Automatically दिखाई देने लगता है। जैसे:

इस चित्र में हम देख सकते हैं कि जैसे ही हम “get_h” लिखते हैं, “get_” से शुरू होने वाले सभी Functions की List हमें Code Hint List में दिखाई देने लगता है। साथ ही हम देख सकते हैं कि Currently Selected Function का Description जैसे कि Function के Parameters, Return Values आदि Description भी हमें दिखाई देने लगते हैं।

हालांकि DreamWeaver में Description दिखाई नहीं देताए लेकिन Currently Use किया जाने वाला Function किस WordPress Core File में Defined है, उस File का नाम DreamWeaver में भी दिखाई देता है।

जबकि यदि हम WPIDE में Use करते हैं, तो अगले चित्र में दिखाए अनुसार जैसे ही हम किसी Core Function का नाम लिखना शुरू करते हैं, हमें Code Hint में उस नाम से शुरू होने वाले सभी Functions की List दिखाई देने लगती है।

साथ ही हम जैसे ही किसी Function को Select करते हैं, उस Function की सारी Detail व Function का Codex URL, Top-Right Side में दिखाई देने लगता है, जिस पर Click करके हम WordPress Codes से उस Function की Detailed Information प्राप्त कर सकते हैं।