Util.php
7.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
<?php
// Various utilities
class scbUtil {
// Force script enqueue
static function do_scripts( $handles ) {
global $wp_scripts;
if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
$wp_scripts = new WP_Scripts();
}
$wp_scripts->do_items( (array) $handles );
}
// Force style enqueue
static function do_styles( $handles ) {
self::do_scripts( 'jquery' );
global $wp_styles;
if ( ! is_a( $wp_styles, 'WP_Styles' ) ) {
$wp_styles = new WP_Styles();
}
ob_start();
$wp_styles->do_items( (array) $handles );
$content = str_replace( array( "'", "\n" ), array( '"', '' ), ob_get_clean() );
echo "<script type='text/javascript'>\n";
echo "jQuery(function ($) { $('head').prepend('$content'); });\n";
echo '</script>';
}
// Enable delayed activation; to be used with scb_init()
static function add_activation_hook( $plugin, $callback ) {
if ( defined( 'SCB_LOAD_MU' ) ) {
register_activation_hook( $plugin, $callback );
} else {
add_action( 'scb_activation_' . plugin_basename( $plugin ), $callback );
}
}
// For debugging
static function do_activation( $plugin ) {
do_action( 'scb_activation_' . plugin_basename( $plugin ) );
}
// Allows more than one uninstall hooks.
// Also prevents an UPDATE query on each page load.
static function add_uninstall_hook( $plugin, $callback ) {
if ( ! is_admin() ) {
return;
}
register_uninstall_hook( $plugin, '__return_false' ); // dummy
add_action( 'uninstall_' . plugin_basename( $plugin ), $callback );
}
// For debugging
static function do_uninstall( $plugin ) {
do_action( 'uninstall_' . plugin_basename( $plugin ) );
}
// Get the current, full URL
static function get_current_url() {
return ( is_ssl() ? 'https://' : 'http://' ) . sanitize_text_field( $_SERVER['HTTP_HOST'] ) . sanitize_text_field( $_SERVER['REQUEST_URI'] );
}
// Apply a function to each element of a ( nested ) array recursively
static function array_map_recursive( $callback, $array ) {
array_walk_recursive( $array, array( __CLASS__, 'array_map_recursive_helper' ), $callback );
return $array;
}
static function array_map_recursive_helper( &$val, $key, $callback ) {
$val = call_user_func( $callback, $val );
}
// Extract certain $keys from $array
static function array_extract( $array, $keys ) {
_deprecated_function( __CLASS__ . '::' . __FUNCTION__, 'WP 3.1', 'wp_array_slice_assoc()' );
return wp_array_slice_assoc( $array, $keys );
}
// Extract a certain value from a list of arrays
static function array_pluck( $array, $key ) {
_deprecated_function( __CLASS__ . '::' . __FUNCTION__, 'WP 3.1', 'wp_list_pluck()' );
return wp_list_pluck( $array, $key );
}
// Transform a list of objects into an associative array
static function objects_to_assoc( $objects, $key, $value ) {
_deprecated_function( __CLASS__ . '::' . __FUNCTION__, 'r41', 'scb_list_fold()' );
return scb_list_fold( $objects, $key, $value );
}
// Prepare an array for an IN statement
static function array_to_sql( $values ) {
foreach ( $values as &$val ) {
$val = "'" . esc_sql( trim( $val ) ) . "'";
}
return implode( ',', $values );
}
// Example: split_at( '</', '<a></a>' ) => array( '<a>', '</a>' )
static function split_at( $delim, $str ) {
$i = strpos( $str, $delim );
if ( false === $i ) {
return false;
}
$start = substr( $str, 0, $i );
$finish = substr( $str, $i );
return array( $start, $finish );
}
}
// Return a standard admin notice
function scb_admin_notice( $msg, $class = 'updated' ) {
return html( "div class='$class fade'", html( 'p', $msg ) );
}
// Transform a list of objects into an associative array
function scb_list_fold( $list, $key, $value ) {
$r = array();
if ( is_array( reset( $list ) ) ) {
foreach ( $list as $item ) {
$r[ $item[ $key ] ] = $item[ $value ];
}
} else {
foreach ( $list as $item ) {
$r[ $item->$key ] = $item->$value;
}
}
return $r;
}
/**
* Splits a list into sets, grouped by the result of running each value through $fn.
*
* @param array List of items to be partitioned
* @param callback Function that takes an element and returns a string key
*/
function scb_list_group_by( $list, $fn ) {
$groups = array();
foreach ( $list as $item ) {
$key = call_user_func( $fn, $item );
if ( null === $key ) {
continue;
}
$groups[ $key ][] = $item;
}
return $groups;
}
// _____Database Table Utilities_____
/**
* Register a table with $wpdb
*
* @param string $key The key to be used on the $wpdb object
* @param string $name The actual name of the table, without $wpdb->prefix
*/
function scb_register_table( $key, $name = false ) {
global $wpdb;
if ( ! $name ) {
$name = $key;
}
$wpdb->tables[] = $name;
$wpdb->$key = $wpdb->prefix . $name;
}
/**
* Runs the SQL query for installing/upgrading a table
*
* @param string $key The key used in scb_register_table()
* @param string $columns The SQL columns for the CREATE TABLE statement
* @param array $opts Various other options
*/
function scb_install_table( $key, $columns, $opts = array() ) {
global $wpdb;
$full_table_name = $wpdb->$key;
if ( is_string( $opts ) ) {
$opts = array( 'upgrade_method' => $opts );
}
$opts = wp_parse_args(
$opts,
array(
'upgrade_method' => 'dbDelta',
'table_options' => '',
)
);
$charset_collate = '';
if ( $wpdb->has_cap( 'collation' ) ) {
if ( ! empty( $wpdb->charset ) ) {
$charset_collate = "DEFAULT CHARACTER SET $wpdb->charset";
}
if ( ! empty( $wpdb->collate ) ) {
$charset_collate .= " COLLATE $wpdb->collate";
}
}
$table_options = $charset_collate . ' ' . $opts['table_options'];
if ( 'dbDelta' == $opts['upgrade_method'] ) {
require_once ABSPATH . 'wp-admin/includes/upgrade.php';
dbDelta( "CREATE TABLE $full_table_name ( $columns ) $table_options" );
return;
}
if ( 'delete_first' == $opts['upgrade_method'] ) {
$wpdb->query( "DROP TABLE IF EXISTS $full_table_name;" );
}
$wpdb->query( "CREATE TABLE IF NOT EXISTS $full_table_name ( $columns ) $table_options;" );
}
function scb_uninstall_table( $key ) {
global $wpdb;
$wpdb->query( 'DROP TABLE IF EXISTS ' . $wpdb->$key );
}
// _____Minimalist HTML framework_____
/**
* Generate an HTML tag. Atributes are escaped. Content is NOT escaped.
*/
if ( ! function_exists( 'html' ) ) :
function html( $tag ) {
static $SELF_CLOSING_TAGS = array( 'area', 'base', 'basefont', 'br', 'hr', 'input', 'img', 'link', 'meta' );
$args = func_get_args();
$tag = array_shift( $args );
if ( is_array( $args[0] ) ) {
$closing = $tag;
$attributes = array_shift( $args );
foreach ( $attributes as $key => $value ) {
if ( false === $value ) {
continue;
}
if ( true === $value ) {
$value = $key;
}
$tag .= ' ' . $key . '="' . esc_attr( $value ) . '"';
}
} else {
list( $closing ) = explode( ' ', $tag, 2 );
}
if ( in_array( $closing, $SELF_CLOSING_TAGS ) ) {
return "<{$tag} />";
}
$content = implode( '', $args );
return "<{$tag}>{$content}</{$closing}>";
}
endif;
// Generate an <a> tag
if ( ! function_exists( 'html_link' ) ) :
function html_link( $url, $title = '' ) {
if ( empty( $title ) ) {
$title = $url;
}
return html( 'a', array( 'href' => $url ), $title );
}
endif;
function scb_get_query_flags( $wp_query = null ) {
if ( ! $wp_query ) {
$wp_query = $GLOBALS['wp_query'];
}
$flags = array();
foreach ( get_object_vars( $wp_query ) as $key => $val ) {
if ( 'is_' == substr( $key, 0, 3 ) && $val ) {
$flags[] = substr( $key, 3 );
}
}
return $flags;
}
// _____Compatibility layer_____
// WP < ?
if ( ! function_exists( 'set_post_field' ) ) :
function set_post_field( $field, $value, $post_id ) {
global $wpdb;
$post_id = absint( $post_id );
$value = sanitize_post_field( $field, $value, $post_id, 'db' );
return $wpdb->update( $wpdb->posts, array( $field => $value ), array( 'ID' => $post_id ) );
}
endif;