codepress-admin-columns.php
14.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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
<?php
// Exit if accessed directly
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
// Plugin information
define( 'CPAC_VERSION', '2.4.7' ); // Current plugin version
define( 'CPAC_UPGRADE_VERSION', '2.0.0' ); // Latest version which requires an upgrade
define( 'CPAC_URL', plugin_dir_url( __FILE__ ) );
define( 'CPAC_DIR', plugin_dir_path( __FILE__ ) );
// Only run plugin in the admin interface
if ( ! is_admin() ) {
return false;
}
/**
* Dependencies
*
* @since 1.3.0
*/
require_once CPAC_DIR . 'classes/utility.php';
require_once CPAC_DIR . 'classes/third_party.php';
require_once CPAC_DIR . 'includes/arrays.php';
require_once CPAC_DIR . 'api.php';
/**
* The Admin Columns Class
*
* @since 1.0
*/
class CPAC {
/**
* Registered storage model class instances
* Array of CPAC_Storage_Model instances, with the storage model keys (e.g. post, page, wp-users) as keys
*
* @since 2.0
* @var array
*/
public $storage_models;
/**
* Admin Columns add-ons class instance
*
* @since 2.2
* @access private
* @var CPAC_Addons
*/
private $_addons;
/**
* Admin Columns settings class instance
*
* @since 2.2
* @access private
* @var CPAC_Settings
*/
private $_settings;
/**
* Admin Columns plugin upgrade class instance
*
* @since 2.2.7
* @access private
* @var CPAC_Upgrade
*/
private $_upgrade;
/**
* Column settings to import from a column PHP export
*
* @since 2.4.7
* @var array
*/
public $exported_columns;
/**
* @since 1.0
*/
function __construct() {
register_activation_hook( __FILE__, array( $this, 'set_capabilities' ) );
// Hooks
add_action( 'init', array( $this, 'localize' ) );
add_action( 'wp_loaded', array( $this, 'maybe_set_storage_models' ), 5 );
add_action( 'wp_loaded', array( $this, 'maybe_load_php_export' ) );
add_action( 'wp_loaded', array( $this, 'after_setup' ) ); // Setup callback, important to load after set_storage_models
add_action( 'admin_enqueue_scripts', array( $this, 'scripts' ) );
add_filter( 'plugin_action_links', array( $this, 'add_settings_link' ), 1, 2 );
// Settings
include_once CPAC_DIR . 'classes/settings.php';
$this->_settings = new CPAC_Settings( $this );
// Addons
include_once CPAC_DIR . 'classes/addons.php';
$this->_addons = new CPAC_Addons( $this );
// Upgrade
require_once CPAC_DIR . 'classes/upgrade.php';
$this->_upgrade = new CPAC_Upgrade( $this );
// Settings
include_once CPAC_DIR . 'classes/review_notice.php';
new CPAC_Review_Notice( $this );
}
/**
* Fire callbacks for admin columns setup completion
*
* @since 2.2
*/
public function after_setup() {
/**
* Fires when Admin Columns is fully loaded
* Use this for setting up addon functionality
*
* @since 2.0
* @param CPAC $cpac_instance Main Admin Columns plugin class instance
*/
do_action( 'cac/loaded', $this );
}
/**
* @since 2.2
* @uses load_plugin_textdomain()
*/
public function localize() {
load_plugin_textdomain( 'codepress-admin-columns', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
}
/**
* @since 2.2.4
*/
public function scripts() {
$minified = defined('SCRIPT_DEBUG') && SCRIPT_DEBUG ? '' : '.min';
wp_register_script( 'cpac-admin-columns', CPAC_URL . "assets/js/admin-columns{$minified}.js", array( 'jquery', 'jquery-qtip2' ), CPAC_VERSION );
wp_register_script( 'jquery-qtip2', CPAC_URL . "external/qtip2/jquery.qtip{$minified}.js", array( 'jquery' ), CPAC_VERSION );
wp_register_style( 'jquery-qtip2', CPAC_URL . "external/qtip2/jquery.qtip{$minified}.css", array(), CPAC_VERSION, 'all' );
wp_register_style( 'cpac-columns', CPAC_URL . "assets/css/column{$minified}.css", array(), CPAC_VERSION, 'all' );
if ( $this->is_columns_screen() ) {
add_filter( 'admin_body_class', array( $this, 'admin_class' ) );
add_action( 'admin_head', array( $this, 'admin_scripts') );
wp_enqueue_script( 'cpac-admin-columns' );
wp_enqueue_style( 'jquery-qtip2' );
wp_enqueue_style( 'cpac-columns' );
}
}
/**
* Add capabilty to administrator to manage admin columns.
* You can use the capability 'manage_admin_columns' to grant other roles this privilidge as well.
*
* @since 2.0.4
*/
public function set_capabilities() {
if ( $role = get_role( 'administrator' ) ) {
$role->add_cap( 'manage_admin_columns' );
}
}
/**
* Load the storage models if the current screen is a columns screen
*
* @since 2.2.7
*/
public function maybe_set_storage_models() {
if ( ! $this->is_cac_screen() ) {
return;
}
$this->set_storage_models();
}
/**
* Load the php exported settings
*
* @since 2.3.5
*/
public function maybe_load_php_export() {
if ( ! empty( $this->exported_columns ) ) {
foreach( $this->exported_columns as $model => $columns ) {
if ( $storage_model = $this->get_storage_model( $model ) ) {
$storage_model->set_stored_columns( $columns );
}
}
}
}
/**
* Load the storage models, storing them in the storage_models property of this object
*
* @since 2.0
*/
public function set_storage_models() {
$storage_models = array();
// Load storage model class files and column base class files
require_once CPAC_DIR . 'classes/column.php';
require_once CPAC_DIR . 'classes/column/default.php';
require_once CPAC_DIR . 'classes/column/actions.php';
require_once CPAC_DIR . 'classes/storage_model.php';
require_once CPAC_DIR . 'classes/storage_model/post.php';
require_once CPAC_DIR . 'classes/storage_model/user.php';
require_once CPAC_DIR . 'classes/storage_model/media.php';
require_once CPAC_DIR . 'classes/storage_model/comment.php';
require_once CPAC_DIR . 'classes/storage_model/link.php';
// Create a storage model per post type
foreach ( $this->get_post_types() as $post_type ) {
$storage_model = new CPAC_Storage_Model_Post( $post_type );
$storage_models[ $storage_model->key ] = $storage_model;
}
// Create other storage models
$storage_model = new CPAC_Storage_Model_User();
$storage_models[ $storage_model->key ] = $storage_model;
$storage_model = new CPAC_Storage_Model_Media();
$storage_models[ $storage_model->key ] = $storage_model;
$storage_model = new CPAC_Storage_Model_Comment();
$storage_models[ $storage_model->key ] = $storage_model;
if ( apply_filters( 'pre_option_link_manager_enabled', false ) ) { // as of 3.5 link manager is removed
$storage_model = new CPAC_Storage_Model_Link();
$storage_models[ $storage_model->key ] = $storage_model;
}
/**
* Filter the available storage models
* Used by external plugins to add additional storage models
*
* @since 2.0
* @param array $storage_models List of storage model class instances ( [key] => [CPAC_Storage_Model object], where [key] is the storage key, such as "user", "post" or "my_custom_post_type")
* @param object $this CPAC
*/
$this->storage_models = apply_filters( 'cac/storage_models', $storage_models, $this );
}
/**
* Retrieve a storage model object based on its key
*
* @since 2.0
*
* @param string $key Storage model key (e.g. post, page, wp-users)
* @return bool|CPAC_Storage_Model Storage Model object (or false, on failure)
*/
public function get_storage_model( $key ) {
if ( isset( $this->storage_models[ $key ] ) ) {
return $this->storage_models[ $key ];
}
return false;
}
/**
* Get storage model object of currently active storage model
* On the users overview page, for example, this returns the CPAC_Storage_Model_User object
*
* @since 2.2.4
*
* @return CPAC_Storage_Model
*/
public function get_current_storage_model() {
if ( $this->storage_models ) {
foreach ( $this->storage_models as $storage_model ) {
if ( $storage_model->is_columns_screen() ) {
return $storage_model;
}
}
}
}
/**
* Get a list of post types for which Admin Columns is active
*
* @since 1.0
*
* @return array List of post type keys (e.g. post, page)
*/
public function get_post_types() {
$post_types = array();
if ( post_type_exists( 'post' ) ) {
$post_types['post'] = 'post';
}
if ( post_type_exists( 'page' ) ) {
$post_types['page'] = 'page';
}
$post_types = array_merge( $post_types, get_post_types( array(
'_builtin' => false,
'show_ui' => true
) ) );
/**
* Filter the post types for which Admin Columns is active
*
* @since 2.0
* @param array $post_types List of active post type names
*/
return apply_filters( 'cac/post_types', $post_types );
}
/**
* Get a list of taxonomies supported by Admin Columns
*
* @since 1.0
*
* @return array List of taxonomies
*/
public function get_taxonomies() {
$taxonomies = get_taxonomies( array( 'public' => true ) );
if ( isset( $taxonomies['post_format'] ) ) {
unset( $taxonomies['post_format'] );
}
/**
* Filter the post types for which Admin Columns is active
*
* @since 2.0
* @param array $post_types List of active post type names
*/
return apply_filters( 'cac/taxonomies', $taxonomies );
}
/**
* Add a settings link to the Admin Columns entry in the plugin overview screen
*
* @since 1.0
* @see filter:plugin_action_links
*/
public function add_settings_link( $links, $file ) {
if ( $file != plugin_basename( __FILE__ ) ) {
return $links;
}
array_unshift( $links, '<a href="' . esc_url( admin_url( "options-general.php?page=codepress-admin-columns" ) ) . '">' . __( 'Settings' ) . '</a>' );
return $links;
}
/**
* Adds a body class which is used to set individual column widths
*
* @since 1.4.0
*
* @param string $classes body classes
* @return string
*/
public function admin_class( $classes ) {
if ( $storage_model = $this->get_current_storage_model() ) {
$classes .= " cp-{$storage_model->key}";
}
return $classes;
}
/**
* Admin CSS for Column width and Settings Icon
*
* @since 1.4.0
*/
public function admin_scripts() {
if ( ! ( $storage_model = $this->get_current_storage_model() ) ) {
return;
}
$css_column_width = '';
$edit_link = '';
// CSS: columns width
if ( $columns = $storage_model->get_stored_columns() ) {
foreach ( $columns as $name => $options ) {
if ( ! empty( $options['width'] ) && is_numeric( $options['width'] ) && $options['width'] > 0 ) {
$unit = isset( $options['width_unit'] ) ? $options['width_unit'] : '%';
$css_column_width .= ".cp-{$storage_model->key} .wrap table th.column-{$name} { width: {$options['width']}{$unit} !important; }";
}
// Load custom column scripts, used by 3rd party columns
if ( $column = $storage_model->get_column_by_name( $name ) ) {
$column->scripts();
}
}
}
// JS: edit button
$general_options = get_option( 'cpac_general_options' );
if ( current_user_can( 'manage_admin_columns' ) && ( ! isset( $general_options['show_edit_button'] ) || '1' === $general_options['show_edit_button'] ) ) {
$edit_link = $storage_model->get_edit_link();
}
?>
<?php if ( $css_column_width ) : ?>
<style type="text/css">
<?php echo $css_column_width; ?>
</style>
<?php endif; ?>
<?php if ( $edit_link ) : ?>
<script type="text/javascript">
jQuery(document).ready(function() {
jQuery('.tablenav.top .actions:last').append('');
});
</script>
<?php endif; ?>
<?php
/**
* Add header scripts that only apply to column screens.
* @since 2.3.5
* @param object CPAC Main Class
*/
do_action( 'cac/admin_head', $storage_model, $this );
}
/**
* Whether this request is an AJAX request and marked as admin-column-ajax or inline-save request.
*
* @since 2.2
* @return bool Returns true if in an AJAX request, false otherwise
*/
public function is_doing_ajax() {
return cac_is_doing_ajax();
}
/**
* Whether this request is a columns screen (i.e. a content overview page)
*
* @since 2.2
* @return bool Returns true if the current screen is a columns screen, false otherwise
*/
public function is_columns_screen() {
global $pagenow;
$columns_screen = in_array( $pagenow, array( 'edit.php', 'upload.php', 'link-manager.php', 'edit-comments.php', 'users.php', 'edit-tags.php' ) );
/**
* Filter whether the current screen is a columns screen (i.e. a content overview page)
* Useful for advanced used with custom content overview pages
*
* @since 2.2
* @param bool $columns_screen Whether the current request is a columns screen
*/
$columns_screen = apply_filters( 'cac/is_columns_screen', $columns_screen );
return $columns_screen;
}
/**
* Whether the current screen is the Admin Columns settings screen
*
* @since 2.2
* @param strong $tab Specifies a tab screen (optional)
* @return bool True if the current screen is the settings screen, false otherwise
*/
public function is_settings_screen( $tab = '' ) {
global $pagenow;
if ( ! ( 'options-general.php' === $pagenow && isset( $_GET['page'] ) && ( 'codepress-admin-columns' === $_GET['page'] ) ) ) {
return false;
}
if ( $tab && ( empty( $_GET['tab'] ) || ( isset( $_GET['tab'] ) && $tab !== $_GET['tab'] ) ) ) {
return false;
}
return true;
}
/**
* Whether the current screen is a screen in which Admin Columns is used
* Used to check whether storage models should be loaded
*
* @since 2.2
* @return bool Whether the current screen is an Admin Columns screen
*/
public function is_cac_screen() {
/**
* Filter whether the current screen is a screen in which Admin Columns is active
*
* @since 2.2
* @param bool $is_cac_screen Whether the current screen is an Admin Columns screen
*/
return apply_filters( 'cac/is_cac_screen', $this->is_columns_screen() || $this->is_doing_ajax() || $this->is_settings_screen() );
}
/**
* Get admin columns settings class instance
*
* @since 2.2
* @return CPAC_Settings Settings class instance
*/
public function settings() {
return $this->_settings;
}
/**
* Get admin columns add-ons class instance
*
* @since 2.2
* @return CPAC_Addons Add-ons class instance
*/
public function addons() {
return $this->_addons;
}
/**
* Get admin columns upgrade class instance
*
* @since 2.2.7
* @return CPAC_Upgrade Upgrade class instance
*/
public function upgrade() {
return $this->_upgrade;
}
}
/**
* Admin Columns class (global for backwards compatibility)
*
* @since 1.0
* @deprecated 2.2.7 Use filter cac/loaded instead.
*/
global $cpac;
/**
* Initialize Admin Columns class
*
* @since 1.0
*/
$cpac = new CPAC();