~canonical-sysadmins/wordpress/4.7.2

« back to all changes in this revision

Viewing changes to wp-admin/includes/screen.php

  • Committer: Jacek Nykis
  • Date: 2015-01-05 16:17:05 UTC
  • Revision ID: jacek.nykis@canonical.com-20150105161705-w544l1h5mcg7u4w9
Initial commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?php
 
2
/**
 
3
 * WordPress Administration Screen API.
 
4
 *
 
5
 * @package WordPress
 
6
 * @subpackage Administration
 
7
 */
 
8
 
 
9
/**
 
10
 * Get the column headers for a screen
 
11
 *
 
12
 * @since 2.7.0
 
13
 *
 
14
 * @param string|WP_Screen $screen The screen you want the headers for
 
15
 * @return array Containing the headers in the format id => UI String
 
16
 */
 
17
function get_column_headers( $screen ) {
 
18
        if ( is_string( $screen ) )
 
19
                $screen = convert_to_screen( $screen );
 
20
 
 
21
        static $column_headers = array();
 
22
 
 
23
        if ( ! isset( $column_headers[ $screen->id ] ) ) {
 
24
 
 
25
                /**
 
26
                 * Filter the column headers for a list table on a specific screen.
 
27
                 *
 
28
                 * The dynamic portion of the hook name, $screen->id, refers to the
 
29
                 * ID of a specific screen. For example, the screen ID for the Posts
 
30
                 * list table is edit-post, so the filter for that screen would be
 
31
                 * manage_edit-post_columns.
 
32
                 *
 
33
                 * @since 3.0.0
 
34
                 *
 
35
                 * @param array $columns An array of column headers. Default empty.
 
36
                 */
 
37
                $column_headers[ $screen->id ] = apply_filters( "manage_{$screen->id}_columns", array() );
 
38
        }
 
39
 
 
40
        return $column_headers[ $screen->id ];
 
41
}
 
42
 
 
43
/**
 
44
 * Get a list of hidden columns.
 
45
 *
 
46
 * @since 2.7.0
 
47
 *
 
48
 * @param string|WP_Screen $screen The screen you want the hidden columns for
 
49
 * @return array
 
50
 */
 
51
function get_hidden_columns( $screen ) {
 
52
        if ( is_string( $screen ) )
 
53
                $screen = convert_to_screen( $screen );
 
54
 
 
55
        return (array) get_user_option( 'manage' . $screen->id . 'columnshidden' );
 
56
}
 
57
 
 
58
/**
 
59
 * Prints the meta box preferences for screen meta.
 
60
 *
 
61
 * @since 2.7.0
 
62
 *
 
63
 * @param string|WP_Screen $screen
 
64
 */
 
65
function meta_box_prefs( $screen ) {
 
66
        global $wp_meta_boxes;
 
67
 
 
68
        if ( is_string( $screen ) )
 
69
                $screen = convert_to_screen( $screen );
 
70
 
 
71
        if ( empty($wp_meta_boxes[$screen->id]) )
 
72
                return;
 
73
 
 
74
        $hidden = get_hidden_meta_boxes($screen);
 
75
 
 
76
        foreach ( array_keys($wp_meta_boxes[$screen->id]) as $context ) {
 
77
                foreach ( array_keys($wp_meta_boxes[$screen->id][$context]) as $priority ) {
 
78
                        foreach ( $wp_meta_boxes[$screen->id][$context][$priority] as $box ) {
 
79
                                if ( false == $box || ! $box['title'] )
 
80
                                        continue;
 
81
                                // Submit box cannot be hidden
 
82
                                if ( 'submitdiv' == $box['id'] || 'linksubmitdiv' == $box['id'] )
 
83
                                        continue;
 
84
                                $box_id = $box['id'];
 
85
                                echo '<label for="' . $box_id . '-hide">';
 
86
                                echo '<input class="hide-postbox-tog" name="' . $box_id . '-hide" type="checkbox" id="' . $box_id . '-hide" value="' . $box_id . '"' . (! in_array($box_id, $hidden) ? ' checked="checked"' : '') . ' />';
 
87
                                echo "{$box['title']}</label>\n";
 
88
                        }
 
89
                }
 
90
        }
 
91
}
 
92
 
 
93
/**
 
94
 * Get Hidden Meta Boxes
 
95
 *
 
96
 * @since 2.7.0
 
97
 *
 
98
 * @param string|WP_Screen $screen Screen identifier
 
99
 * @return array Hidden Meta Boxes
 
100
 */
 
101
function get_hidden_meta_boxes( $screen ) {
 
102
        if ( is_string( $screen ) )
 
103
                $screen = convert_to_screen( $screen );
 
104
 
 
105
        $hidden = get_user_option( "metaboxhidden_{$screen->id}" );
 
106
 
 
107
        $use_defaults = ! is_array( $hidden );
 
108
 
 
109
        // Hide slug boxes by default
 
110
        if ( $use_defaults ) {
 
111
                $hidden = array();
 
112
                if ( 'post' == $screen->base ) {
 
113
                        if ( 'post' == $screen->post_type || 'page' == $screen->post_type || 'attachment' == $screen->post_type )
 
114
                                $hidden = array('slugdiv', 'trackbacksdiv', 'postcustom', 'postexcerpt', 'commentstatusdiv', 'commentsdiv', 'authordiv', 'revisionsdiv');
 
115
                        else
 
116
                                $hidden = array( 'slugdiv' );
 
117
                }
 
118
 
 
119
                /**
 
120
                 * Filter the default list of hidden meta boxes.
 
121
                 *
 
122
                 * @since 3.1.0
 
123
                 *
 
124
                 * @param array     $hidden An array of meta boxes hidden by default.
 
125
                 * @param WP_Screen $screen WP_Screen object of the current screen.
 
126
                 */
 
127
                $hidden = apply_filters( 'default_hidden_meta_boxes', $hidden, $screen );
 
128
        }
 
129
 
 
130
        /**
 
131
         * Filter the list of hidden meta boxes.
 
132
         *
 
133
         * @since 3.3.0
 
134
         *
 
135
         * @param array     $hidden       An array of hidden meta boxes.
 
136
         * @param WP_Screen $screen       WP_Screen object of the current screen.
 
137
         * @param bool      $use_defaults Whether to show the default meta boxes.
 
138
         *                                Default true.
 
139
         */
 
140
        return apply_filters( 'hidden_meta_boxes', $hidden, $screen, $use_defaults );
 
141
}
 
142
 
 
143
/**
 
144
 * Register and configure an admin screen option
 
145
 *
 
146
 * @since 3.1.0
 
147
 *
 
148
 * @param string $option An option name.
 
149
 * @param mixed $args Option-dependent arguments.
 
150
 */
 
151
function add_screen_option( $option, $args = array() ) {
 
152
        $current_screen = get_current_screen();
 
153
 
 
154
        if ( ! $current_screen )
 
155
                return;
 
156
 
 
157
        $current_screen->add_option( $option, $args );
 
158
}
 
159
 
 
160
/**
 
161
 * Get the current screen object
 
162
 *
 
163
 * @since 3.1.0
 
164
 *
 
165
 * @return WP_Screen Current screen object
 
166
 */
 
167
function get_current_screen() {
 
168
        global $current_screen;
 
169
 
 
170
        if ( ! isset( $current_screen ) )
 
171
                return null;
 
172
 
 
173
        return $current_screen;
 
174
}
 
175
 
 
176
/**
 
177
 * Set the current screen object
 
178
 *
 
179
 * @since 3.0.0
 
180
 * @uses $current_screen
 
181
 *
 
182
 * @param mixed $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen,
 
183
 *      or an existing screen object.
 
184
 */
 
185
function set_current_screen( $hook_name = '' ) {
 
186
        WP_Screen::get( $hook_name )->set_current_screen();
 
187
}
 
188
 
 
189
/**
 
190
 * A class representing the admin screen.
 
191
 *
 
192
 * @since 3.3.0
 
193
 * @access public
 
194
 */
 
195
final class WP_Screen {
 
196
        /**
 
197
         * Any action associated with the screen. 'add' for *-add.php and *-new.php screens. Empty otherwise.
 
198
         *
 
199
         * @since 3.3.0
 
200
         * @var string
 
201
         * @access public
 
202
         */
 
203
        public $action;
 
204
 
 
205
        /**
 
206
         * The base type of the screen. This is typically the same as $id but with any post types and taxonomies stripped.
 
207
         * For example, for an $id of 'edit-post' the base is 'edit'.
 
208
         *
 
209
         * @since 3.3.0
 
210
         * @var string
 
211
         * @access public
 
212
         */
 
213
        public $base;
 
214
 
 
215
        /**
 
216
         * The number of columns to display. Access with get_columns().
 
217
         *
 
218
         * @since 3.4.0
 
219
         * @var int
 
220
         * @access private
 
221
         */
 
222
        private $columns = 0;
 
223
 
 
224
        /**
 
225
         * The unique ID of the screen.
 
226
         *
 
227
         * @since 3.3.0
 
228
         * @var string
 
229
         * @access public
 
230
         */
 
231
        public $id;
 
232
 
 
233
        /**
 
234
         * Which admin the screen is in. network | user | site | false
 
235
         *
 
236
         * @since 3.5.0
 
237
         * @var string
 
238
         * @access protected
 
239
         */
 
240
        protected $in_admin;
 
241
 
 
242
        /**
 
243
         * Whether the screen is in the network admin.
 
244
         *
 
245
         * Deprecated. Use in_admin() instead.
 
246
         *
 
247
         * @since 3.3.0
 
248
         * @deprecated 3.5.0
 
249
         * @var bool
 
250
         * @access public
 
251
         */
 
252
        public $is_network;
 
253
 
 
254
        /**
 
255
         * Whether the screen is in the user admin.
 
256
         *
 
257
         * Deprecated. Use in_admin() instead.
 
258
         *
 
259
         * @since 3.3.0
 
260
         * @deprecated 3.5.0
 
261
         * @var bool
 
262
         * @access public
 
263
         */
 
264
        public $is_user;
 
265
 
 
266
        /**
 
267
         * The base menu parent.
 
268
         * This is derived from $parent_file by removing the query string and any .php extension.
 
269
         * $parent_file values of 'edit.php?post_type=page' and 'edit.php?post_type=post' have a $parent_base of 'edit'.
 
270
         *
 
271
         * @since 3.3.0
 
272
         * @var string
 
273
         * @access public
 
274
         */
 
275
        public $parent_base;
 
276
 
 
277
        /**
 
278
         * The parent_file for the screen per the admin menu system.
 
279
         * Some $parent_file values are 'edit.php?post_type=page', 'edit.php', and 'options-general.php'.
 
280
         *
 
281
         * @since 3.3.0
 
282
         * @var string
 
283
         * @access public
 
284
         */
 
285
        public $parent_file;
 
286
 
 
287
        /**
 
288
         * The post type associated with the screen, if any.
 
289
         * The 'edit.php?post_type=page' screen has a post type of 'page'.
 
290
         * The 'edit-tags.php?taxonomy=$taxonomy&post_type=page' screen has a post type of 'page'.
 
291
         *
 
292
         * @since 3.3.0
 
293
         * @var string
 
294
         * @access public
 
295
         */
 
296
        public $post_type;
 
297
 
 
298
        /**
 
299
         * The taxonomy associated with the screen, if any.
 
300
         * The 'edit-tags.php?taxonomy=category' screen has a taxonomy of 'category'.
 
301
         * @since 3.3.0
 
302
         * @var string
 
303
         * @access public
 
304
         */
 
305
        public $taxonomy;
 
306
 
 
307
        /**
 
308
         * The help tab data associated with the screen, if any.
 
309
         *
 
310
         * @since 3.3.0
 
311
         * @var array
 
312
         * @access private
 
313
         */
 
314
        private $_help_tabs = array();
 
315
 
 
316
        /**
 
317
         * The help sidebar data associated with screen, if any.
 
318
         *
 
319
         * @since 3.3.0
 
320
         * @var string
 
321
         * @access private
 
322
         */
 
323
        private $_help_sidebar = '';
 
324
 
 
325
        /**
 
326
         * Stores old string-based help.
 
327
         */
 
328
        private static $_old_compat_help = array();
 
329
 
 
330
        /**
 
331
         * The screen options associated with screen, if any.
 
332
         *
 
333
         * @since 3.3.0
 
334
         * @var array
 
335
         * @access private
 
336
         */
 
337
        private $_options = array();
 
338
 
 
339
        /**
 
340
         * The screen object registry.
 
341
         *
 
342
         * @since 3.3.0
 
343
         * @var array
 
344
         * @access private
 
345
         */
 
346
        private static $_registry = array();
 
347
 
 
348
        /**
 
349
         * Stores the result of the public show_screen_options function.
 
350
         *
 
351
         * @since 3.3.0
 
352
         * @var bool
 
353
         * @access private
 
354
         */
 
355
        private $_show_screen_options;
 
356
 
 
357
        /**
 
358
         * Stores the 'screen_settings' section of screen options.
 
359
         *
 
360
         * @since 3.3.0
 
361
         * @var string
 
362
         * @access private
 
363
         */
 
364
        private $_screen_settings;
 
365
 
 
366
        /**
 
367
         * Fetches a screen object.
 
368
         *
 
369
         * @since 3.3.0
 
370
         * @access public
 
371
         *
 
372
         * @param string $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen.
 
373
         *      Defaults to the current $hook_suffix global.
 
374
         * @return WP_Screen Screen object.
 
375
         */
 
376
        public static function get( $hook_name = '' ) {
 
377
 
 
378
                if ( is_a( $hook_name, 'WP_Screen' ) )
 
379
                        return $hook_name;
 
380
 
 
381
                $post_type = $taxonomy = null;
 
382
                $in_admin = false;
 
383
                $action = '';
 
384
 
 
385
                if ( $hook_name )
 
386
                        $id = $hook_name;
 
387
                else
 
388
                        $id = $GLOBALS['hook_suffix'];
 
389
 
 
390
                // For those pesky meta boxes.
 
391
                if ( $hook_name && post_type_exists( $hook_name ) ) {
 
392
                        $post_type = $id;
 
393
                        $id = 'post'; // changes later. ends up being $base.
 
394
                } else {
 
395
                        if ( '.php' == substr( $id, -4 ) )
 
396
                                $id = substr( $id, 0, -4 );
 
397
 
 
398
                        if ( 'post-new' == $id || 'link-add' == $id || 'media-new' == $id || 'user-new' == $id ) {
 
399
                                $id = substr( $id, 0, -4 );
 
400
                                $action = 'add';
 
401
                        }
 
402
                }
 
403
 
 
404
                if ( ! $post_type && $hook_name ) {
 
405
                        if ( '-network' == substr( $id, -8 ) ) {
 
406
                                $id = substr( $id, 0, -8 );
 
407
                                $in_admin = 'network';
 
408
                        } elseif ( '-user' == substr( $id, -5 ) ) {
 
409
                                $id = substr( $id, 0, -5 );
 
410
                                $in_admin = 'user';
 
411
                        }
 
412
 
 
413
                        $id = sanitize_key( $id );
 
414
                        if ( 'edit-comments' != $id && 'edit-tags' != $id && 'edit-' == substr( $id, 0, 5 ) ) {
 
415
                                $maybe = substr( $id, 5 );
 
416
                                if ( taxonomy_exists( $maybe ) ) {
 
417
                                        $id = 'edit-tags';
 
418
                                        $taxonomy = $maybe;
 
419
                                } elseif ( post_type_exists( $maybe ) ) {
 
420
                                        $id = 'edit';
 
421
                                        $post_type = $maybe;
 
422
                                }
 
423
                        }
 
424
 
 
425
                        if ( ! $in_admin )
 
426
                                $in_admin = 'site';
 
427
                } else {
 
428
                        if ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN )
 
429
                                $in_admin = 'network';
 
430
                        elseif ( defined( 'WP_USER_ADMIN' ) && WP_USER_ADMIN )
 
431
                                $in_admin = 'user';
 
432
                        else
 
433
                                $in_admin = 'site';
 
434
                }
 
435
 
 
436
                if ( 'index' == $id )
 
437
                        $id = 'dashboard';
 
438
                elseif ( 'front' == $id )
 
439
                        $in_admin = false;
 
440
 
 
441
                $base = $id;
 
442
 
 
443
                // If this is the current screen, see if we can be more accurate for post types and taxonomies.
 
444
                if ( ! $hook_name ) {
 
445
                        if ( isset( $_REQUEST['post_type'] ) )
 
446
                                $post_type = post_type_exists( $_REQUEST['post_type'] ) ? $_REQUEST['post_type'] : false;
 
447
                        if ( isset( $_REQUEST['taxonomy'] ) )
 
448
                                $taxonomy = taxonomy_exists( $_REQUEST['taxonomy'] ) ? $_REQUEST['taxonomy'] : false;
 
449
 
 
450
                        switch ( $base ) {
 
451
                                case 'post' :
 
452
                                        if ( isset( $_GET['post'] ) )
 
453
                                                $post_id = (int) $_GET['post'];
 
454
                                        elseif ( isset( $_POST['post_ID'] ) )
 
455
                                                $post_id = (int) $_POST['post_ID'];
 
456
                                        else
 
457
                                                $post_id = 0;
 
458
 
 
459
                                        if ( $post_id ) {
 
460
                                                $post = get_post( $post_id );
 
461
                                                if ( $post )
 
462
                                                        $post_type = $post->post_type;
 
463
                                        }
 
464
                                        break;
 
465
                                case 'edit-tags' :
 
466
                                        if ( null === $post_type && is_object_in_taxonomy( 'post', $taxonomy ? $taxonomy : 'post_tag' ) )
 
467
                                                $post_type = 'post';
 
468
                                        break;
 
469
                        }
 
470
                }
 
471
 
 
472
                switch ( $base ) {
 
473
                        case 'post' :
 
474
                                if ( null === $post_type )
 
475
                                        $post_type = 'post';
 
476
                                $id = $post_type;
 
477
                                break;
 
478
                        case 'edit' :
 
479
                                if ( null === $post_type )
 
480
                                        $post_type = 'post';
 
481
                                $id .= '-' . $post_type;
 
482
                                break;
 
483
                        case 'edit-tags' :
 
484
                                if ( null === $taxonomy )
 
485
                                        $taxonomy = 'post_tag';
 
486
                                // The edit-tags ID does not contain the post type. Look for it in the request.
 
487
                                if ( null === $post_type ) {
 
488
                                        $post_type = 'post';
 
489
                                        if ( isset( $_REQUEST['post_type'] ) && post_type_exists( $_REQUEST['post_type'] ) )
 
490
                                                $post_type = $_REQUEST['post_type'];
 
491
                                }
 
492
 
 
493
                                $id = 'edit-' . $taxonomy;
 
494
                                break;
 
495
                }
 
496
 
 
497
                if ( 'network' == $in_admin ) {
 
498
                        $id   .= '-network';
 
499
                        $base .= '-network';
 
500
                } elseif ( 'user' == $in_admin ) {
 
501
                        $id   .= '-user';
 
502
                        $base .= '-user';
 
503
                }
 
504
 
 
505
                if ( isset( self::$_registry[ $id ] ) ) {
 
506
                        $screen = self::$_registry[ $id ];
 
507
                        if ( $screen === get_current_screen() )
 
508
                                return $screen;
 
509
                } else {
 
510
                        $screen = new WP_Screen();
 
511
                        $screen->id     = $id;
 
512
                }
 
513
 
 
514
                $screen->base       = $base;
 
515
                $screen->action     = $action;
 
516
                $screen->post_type  = (string) $post_type;
 
517
                $screen->taxonomy   = (string) $taxonomy;
 
518
                $screen->is_user    = ( 'user' == $in_admin );
 
519
                $screen->is_network = ( 'network' == $in_admin );
 
520
                $screen->in_admin   = $in_admin;
 
521
 
 
522
                self::$_registry[ $id ] = $screen;
 
523
 
 
524
                return $screen;
 
525
        }
 
526
 
 
527
        /**
 
528
         * Makes the screen object the current screen.
 
529
         *
 
530
         * @see set_current_screen()
 
531
         * @since 3.3.0
 
532
         */
 
533
        public function set_current_screen() {
 
534
                global $current_screen, $taxnow, $typenow;
 
535
                $current_screen = $this;
 
536
                $taxnow = $this->taxonomy;
 
537
                $typenow = $this->post_type;
 
538
 
 
539
                /**
 
540
                 * Fires after the current screen has been set.
 
541
                 *
 
542
                 * @since 3.0.0
 
543
                 *
 
544
                 * @param WP_Screen $current_screen Current WP_Screen object.
 
545
                 */
 
546
                do_action( 'current_screen', $current_screen );
 
547
        }
 
548
 
 
549
        /**
 
550
         * Constructor
 
551
         *
 
552
         * @since 3.3.0
 
553
         * @access private
 
554
         */
 
555
        private function __construct() {}
 
556
 
 
557
        /**
 
558
         * Indicates whether the screen is in a particular admin
 
559
         *
 
560
         * @since 3.5.0
 
561
         *
 
562
         * @param string $admin The admin to check against (network | user | site).
 
563
         * If empty any of the three admins will result in true.
 
564
         * @return boolean True if the screen is in the indicated admin, false otherwise.
 
565
         *
 
566
         */
 
567
        public function in_admin( $admin = null ) {
 
568
                if ( empty( $admin ) )
 
569
                        return (bool) $this->in_admin;
 
570
 
 
571
                return ( $admin == $this->in_admin );
 
572
        }
 
573
 
 
574
        /**
 
575
         * Sets the old string-based contextual help for the screen.
 
576
         *
 
577
         * For backwards compatibility.
 
578
         *
 
579
         * @since 3.3.0
 
580
         *
 
581
         * @param WP_Screen $screen A screen object.
 
582
         * @param string $help Help text.
 
583
         */
 
584
        public static function add_old_compat_help( $screen, $help ) {
 
585
                self::$_old_compat_help[ $screen->id ] = $help;
 
586
        }
 
587
 
 
588
        /**
 
589
         * Set the parent information for the screen.
 
590
         * This is called in admin-header.php after the menu parent for the screen has been determined.
 
591
         *
 
592
         * @since 3.3.0
 
593
         *
 
594
         * @param string $parent_file The parent file of the screen. Typically the $parent_file global.
 
595
         */
 
596
        public function set_parentage( $parent_file ) {
 
597
                $this->parent_file = $parent_file;
 
598
                list( $this->parent_base ) = explode( '?', $parent_file );
 
599
                $this->parent_base = str_replace( '.php', '', $this->parent_base );
 
600
        }
 
601
 
 
602
        /**
 
603
         * Adds an option for the screen.
 
604
         * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add screen options.
 
605
         *
 
606
         * @since 3.3.0
 
607
         *
 
608
         * @param string $option Option ID
 
609
         * @param mixed $args Option-dependent arguments.
 
610
         */
 
611
        public function add_option( $option, $args = array() ) {
 
612
                $this->_options[ $option ] = $args;
 
613
        }
 
614
 
 
615
        /**
 
616
         * Remove an option from the screen.
 
617
         *
 
618
         * @since 3.8.0
 
619
         *
 
620
         * @param string $option Option ID.
 
621
         */
 
622
        public function remove_option( $option ) {
 
623
                unset( $this->_options[ $option ] );
 
624
        }
 
625
 
 
626
        /**
 
627
         * Remove all options from the screen.
 
628
         *
 
629
         * @since 3.8.0
 
630
         */
 
631
        public function remove_options() {
 
632
                $this->_options = array();
 
633
        }
 
634
 
 
635
        /**
 
636
         * Get the options registered for the screen.
 
637
         *
 
638
         * @since 3.8.0
 
639
         *
 
640
         * @return array Options with arguments.
 
641
         */
 
642
        public function get_options() {
 
643
                return $this->_options;
 
644
        }
 
645
 
 
646
        /**
 
647
         * Gets the arguments for an option for the screen.
 
648
         *
 
649
         * @since 3.3.0
 
650
         *
 
651
         * @param string $option Option ID.
 
652
         * @param mixed $key Optional. Specific array key for when the option is an array.
 
653
         */
 
654
        public function get_option( $option, $key = false ) {
 
655
                if ( ! isset( $this->_options[ $option ] ) )
 
656
                        return null;
 
657
                if ( $key ) {
 
658
                        if ( isset( $this->_options[ $option ][ $key ] ) )
 
659
                                return $this->_options[ $option ][ $key ];
 
660
                        return null;
 
661
                }
 
662
                return $this->_options[ $option ];
 
663
        }
 
664
 
 
665
        /**
 
666
         * Gets the help tabs registered for the screen.
 
667
         *
 
668
         * @since 3.4.0
 
669
         *
 
670
         * @return array Help tabs with arguments.
 
671
         */
 
672
        public function get_help_tabs() {
 
673
                return $this->_help_tabs;
 
674
        }
 
675
 
 
676
        /**
 
677
         * Gets the arguments for a help tab.
 
678
         *
 
679
         * @since 3.4.0
 
680
         *
 
681
         * @param string $id Help Tab ID.
 
682
         * @return array Help tab arguments.
 
683
         */
 
684
        public function get_help_tab( $id ) {
 
685
                if ( ! isset( $this->_help_tabs[ $id ] ) )
 
686
                        return null;
 
687
                return $this->_help_tabs[ $id ];
 
688
        }
 
689
 
 
690
        /**
 
691
         * Add a help tab to the contextual help for the screen.
 
692
         * Call this on the load-$pagenow hook for the relevant screen.
 
693
         *
 
694
         * @since 3.3.0
 
695
         *
 
696
         * @param array $args
 
697
         * - string   - title    - Title for the tab.
 
698
         * - string   - id       - Tab ID. Must be HTML-safe.
 
699
         * - string   - content  - Help tab content in plain text or HTML. Optional.
 
700
         * - callback - callback - A callback to generate the tab content. Optional.
 
701
         *
 
702
         */
 
703
        public function add_help_tab( $args ) {
 
704
                $defaults = array(
 
705
                        'title'    => false,
 
706
                        'id'       => false,
 
707
                        'content'  => '',
 
708
                        'callback' => false,
 
709
                );
 
710
                $args = wp_parse_args( $args, $defaults );
 
711
 
 
712
                $args['id'] = sanitize_html_class( $args['id'] );
 
713
 
 
714
                // Ensure we have an ID and title.
 
715
                if ( ! $args['id'] || ! $args['title'] )
 
716
                        return;
 
717
 
 
718
                // Allows for overriding an existing tab with that ID.
 
719
                $this->_help_tabs[ $args['id'] ] = $args;
 
720
        }
 
721
 
 
722
        /**
 
723
         * Removes a help tab from the contextual help for the screen.
 
724
         *
 
725
         * @since 3.3.0
 
726
         *
 
727
         * @param string $id The help tab ID.
 
728
         */
 
729
        public function remove_help_tab( $id ) {
 
730
                unset( $this->_help_tabs[ $id ] );
 
731
        }
 
732
 
 
733
        /**
 
734
         * Removes all help tabs from the contextual help for the screen.
 
735
         *
 
736
         * @since 3.3.0
 
737
         */
 
738
        public function remove_help_tabs() {
 
739
                $this->_help_tabs = array();
 
740
        }
 
741
 
 
742
        /**
 
743
         * Gets the content from a contextual help sidebar.
 
744
         *
 
745
         * @since 3.4.0
 
746
         *
 
747
         * @return string Contents of the help sidebar.
 
748
         */
 
749
        public function get_help_sidebar() {
 
750
                return $this->_help_sidebar;
 
751
        }
 
752
 
 
753
        /**
 
754
         * Add a sidebar to the contextual help for the screen.
 
755
         * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add a sidebar to the contextual help.
 
756
         *
 
757
         * @since 3.3.0
 
758
         *
 
759
         * @param string $content Sidebar content in plain text or HTML.
 
760
         */
 
761
        public function set_help_sidebar( $content ) {
 
762
                $this->_help_sidebar = $content;
 
763
        }
 
764
 
 
765
        /**
 
766
         * Gets the number of layout columns the user has selected.
 
767
         *
 
768
         * The layout_columns option controls the max number and default number of
 
769
         * columns. This method returns the number of columns within that range selected
 
770
         * by the user via Screen Options. If no selection has been made, the default
 
771
         * provisioned in layout_columns is returned. If the screen does not support
 
772
         * selecting the number of layout columns, 0 is returned.
 
773
         *
 
774
         * @since 3.4.0
 
775
         *
 
776
         * @return int Number of columns to display.
 
777
         */
 
778
        public function get_columns() {
 
779
                return $this->columns;
 
780
        }
 
781
 
 
782
        /**
 
783
         * Render the screen's help section.
 
784
         *
 
785
         * This will trigger the deprecated filters for backwards compatibility.
 
786
         *
 
787
         * @since 3.3.0
 
788
         */
 
789
        public function render_screen_meta() {
 
790
 
 
791
                /**
 
792
                 * Filter the legacy contextual help list.
 
793
                 *
 
794
                 * @since 2.7.0
 
795
                 * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or
 
796
                 *                   get_current_screen()->remove_help_tab() instead.
 
797
                 *
 
798
                 * @param array     $old_compat_help Old contextual help.
 
799
                 * @param WP_Screen $this            Current WP_Screen instance.
 
800
                 */
 
801
                self::$_old_compat_help = apply_filters( 'contextual_help_list', self::$_old_compat_help, $this );
 
802
 
 
803
                $old_help = isset( self::$_old_compat_help[ $this->id ] ) ? self::$_old_compat_help[ $this->id ] : '';
 
804
 
 
805
                /**
 
806
                 * Filter the legacy contextual help text.
 
807
                 *
 
808
                 * @since 2.7.0
 
809
                 * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or
 
810
                 *                   get_current_screen()->remove_help_tab() instead.
 
811
                 *
 
812
                 * @param string    $old_help  Help text that appears on the screen.
 
813
                 * @param string    $screen_id Screen ID.
 
814
                 * @param WP_Screen $this      Current WP_Screen instance.
 
815
                 *
 
816
                 */
 
817
                $old_help = apply_filters( 'contextual_help', $old_help, $this->id, $this );
 
818
 
 
819
                // Default help only if there is no old-style block of text and no new-style help tabs.
 
820
                if ( empty( $old_help ) && ! $this->get_help_tabs() ) {
 
821
 
 
822
                        /**
 
823
                         * Filter the default legacy contextual help text.
 
824
                         *
 
825
                         * @since 2.8.0
 
826
                         * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or
 
827
                         *                   get_current_screen()->remove_help_tab() instead.
 
828
                         *
 
829
                         * @param string $old_help_default Default contextual help text.
 
830
                         */
 
831
                        $default_help = apply_filters( 'default_contextual_help', '' );
 
832
                        if ( $default_help )
 
833
                                $old_help = '<p>' . $default_help . '</p>';
 
834
                }
 
835
 
 
836
                if ( $old_help ) {
 
837
                        $this->add_help_tab( array(
 
838
                                'id'      => 'old-contextual-help',
 
839
                                'title'   => __('Overview'),
 
840
                                'content' => $old_help,
 
841
                        ) );
 
842
                }
 
843
 
 
844
                $help_sidebar = $this->get_help_sidebar();
 
845
 
 
846
                $help_class = 'hidden';
 
847
                if ( ! $help_sidebar )
 
848
                        $help_class .= ' no-sidebar';
 
849
 
 
850
                // Time to render!
 
851
                ?>
 
852
                <div id="screen-meta" class="metabox-prefs">
 
853
 
 
854
                        <div id="contextual-help-wrap" class="<?php echo esc_attr( $help_class ); ?>" tabindex="-1" aria-label="<?php esc_attr_e('Contextual Help Tab'); ?>">
 
855
                                <div id="contextual-help-back"></div>
 
856
                                <div id="contextual-help-columns">
 
857
                                        <div class="contextual-help-tabs">
 
858
                                                <ul>
 
859
                                                <?php
 
860
                                                $class = ' class="active"';
 
861
                                                foreach ( $this->get_help_tabs() as $tab ) :
 
862
                                                        $link_id  = "tab-link-{$tab['id']}";
 
863
                                                        $panel_id = "tab-panel-{$tab['id']}";
 
864
                                                        ?>
 
865
 
 
866
                                                        <li id="<?php echo esc_attr( $link_id ); ?>"<?php echo $class; ?>>
 
867
                                                                <a href="<?php echo esc_url( "#$panel_id" ); ?>" aria-controls="<?php echo esc_attr( $panel_id ); ?>">
 
868
                                                                        <?php echo esc_html( $tab['title'] ); ?>
 
869
                                                                </a>
 
870
                                                        </li>
 
871
                                                <?php
 
872
                                                        $class = '';
 
873
                                                endforeach;
 
874
                                                ?>
 
875
                                                </ul>
 
876
                                        </div>
 
877
 
 
878
                                        <?php if ( $help_sidebar ) : ?>
 
879
                                        <div class="contextual-help-sidebar">
 
880
                                                <?php echo $help_sidebar; ?>
 
881
                                        </div>
 
882
                                        <?php endif; ?>
 
883
 
 
884
                                        <div class="contextual-help-tabs-wrap">
 
885
                                                <?php
 
886
                                                $classes = 'help-tab-content active';
 
887
                                                foreach ( $this->get_help_tabs() as $tab ):
 
888
                                                        $panel_id = "tab-panel-{$tab['id']}";
 
889
                                                        ?>
 
890
 
 
891
                                                        <div id="<?php echo esc_attr( $panel_id ); ?>" class="<?php echo $classes; ?>">
 
892
                                                                <?php
 
893
                                                                // Print tab content.
 
894
                                                                echo $tab['content'];
 
895
 
 
896
                                                                // If it exists, fire tab callback.
 
897
                                                                if ( ! empty( $tab['callback'] ) )
 
898
                                                                        call_user_func_array( $tab['callback'], array( $this, $tab ) );
 
899
                                                                ?>
 
900
                                                        </div>
 
901
                                                <?php
 
902
                                                        $classes = 'help-tab-content';
 
903
                                                endforeach;
 
904
                                                ?>
 
905
                                        </div>
 
906
                                </div>
 
907
                        </div>
 
908
                <?php
 
909
                // Setup layout columns
 
910
 
 
911
                /**
 
912
                 * Filter the array of screen layout columns.
 
913
                 *
 
914
                 * This hook provides back-compat for plugins using the back-compat
 
915
                 * filter instead of add_screen_option().
 
916
                 *
 
917
                 * @since 2.8.0
 
918
                 *
 
919
                 * @param array     $empty_columns Empty array.
 
920
                 * @param string    $screen_id     Screen ID.
 
921
                 * @param WP_Screen $this          Current WP_Screen instance.
 
922
                 */
 
923
                $columns = apply_filters( 'screen_layout_columns', array(), $this->id, $this );
 
924
 
 
925
                if ( ! empty( $columns ) && isset( $columns[ $this->id ] ) )
 
926
                        $this->add_option( 'layout_columns', array('max' => $columns[ $this->id ] ) );
 
927
 
 
928
                if ( $this->get_option( 'layout_columns' ) ) {
 
929
                        $this->columns = (int) get_user_option("screen_layout_$this->id");
 
930
 
 
931
                        if ( ! $this->columns && $this->get_option( 'layout_columns', 'default' ) )
 
932
                                $this->columns = $this->get_option( 'layout_columns', 'default' );
 
933
                }
 
934
                $GLOBALS[ 'screen_layout_columns' ] = $this->columns; // Set the global for back-compat.
 
935
 
 
936
                // Add screen options
 
937
                if ( $this->show_screen_options() )
 
938
                        $this->render_screen_options();
 
939
                ?>
 
940
                </div>
 
941
                <?php
 
942
                if ( ! $this->get_help_tabs() && ! $this->show_screen_options() )
 
943
                        return;
 
944
                ?>
 
945
                <div id="screen-meta-links">
 
946
                <?php if ( $this->get_help_tabs() ) : ?>
 
947
                        <div id="contextual-help-link-wrap" class="hide-if-no-js screen-meta-toggle">
 
948
                        <a href="#contextual-help-wrap" id="contextual-help-link" class="show-settings" aria-controls="contextual-help-wrap" aria-expanded="false"><?php _e( 'Help' ); ?></a>
 
949
                        </div>
 
950
                <?php endif;
 
951
                if ( $this->show_screen_options() ) : ?>
 
952
                        <div id="screen-options-link-wrap" class="hide-if-no-js screen-meta-toggle">
 
953
                        <a href="#screen-options-wrap" id="show-settings-link" class="show-settings" aria-controls="screen-options-wrap" aria-expanded="false"><?php _e( 'Screen Options' ); ?></a>
 
954
                        </div>
 
955
                <?php endif; ?>
 
956
                </div>
 
957
                <?php
 
958
        }
 
959
 
 
960
        public function show_screen_options() {
 
961
                global $wp_meta_boxes;
 
962
 
 
963
                if ( is_bool( $this->_show_screen_options ) )
 
964
                        return $this->_show_screen_options;
 
965
 
 
966
                $columns = get_column_headers( $this );
 
967
 
 
968
                $show_screen = ! empty( $wp_meta_boxes[ $this->id ] ) || $columns || $this->get_option( 'per_page' );
 
969
 
 
970
                switch ( $this->base ) {
 
971
                        case 'widgets':
 
972
                                $this->_screen_settings = '<p><a id="access-on" href="widgets.php?widgets-access=on">' . __('Enable accessibility mode') . '</a><a id="access-off" href="widgets.php?widgets-access=off">' . __('Disable accessibility mode') . "</a></p>\n";
 
973
                                break;
 
974
                        case 'post' :
 
975
                                $expand = '<div class="editor-expand hidden"><label for="editor-expand-toggle">';
 
976
                                $expand .= '<input type="checkbox" id="editor-expand-toggle"' . checked( get_user_setting( 'editor_expand', 'on' ), 'on', false ) . ' />';
 
977
                                $expand .= __( 'Expand the editor to match the window height.' ) . '</label></div>';
 
978
                                $this->_screen_settings = $expand;
 
979
                                break;
 
980
                        default:
 
981
                                $this->_screen_settings = '';
 
982
                                break;
 
983
                }
 
984
 
 
985
                /**
 
986
                 * Filter the screen settings text displayed in the Screen Options tab.
 
987
                 *
 
988
                 * This filter is currently only used on the Widgets screen to enable
 
989
                 * accessibility mode.
 
990
                 *
 
991
                 * @since 3.0.0
 
992
                 *
 
993
                 * @param string    $screen_settings Screen settings.
 
994
                 * @param WP_Screen $this            WP_Screen object.
 
995
                 */
 
996
                $this->_screen_settings = apply_filters( 'screen_settings', $this->_screen_settings, $this );
 
997
 
 
998
                if ( $this->_screen_settings || $this->_options )
 
999
                        $show_screen = true;
 
1000
 
 
1001
                /**
 
1002
                 * Filter whether to show the Screen Options tab.
 
1003
                 *
 
1004
                 * @since 3.2.0
 
1005
                 *
 
1006
                 * @param bool      $show_screen Whether to show Screen Options tab.
 
1007
                 *                               Default true.
 
1008
                 * @param WP_Screen $this        Current WP_Screen instance.
 
1009
                 */
 
1010
                $this->_show_screen_options = apply_filters( 'screen_options_show_screen', $show_screen, $this );
 
1011
                return $this->_show_screen_options;
 
1012
        }
 
1013
 
 
1014
        /**
 
1015
         * Render the screen options tab.
 
1016
         *
 
1017
         * @since 3.3.0
 
1018
         */
 
1019
        public function render_screen_options() {
 
1020
                global $wp_meta_boxes;
 
1021
 
 
1022
                $columns = get_column_headers( $this );
 
1023
                $hidden  = get_hidden_columns( $this );
 
1024
 
 
1025
                ?>
 
1026
                <div id="screen-options-wrap" class="hidden" tabindex="-1" aria-label="<?php esc_attr_e('Screen Options Tab'); ?>">
 
1027
                <form id="adv-settings" action="" method="post">
 
1028
                <?php if ( isset( $wp_meta_boxes[ $this->id ] ) || $this->get_option( 'per_page' ) || ( $columns && empty( $columns['_title'] ) ) ) : ?>
 
1029
                        <h5><?php _e( 'Show on screen' ); ?></h5>
 
1030
                <?php
 
1031
                endif;
 
1032
 
 
1033
                if ( isset( $wp_meta_boxes[ $this->id ] ) ) : ?>
 
1034
                        <div class="metabox-prefs">
 
1035
                                <?php
 
1036
                                        meta_box_prefs( $this );
 
1037
 
 
1038
                                        if ( 'dashboard' === $this->id && has_action( 'welcome_panel' ) && current_user_can( 'edit_theme_options' ) ) {
 
1039
                                                if ( isset( $_GET['welcome'] ) ) {
 
1040
                                                        $welcome_checked = empty( $_GET['welcome'] ) ? 0 : 1;
 
1041
                                                        update_user_meta( get_current_user_id(), 'show_welcome_panel', $welcome_checked );
 
1042
                                                } else {
 
1043
                                                        $welcome_checked = get_user_meta( get_current_user_id(), 'show_welcome_panel', true );
 
1044
                                                        if ( 2 == $welcome_checked && wp_get_current_user()->user_email != get_option( 'admin_email' ) )
 
1045
                                                                $welcome_checked = false;
 
1046
                                                }
 
1047
                                                echo '<label for="wp_welcome_panel-hide">';
 
1048
                                                echo '<input type="checkbox" id="wp_welcome_panel-hide"' . checked( (bool) $welcome_checked, true, false ) . ' />';
 
1049
                                                echo _x( 'Welcome', 'Welcome panel' ) . "</label>\n";
 
1050
                                        }
 
1051
                                ?>
 
1052
                                <br class="clear" />
 
1053
                        </div>
 
1054
                        <?php endif;
 
1055
                        if ( $columns ) :
 
1056
                                if ( ! empty( $columns['_title'] ) ) : ?>
 
1057
                        <h5><?php echo $columns['_title']; ?></h5>
 
1058
                        <?php endif; ?>
 
1059
                        <div class="metabox-prefs">
 
1060
                                <?php
 
1061
                                $special = array('_title', 'cb', 'comment', 'media', 'name', 'title', 'username', 'blogname');
 
1062
 
 
1063
                                foreach ( $columns as $column => $title ) {
 
1064
                                        // Can't hide these for they are special
 
1065
                                        if ( in_array( $column, $special ) )
 
1066
                                                continue;
 
1067
                                        if ( empty( $title ) )
 
1068
                                                continue;
 
1069
 
 
1070
                                        if ( 'comments' == $column )
 
1071
                                                $title = __( 'Comments' );
 
1072
                                        $id = "$column-hide";
 
1073
                                        echo '<label for="' . $id . '">';
 
1074
                                        echo '<input class="hide-column-tog" name="' . $id . '" type="checkbox" id="' . $id . '" value="' . $column . '"' . checked( !in_array($column, $hidden), true, false ) . ' />';
 
1075
                                        echo "$title</label>\n";
 
1076
                                }
 
1077
                                ?>
 
1078
                                <br class="clear" />
 
1079
                        </div>
 
1080
                <?php endif;
 
1081
 
 
1082
                $this->render_screen_layout();
 
1083
                $this->render_per_page_options();
 
1084
                echo $this->_screen_settings;
 
1085
 
 
1086
                ?>
 
1087
                <div><?php wp_nonce_field( 'screen-options-nonce', 'screenoptionnonce', false ); ?></div>
 
1088
                </form>
 
1089
                </div>
 
1090
                <?php
 
1091
        }
 
1092
 
 
1093
        /**
 
1094
         * Render the option for number of columns on the page
 
1095
         *
 
1096
         * @since 3.3.0
 
1097
         */
 
1098
        public function render_screen_layout() {
 
1099
                if ( ! $this->get_option('layout_columns') )
 
1100
                        return;
 
1101
 
 
1102
                $screen_layout_columns = $this->get_columns();
 
1103
                $num = $this->get_option( 'layout_columns', 'max' );
 
1104
 
 
1105
                ?>
 
1106
                <h5 class="screen-layout"><?php _e('Screen Layout'); ?></h5>
 
1107
                <div class='columns-prefs'><?php
 
1108
                        _e('Number of Columns:');
 
1109
                        for ( $i = 1; $i <= $num; ++$i ):
 
1110
                                ?>
 
1111
                                <label class="columns-prefs-<?php echo $i; ?>">
 
1112
                                        <input type='radio' name='screen_columns' value='<?php echo esc_attr( $i ); ?>'
 
1113
                                                <?php checked( $screen_layout_columns, $i ); ?> />
 
1114
                                        <?php echo esc_html( $i ); ?>
 
1115
                                </label>
 
1116
                                <?php
 
1117
                        endfor; ?>
 
1118
                </div>
 
1119
                <?php
 
1120
        }
 
1121
 
 
1122
        /**
 
1123
         * Render the items per page option
 
1124
         *
 
1125
         * @since 3.3.0
 
1126
         */
 
1127
        public function render_per_page_options() {
 
1128
                if ( ! $this->get_option( 'per_page' ) )
 
1129
                        return;
 
1130
 
 
1131
                $per_page_label = $this->get_option( 'per_page', 'label' );
 
1132
 
 
1133
                $option = $this->get_option( 'per_page', 'option' );
 
1134
                if ( ! $option )
 
1135
                        $option = str_replace( '-', '_', "{$this->id}_per_page" );
 
1136
 
 
1137
                $per_page = (int) get_user_option( $option );
 
1138
                if ( empty( $per_page ) || $per_page < 1 ) {
 
1139
                        $per_page = $this->get_option( 'per_page', 'default' );
 
1140
                        if ( ! $per_page )
 
1141
                                $per_page = 20;
 
1142
                }
 
1143
 
 
1144
                if ( 'edit_comments_per_page' == $option ) {
 
1145
                        $comment_status = isset( $_REQUEST['comment_status'] ) ? $_REQUEST['comment_status'] : 'all';
 
1146
 
 
1147
                        /** This filter is documented in wp-admin/includes/class-wp-comments-list-table.php */
 
1148
                        $per_page = apply_filters( 'comments_per_page', $per_page, $comment_status );
 
1149
                } elseif ( 'categories_per_page' == $option ) {
 
1150
                        /** This filter is documented in wp-admin/includes/class-wp-terms-list-table.php */
 
1151
                        $per_page = apply_filters( 'edit_categories_per_page', $per_page );
 
1152
                } else {
 
1153
                        /** This filter is documented in wp-admin/includes/class-wp-list-table.php */
 
1154
                        $per_page = apply_filters( $option, $per_page );
 
1155
                }
 
1156
 
 
1157
                // Back compat
 
1158
                if ( isset( $this->post_type ) ) {
 
1159
                        /** This filter is documented in wp-admin/includes/class-wp-posts-list-table.php */
 
1160
                        $per_page = apply_filters( 'edit_posts_per_page', $per_page, $this->post_type );
 
1161
                }
 
1162
 
 
1163
                ?>
 
1164
                <div class="screen-options">
 
1165
                        <?php if ( $per_page_label ) : ?>
 
1166
                                <input type="number" step="1" min="1" max="999" class="screen-per-page" name="wp_screen_options[value]"
 
1167
                                        id="<?php echo esc_attr( $option ); ?>" maxlength="3"
 
1168
                                        value="<?php echo esc_attr( $per_page ); ?>" />
 
1169
                                <label for="<?php echo esc_attr( $option ); ?>">
 
1170
                                        <?php echo esc_html( $per_page_label ); ?>
 
1171
                                </label>
 
1172
                        <?php endif;
 
1173
 
 
1174
                        echo get_submit_button( __( 'Apply' ), 'button', 'screen-options-apply', false ); ?>
 
1175
                        <input type='hidden' name='wp_screen_options[option]' value='<?php echo esc_attr($option); ?>' />
 
1176
                </div>
 
1177
                <?php
 
1178
        }
 
1179
}