give / includes / setting-functions.php

setting-functions.php in GiveWP – Donation Plugin and Fundraising Platform 2.16.0, at includes/setting-functions.php

203 lines 4.4 KB

Raw Download Zip

1	<?php
2	/**
3	* Helps get a single option from the give_get_settings() array.
4	*
5	* @since 0.1.0
6	*
7	* @param string $key Options array key
8	* @param string\|bool $default The default option if the option isn't set
9	*
10	* @return mixed Option value
11	*/
12	function give_get_option( $key = '', $default = false ) {
13	$give_options = give_get_settings();
14	$value = ! empty( $give_options[ $key ] ) ? $give_options[ $key ] : $default;
15	$value = apply_filters( 'give_get_option', $value, $key, $default );
16
17	return apply_filters( "give_get_option_{$key}", $value, $key, $default );
18	}
19
20
21	/**
22	* Update an option
23	*
24	* Updates an give setting value in both the db and the global variable.
25	* Warning: Passing in an empty, false or null string value will remove
26	* the key from the give_options array.
27	*
28	* @since 1.0
29	*
30	* @param string $key The Key to update
31	* @param string\|bool\|int $value The value to set the key to
32	*
33	* @return boolean True if updated, false if not.
34	*/
35	function give_update_option( $key = '', $value = false ) {
36
37	// If no key, exit
38	if ( empty( $key ) ) {
39	return false;
40	}
41
42	if ( empty( $value ) ) {
43	$remove_option = give_delete_option( $key );
44
45	return $remove_option;
46	}
47
48	// First let's grab the current settings.
49	$options = give_get_settings();
50
51	// Let's developers alter that value coming in.
52	$value = apply_filters( 'give_update_option', $value, $key );
53
54	// Next let's try to update the value
55	$options[ $key ] = $value;
56	$did_update = update_option( 'give_settings', $options, false );
57
58	// If it updated, let's update the global variable
59	if ( $did_update ) {
60	global $give_options;
61	$give_options[ $key ] = $value;
62	}
63
64	return $did_update;
65	}
66
67	/**
68	* Remove an option
69	*
70	* Removes an give setting value in both the db and the global variable.
71	*
72	* @since 1.0
73	*
74	* @global $give_options
75	*
76	* @param string $key The Key to delete
77	*
78	* @return boolean True if updated, false if not.
79	*/
80	function give_delete_option( $key = '' ) {
81
82	// If no key, exit
83	if ( empty( $key ) ) {
84	return false;
85	}
86
87	// First let's grab the current settings
88	$options = get_option( 'give_settings' );
89
90	// Next let's try to update the value
91	if ( isset( $options[ $key ] ) ) {
92	unset( $options[ $key ] );
93	}
94
95	$did_update = update_option( 'give_settings', $options, false );
96
97	// If it updated, let's update the global variable
98	if ( $did_update ) {
99	global $give_options;
100	$give_options = $options;
101	}
102
103	return $did_update;
104	}
105
106
107	/**
108	* Get Settings
109	*
110	* Retrieves all Give plugin settings
111	*
112	* @since 1.0
113	* @return array Give settings
114	*/
115	function give_get_settings() {
116	return Give_Cache_Setting::get_settings();
117	}
118
119	/**
120	* Check if radio(enabled/disabled) and checkbox(on) is active or not.
121	*
122	* @since 1.8
123	*
124	* @param mixed $value
125	* @param string $compare_with
126	*
127	* @return bool
128	*/
129	function give_is_setting_enabled( $value, $compare_with = null ) {
130	if ( ! is_null( $compare_with ) ) {
131
132	if ( is_array( $compare_with ) ) {
133	// Output.
134	return in_array( $value, $compare_with );
135	}
136
137	// Output.
138	return ( $value === $compare_with );
139	}
140
141	// Backward compatibility: From version 1.8 most of setting is modified to enabled/disabled
142	// Output.
143	return ( in_array( $value, array( 'enabled', 'on', 'yes' ) ) ? true : false );
144	}
145
146	/**
147	* Verify admin setting nonce
148	*
149	* @since 2.4.0
150	* @access public
151	*
152	* @return bool
153	*/
154	function give_is_saving_settings() {
155	if (
156	empty( $_REQUEST['_give-save-settings'] )
157	\|\| ! wp_verify_nonce( $_REQUEST['_give-save-settings'], 'give-save-settings' )
158	) {
159	return false;
160	}
161
162	return true;
163	}
164
165
166	/**
167	* Give Settings Array Insert.
168	*
169	* Allows other Add-ons and plugins to insert Give settings at a desired position.
170	*
171	* @since 1.3.5
172	*
173	* @param $array
174	* @param $position \|int\|string Expects an array key or 'id' of the settings field to appear after
175	* @param $insert \|array a valid array of options to insert
176	*
177	* @return array
178	*/
179	function give_settings_array_insert( $array, $position, $insert ) {
180	if ( is_int( $position ) ) {
181	array_splice( $array, $position, 0, $insert );
182	} else {
183
184	foreach ( $array as $index => $subarray ) {
185	if ( isset( $subarray['id'] ) && $subarray['id'] == $position ) {
186	$pos = $index;
187	}
188	}
189
190	if ( ! isset( $pos ) ) {
191	return $array;
192	}
193
194	$array = array_merge(
195	array_slice( $array, 0, $pos ),
196	$insert,
197	array_slice( $array, $pos )
198	);
199	}
200
201	return $array;
202	}
203