Description
Retrieve the requested option value depending on the $atts array- If the $field is available in $atts then this value is used, if it has a value.
- We're trying to eliminate alt=1 or alt=2 in favour of user fields but only if oik-user is active.
- The alt= keyword overrides the user= keyword, for backward compatibility
- Use user=0 or alt=0 to force the use of "oik options"
- Use alt=1 or alt=2 to use "more options" or "more options 2"
| oik-user | alt= | user= | author | processing |
|---|---|---|---|---|
| active | set | n/a | n/a | use the alt= value ( 0 is treated as ” ) |
| active | null | set | n/a | use the value specified for the user options |
| active | null | null | null | use oik options |
| active | null | null | set | use the user options |
| inactive | set | n/a | n/a | use the alt= value |
| inactive | null | n/a | n/a | use the oik options |
Usage
$string = bw_get_option_arr( $field, $set, $atts );Parameters
- $field
- ( string ) required – the name of the field to obtain
- $set
- ( string ) optional default: bw_options – the name of the set from which to obtain the field
- $atts
- ( array ) optional – the set of parameters which may include user= or alt= values
Returns
string the value of the required option or nullSource
File name: oik/includes/bobbcomp.phpLines:
1 to 27 of 27
function bw_get_option_arr( $field, $set="bw_options", $atts=null ) { $option = bw_array_get( $atts, $field, null ); if ( null === $option ) { $alt = bw_array_get( $atts, "alt", null ); if ( is_callable( "oiku_loaded" ) ) { if ( $alt === null ) { $user = bw_array_get_dcb( $atts, "user", false, "bw_default_user" ); if ( $user ) { $option = bw_get_user_option( $user, $field, $set ); } } else { $user = null; } } else { $user = null; } if ( !$user ) { if ( !$set ) { $set="bw_options"; } if ( $alt == "0" ) $alt = ""; $option = bw_get_option( $field, "$set$alt" ); } } return( $option ); }View on GitHub View on Trac
Called by
1 to 15 of 17
- bw_address() – Implement [bw_address] shortcode to display an address using Microformats
- bw_contact_form() – Implements the [bw_contact_form] shortcode
- bw_directions() – Implement the [bw_directions] shortcode to generate a button to get directions from Google Maps
- bw_follow() – Create a styled follow me button
- bw_follow_e() – Produce a ‘follow me’ button if there is a value for the selected social network
- bw_geo() – Implement [bw_geo] shortcode
- bw_get_me() – Return the tooltip value for "me"
- bw_show_googlemap() – Implements [bw_show_googlemap] shortcode to display a Google Map
- bw_skype() – Implement [bw_skype] shortcode to display the Skype contact information
- Tests_oik_bobbcomp::test_bw_get_option_arr_field_not_present_in_atts() – Here we set alt=0 to prevent oik-user from becoming involved We request a field that should’t exist in ‘bw_options’, so expect null to be returned.
- Tests_oik_bobbcomp::test_bw_get_option_arr_field_present_in_atts() – Specifically to test issue #72 – bw_get_option_arr() should return the parameter value from $atts if set
- Tests_oik_follow::test_follow_me_with_github_set() – Test the Follow me for GitHub
- Tests_oik_follow::test_follow_me_with_github_set_bb_BB() – Test the Follow me for GitHub – bb_BB
- Tests_oik_follow::test_follow_me_with_wordpress_set() – Tests issue #61 – Option field for WordPress.org
- _bw_email() – Internal function for bw_email and bw_mailto
Invoked by
Calls
1 to 4 of 4
- bw_array_get() – Return the array[index] or array->index (for an object) or a default value if not set
- bw_array_get_dcb() – Return the array[index] or build the result by calling $callback, passing the $default as the arg.
- bw_get_option() – Get the value of an option field
- bw_get_user_option() – Return a user option field – which may come from a composite field
