WordPress get_option – update_option – WP Options API

WordPress get_option – update_option – Options API – सामान्‍यत: हम जब भी कोई Plugin Create करते हैं, तो उस Plugin के Install करते ही Normal तरीके से काम करने लायक अवस्था में लाने के लिए उसे कुछ Default Values से Set करते हैं। Plugin से सम्बंधित इन Default Values को सामान्‍यत: WordPress की wp_options नाम की Table में Store किया जाता है।

साथ ही User अपनी जरूरत के अनुसार जब किसी Plugin को Configure करता है, तो उस Plugin से सम्बंधित Modified Values को भी इस wp_options Table में Store किया जाता है तथा जब Plugin को Deactivate या Uninstall किया जाता है, तब wp_options Table में से Plugin Related सभी Settings को Remove किया जाता है।

Plugin से सम्बंधित Options को wp_options Table में Add, Update या Delete करने के लिए WordPress API हमें कुछ Basic Functions Provide करता है, जिनके बारे में हम इस Section के अन्तर्गत समझेंगे।

Saving Plugin Options

जब हम हमारे किसी Plugin से सम्बंधित किसी Option के Data को Save करना चाहते हैं, तो Plugin Related इस प्रकार के Initialization या Updating Related Data को wp_options Table में Save करने के लिए WordPress हमें add_option() व update_option() नाम के दो API Functions Provide करता है।

इन दोनों Functions में update_option() नाम का Function न केवल किसी Plugin Setting के Data को wp_options Table में Initialize करता है बल्कि जब हम हमारे Plugin की किसी Setting को Change करते हैं, तो उस Change को wp_options Table में Update करने के लिए भी इसी Function को Use किया जाता है।

जबकि add_option() Function का प्रयोग केवल किसी Setting के मान को wp_options Table में Add करने यानी Insert करने के लिए ही किया जा सकता है। add_option() Function का Syntax निम्नानुसार होता है:

add_option(‘option_name’, ‘option_value’);

इस Function में option_name हमारे Plugin Related उस Option का नाम है, जिस नाम का Option हम wp_options Table में Store करना चाहते हैं, जबकि option_value उस Newly Create होने वाले option_name की Value है।

option_name एक Required Field होने के साथ&साथ Unique Field भी होता है। इसलिए ये जरूरी होता है कि हम option_name के रूप में जो नाम Specify करें, वह नाम wp_options Table के option_value नाम के Column में पहले से Exist न हो।

option_name की तरह ही option_value भी एक Required Field होता है, जिसमें हम जरूरत के अनुसार String, Array, Object, Serialized Value जैसे किसी भी मान को Store कर सकते हैं।

नया मान Create करने के लिए हम update_option() API Function का भी प्रयोग कर सकते हैं। जब हम इस Function का प्रयोग करते हैं, तब WordPress सबसे पहले इस बात को Check करता है कि option_name नाम का Option wp_options Table में पहले से Exist है या नहीं।

यदि ये Option पहले से Exist न हो, तो wp_options Table में Specified नाम का नया Option Create होता है जबकि यदि option_name पहले से Exist हो, तो ये Function केवल उस पहले से Created Option के option_value को ही Change कर देता है। update_option() API Function का Syntax भी निम्नानुसार add_option() API Function के समान ही होता है:

update_option(‘option_name’, ‘option_value’);

जिस तरह से WordPress हमें किसी Setting को wp_options Table में Store करने के लिए add_option() व update_option() नाम के दो API Function Provide करता है, उसी तरह से इस Table में Store किए गए किसी Setting के मान को Retrieve करने के लिए भी WordPress हमें get_option() नाम का एक API Function Provide करता है। इस Function का Syntax निम्नानुसार होता है:

get_option(‘option_name’);

जब हम इस Function को Use करते हैं, तब हमें wp_options Table से जिस option_name की Value को Retrieve करना होता है, उसका नाम इस Function में option_name की तरह Parameter के रूप में Specify करते हैं।

यदि Parameter के रूप में Specified Option, wp_options Table में Exist होता है, तो ये Function उस option_name File के साथ Associated option_value Field के मान को Return करता है। जबकि यदि यदि Parameter के रूप में Specified Option, wp_options Table में Exist न हो, तो ये Function FALSE Return करता है।

जब हम किसी Plugin की Settings को wp_options Table में Store कर रहे होते हैं, तब बेहतर यही होता है कि हम अपने option_name के रूप में एक Unique नाम Specify करें जो कि हमारे Plugin का Shortname हो, ताकि हम हमारे किसी भी Option Name को आसानी से Identify कर सकें।

Plugin ही नहीं बल्कि हम किसी Theme के functions.php File में Create किए जाने वाले Functions या Theme के किसी भी Template में Create किए जाने वाले PHP Function द्वारा भी wp_options Table में Store किए जाने वाले Options Create कर सकते हैं। यानी हम जो भी काम किसी Plugin में करते हैं, वे सभी काम हम किसी Theme के functions.php File में भी कर सकते हैं।

Array of Options

यदि हमारे Plugin से Related बहुत सारे Options को Database के wp_options Table में Store करना हो, तो बेहतर यही होता है कि हम उन सभी Options को एक Array के रूप में Store करें। ऐसा करने से हमारे Plugin की Performance पर Negative Impact नहीं पडता क्योंकि सभी Options को wp_options Table में Save या Retrieve करने के लिए MySQL Database पर केवल एक ही Query Fire होती है। ये काम हम निम्नानुसार कर सकते हैं:

<?php
	$cp_options_arr=array(
		"cp_display_mode"=>'Happy',
		"cp_default_browser"=>'Chrome',
		"cp_favorite_book"=>'PHP in Hindi',
	);
	update_option('cp_plugin_options', $cp_options_arr);
?>

जैसाकि हम इस Code द्वारा समझ सकते हैं कि हमने इस Code में $cp_options_arr नाम का एक Array Create किया है और इस Array में Elements के रूप में तीन Options को Specify किया है, जो कि हमारे Plugin के तीन अलग Settings को Represent कर रहे हैं। फिर इन तीनों Options के Group यानी Array को एक Single Update Statement द्वारा WordPress के wp_options Table में Save कर दिया है।

जब हमें इस प्रकार के Array के रूप में Stored Settings को wp_options Table से Retrieve करना होता है, तब भी हम get_option() API Function को ही Use करते हैं तथा Return होने वाले Array के विभिन्न Settings को निम्नानुसार तरीके से Access कर सकते हैं:

<?php
	$cp_options_arr = get_option('cp_plugin_options');
	$cp_display_mode =  $cp_options_arr['cp_display_mode'];
	$cp_default_browser =  $cp_options_arr['cp_default_browser'];
	$cp_favorite_book =  $cp_options_arr['cp_favorite_book'];
?>

इस प्रकार से हम हमारे किसी Custom Plugin/Theme के किसी Option या Setting के Data को add_option() व update_option() API Function द्वारा wp_options Table में Store कर सकते हैं और जरूरत के अनुसार get_option() API Function का प्रयोग करके उसे फिर से Retrieve कर सकते हैं।