Changeset 6178 for trunk/src/includes/admin/forums.php

Timestamp:

12/18/2016 04:13:15 PM (10 years ago)

Author:

johnjamesjacoby

Message:

Tools: Update forum/topic/reply admin classes to avoid screens without post_type parameters.

Fixes edge-case debug notices when tools pages for third-party plugins are doing advanced things.

See #2959.

File:

• trunk/src/includes/admin/forums.php (modified) (14 diffs)

trunk/src/includes/admin/forums.php

@@ -24 +24 @@
 
         /**
-         * @var The post type of this admin component
+         * @var string The post type of this admin component
          */
         private $post_type = '';
+
+        /**
+         * @var WP_Screen The current screen object
+         */
+        private $screen;
 
         /** Functions *************************************************************/
@@ -95 +100 @@
          */
         private function bail() {
-                if ( $this->post_type != get_current_screen()->post_type ) {
+
+                // Not for a post type
+                if ( empty( $this->screen->post_type ) ) {
+                        return true;
+                }
+
+                // Not this post type
+                if ( $this->post_type != $this->screen->post_type ) {
                         return true;
                 }
@@ -111 +123 @@
         private function setup_globals() {
                 $this->post_type = bbp_get_forum_post_type();
+                $this->screen    = get_current_screen();
         }
 
@@ -129 +142 @@
 
                 // Overview
-                get_current_screen()->add_help_tab( array(
+                $this->screen->add_help_tab( array(
                         'id'            => 'overview',
                         'title'         => __( 'Overview', 'bbpress' ),
@@ -137 +150 @@
 
                 // Screen Content
-                get_current_screen()->add_help_tab( array(
+                $this->screen->add_help_tab( array(
                         'id'            => 'screen-content',
                         'title'         => __( 'Screen Content', 'bbpress' ),
@@ -150 +163 @@
 
                 // Available Actions
-                get_current_screen()->add_help_tab( array(
+                $this->screen->add_help_tab( array(
                         'id'            => 'action-links',
                         'title'         => __( 'Available Actions', 'bbpress' ),
@@ -163 +176 @@
 
                 // Bulk Actions
-                get_current_screen()->add_help_tab( array(
+                $this->screen->add_help_tab( array(
                         'id'            => 'bulk-actions',
                         'title'         => __( 'Bulk Actions', 'bbpress' ),
@@ -172 +185 @@
 
                 // Help Sidebar
-                get_current_screen()->set_help_sidebar(
+                $this->screen->set_help_sidebar(
                         '<p><strong>' . __( 'For more information:', 'bbpress' ) . '</strong></p>' .
                         '<p>' . __( '<a href="https://codex.bbpress.org" target="_blank">bbPress Documentation</a>',    'bbpress' ) . '</p>' .
@@ -184 +197 @@
          * @since 2.0.0 bbPress (r3119)
          *
-         * @uses get_current_screen()
+         * @uses $this->screen
          */
         public function new_help() {
@@ -194 +207 @@
                 $customize_display = '<p>' . __( 'The title field and the big forum editing Area are fixed in place, but you can reposition all the other boxes using drag and drop, and can minimize or expand them by clicking the title bar of each box. Use the Screen Options tab to unhide more boxes (Excerpt, Send Trackbacks, Custom Fields, Discussion, Slug, Author) or to choose a 1- or 2-column layout for this screen.', 'bbpress' ) . '</p>';
 
-                get_current_screen()->add_help_tab( array(
+                $this->screen->add_help_tab( array(
                         'id'      => 'customize-display',
                         'title'   => __( 'Customizing This Display', 'bbpress' ),
@@ -200 +213 @@
                 ) );
 
-                get_current_screen()->add_help_tab( array(
+                $this->screen->add_help_tab( array(
                         'id'      => 'title-forum-editor',
                         'title'   => __( 'Title and Forum Editor', 'bbpress' ),
@@ -214 +227 @@
                 }
 
-                get_current_screen()->add_help_tab( array(
+                $this->screen->add_help_tab( array(
                         'id'      => 'forum-attributes',
                         'title'   => __( 'Forum Attributes', 'bbpress' ),
@@ -228 +241 @@
                 ) );
 
-                get_current_screen()->add_help_tab( array(
+                $this->screen->add_help_tab( array(
                         'id'      => 'publish-box',
                         'title'   => __( 'Publish Box', 'bbpress' ),
@@ -234 +247 @@
                 ) );
 
-                get_current_screen()->set_help_sidebar(
+                $this->screen->set_help_sidebar(
                         '<p><strong>' . __( 'For more information:', 'bbpress' ) . '</strong></p>' .
                         '<p>' . __( '<a href="https://codex.bbpress.org" target="_blank">bbPress Documentation</a>',    'bbpress' ) . '</p>' .