Changeset 18857

Timestamp:

10/01/11 17:59:46 (6 years ago)

Author:

nacin

Message:

Move all new WP_Screen properties to private. We should introduce getters. Correct legacy (and ideally read-only) properties to @access public. see #18785.

File:

• trunk/wp-admin/includes/screen.php (modified) (22 diffs)

trunk/wp-admin/includes/screen.php

@@ -401 +401 @@
      * @since 3.3.0
      * @var string
-     * @access private
+     * @access public
      */
     public $action = '';
@@ -411 +411 @@
      * @since 3.3.0
      * @var string
-     * @access private
+     * @access public
      */
     public $base;
@@ -420 +420 @@
      * @since 3.3.0
      * @var string
-     * @access private
+     * @access public
      */
     public $id;
@@ -429 +429 @@
      * @since 3.3.0
      * @var bool
-     * @access private
+     * @access public
      */
     public $is_network;
@@ -438 +438 @@
      * @since 3.3.0
      * @var bool
-     * @access private
+     * @access public
      */
     public $is_user;
@@ -449 +449 @@
      * @since 3.3.0
      * @var string
-     * @access private
+     * @access public
      */
     public $parent_base;
@@ -459 +459 @@
      * @since 3.3.0
      * @var string
-     * @access private
+     * @access public
      */
     public $parent_file;
@@ -469 +469 @@
      * @since 3.3.0
      * @var string
-     * @access private
+     * @access public
      */
     public $post_type;
@@ -478 +478 @@
      * @since 3.3.0
      * @var string
-     * @access private
+     * @access public
      */
     public $taxonomy;
@@ -489 +489 @@
      * @access private
      */
-    public $help_tabs = array();
+    private $_help_tabs = array();
 
     /**
@@ -498 +498 @@
      * @access private
      */
-    public $help_sidebar = '';
+    private $_help_sidebar = '';
 
     /**
@@ -507 +507 @@
      * @access private
      */
-    public $options = array();
+    private $_options = array();
 
 
@@ -622 +622 @@
      */
     public function add_option( $option, $args = array() ) {
-        $this->options[ $option ] = $args;
+        $this->_options[ $option ] = $args;
     }
 
@@ -655 +655 @@
             $args['id'] = sanitize_html_class( $args['title'] );
 
-        $this->help_tabs[] = $args;
+        $this->_help_tabs[] = $args;
     }
 
@@ -667 +667 @@
      */
     public function add_help_sidebar( $content ) {
-        $this->help_sidebar = $content;
+        $this->_help_sidebar = $content;
     }
 
@@ -708 +708 @@
             <div id="contextual-help-wrap" class="hidden">
                 <ul class="contextual-help-tabs">
-                    <?php foreach ( $this->help_tabs as $i => $tab ):
+                    <?php foreach ( $this->_help_tabs as $i => $tab ):
                         $link_id  = "tab-link-{$tab['id']}";
                         $panel_id = "tab-panel-{$tab['id']}";
@@ -723 +723 @@
 
                 <div class="contextual-help-sidebar">
-                    <?php echo $this->help_sidebar; ?>
+                    <?php echo $this->_help_sidebar; ?>
                 </div>
 
                 <div class="contextual-help-tabs-wrap">
-                    <?php foreach ( $this->help_tabs as $i => $tab ):
+                    <?php foreach ( $this->_help_tabs as $i => $tab ):
                         $panel_id = "tab-panel-{$tab['id']}";
                         $classes  = ( $i == 0 ) ? 'active' : '';
@@ -764 +764 @@
 
         // Check if there are per-page options.
-        $show_screen = $show_screen || isset( $this->options['per_page'] );
+        $show_screen = $show_screen || isset( $this->_options['per_page'] );
 
         $this->_screen_settings = apply_filters( 'screen_settings', '', $this );
@@ -778 +778 @@
             $show_screen = true;
 
-        if ( ! empty( $this->options ) )
+        if ( ! empty( $this->_options ) )
             $show_screen = true;
 
@@ -849 +849 @@
             add_screen_option( 'layout_columns', array('max' => $columns[ $this->id ] ) );
 
-        if ( ! isset( $this->options['layout_columns'] ) ) {
+        if ( ! isset( $this->_options['layout_columns'] ) ) {
             $screen_layout_columns = 0;
             return;
@@ -855 +855 @@
 
         $screen_layout_columns = get_user_option("screen_layout_$this->id");
-        $num = $this->options['layout_columns']['max'];
+        $num = $this->_options['layout_columns']['max'];
 
         if ( ! $screen_layout_columns ) {
-            if ( isset( $this->options['layout_columns']['default'] ) )
-                $screen_layout_columns = $this->options['layout_columns']['default'];
+            if ( isset( $this->_options['layout_columns']['default'] ) )
+                $screen_layout_columns = $this->_options['layout_columns']['default'];
             else
                 $screen_layout_columns = 'auto';
@@ -887 +887 @@
 
     function render_per_page_options() {
-        if ( ! isset( $this->options['per_page'] ) )
+        if ( ! isset( $this->_options['per_page'] ) )
             return;
 
-        $per_page_label = $this->options['per_page']['label'];
-
-        if ( empty( $this->options['per_page']['option'] ) ) {
+        $per_page_label = $this->_options['per_page']['label'];
+
+        if ( empty( $this->_options['per_page']['option'] ) ) {
             $option = str_replace( '-', '_', "{$this->id}_per_page" );
         } else {
-            $option = $this->options['per_page']['option'];
+            $option = $this->_options['per_page']['option'];
         }
 
         $per_page = (int) get_user_option( $option );
         if ( empty( $per_page ) || $per_page < 1 ) {
-            if ( isset($this->options['per_page']['default']) )
-                $per_page = $this->options['per_page']['default'];
+            if ( isset($this->_options['per_page']['default']) )
+                $per_page = $this->_options['per_page']['default'];
             else
                 $per_page = 20;