Changeset 37657

Timestamp:

06/08/2016 04:13:04 AM (10 years ago)

Author:

jeremyfelt

Message:

Multisite: Allow access to network and site properties using current naming conventions

• Add magic __get(), __set(), and __isset() methods to WP_Site and `WP_Network.
• Provide (int) $network->site_id for (string) $network->blog_id
• Provide (int) $site->id for (string) $site->blog_id
• Provide (int) $site->network_id for (string) $site->site_id

Props flixos90, jeremyfelt.
Fixes #36717.

Location:

trunk/src/wp-includes

Files:

• class-wp-network.php (modified) (3 diffs)
• class-wp-site.php (modified) (4 diffs)

trunk/src/wp-includes/class-wp-network.php

@@ -18 +18 @@
  *
  * @since 4.4.0
+ *
+ * @property int $site_id
  */
 class WP_Network {
@@ -59 +61 @@
          *
          * @since 4.4.0
-         * @access public
-         * @var string
-         */
-        public $blog_id = 0;
+         * @access private
+         * @var string
+         */
+        private $blog_id = 0;
 
         /**
@@ -136 +138 @@
                 $this->_set_site_name();
                 $this->_set_cookie_domain();
+        }
+
+        /**
+         * Getter.
+         *
+         * Allows current multisite naming conventions when getting properties.
+         *
+         * @since 4.6.0
+         * @access public
+         *
+         * @param string $key Property to get.
+         * @return mixed Value of the property. Null if not available.
+         */
+        public function __get( $key ) {
+                switch ( $key ) {
+                        case 'blog_id':
+                                return $this->blog_id;
+                        case 'site_id':
+                                return (int) $this->blog_id;
+                }
+
+                return null;
+        }
+
+        /**
+         * Isset-er.
+         *
+         * Allows current multisite naming conventions when checking for properties.
+         *
+         * @since 4.6.0
+         * @access public
+         *
+         * @param string $key Property to check if set.
+         * @return bool Whether the property is set.
+         */
+        public function __isset( $key ) {
+                switch( $key ) {
+                        case 'blog_id':
+                        case 'site_id':
+                                return true;
+                }
+
+                return false;
+        }
+
+        /**
+         * Setter.
+         *
+         * Allows current multisite naming conventions while setting properties.
+         *
+         * @since 4.6.0
+         * @access public
+         *
+         * @param string $key   Property to set.
+         * @param mixed  $value Value to assign to the property.
+         */
+        public function __set( $key, $value ) {
+                switch( $key ) {
+                        case 'blog_id':
+                        case 'site_id':
+                                $this->blog_id = (string) $value;
+                                break;
+                        default:
+                                $this->$key = $value;
+                }
         }
 

trunk/src/wp-includes/class-wp-site.php

@@ -15 +15 @@
  *
  * @since 4.5.0
+ *
+ * @property int $id
+ * @property int $network_id
  */
 final class WP_Site {
@@ -24 +27 @@
          *
          * @since 4.5.0
-         * @access public
-         * @var string
-         */
-        public $blog_id;
+         * @access private
+         * @var string
+         */
+        private $blog_id;
 
         /**
@@ -56 +59 @@
          *
          * @since 4.5.0
-         * @access public
-         * @var string
-         */
-        public $site_id = '0';
+         * @access private
+         * @var string
+         */
+        private $site_id = '0';
 
         /**
@@ -211 +214 @@
                 return get_object_vars( $this );
         }
+
+        /**
+         * Getter.
+         *
+         * Allows current multisite naming conventions when getting properties.
+         *
+         * @since 4.6.0
+         * @access public
+         *
+         * @param string $key Property to get.
+         * @return mixed Value of the property. Null if not available.
+         */
+        public function __get( $key ) {
+                switch ( $key ) {
+                        case 'id':
+                                return (int) $this->blog_id;
+                        case 'blog_id':
+                                return $this->blog_id;
+                        case 'site_id':
+                                return $this->site_id;
+                        case 'network_id':
+                                return (int) $this->site_id;
+                }
+
+                return null;
+        }
+
+        /**
+         * Isset-er.
+         *
+         * Allows current multisite naming conventions when checking for properties.
+         *
+         * @since 4.6.0
+         * @access public
+         *
+         * @param string $key Property to check if set.
+         * @return bool Whether the property is set.
+         */
+        public function __isset( $key ) {
+                switch ( $key ) {
+                        case 'id':
+                        case 'blog_id':
+                        case 'site_id':
+                        case 'network_id':
+                                return true;
+                }
+
+                return false;
+        }
+
+        /**
+         * Setter.
+         *
+         * Allows current multisite naming conventions while setting properties.
+         *
+         * @since 4.6.0
+         * @access public
+         *
+         * @param string $key   Property to set.
+         * @param mixed  $value Value to assign to the property.
+         */
+        public function __set( $key, $value ) {
+                switch( $key ) {
+                        case 'id':
+                        case 'blog_id':
+                                $this->blog_id = (string) $value;
+                                break;
+                        case 'site_id':
+                        case 'network_id':
+                                $this->site_id = (string) $value;
+                                break;
+                        default:
+                                $this->$key = $value;
+                }
+        }
 }