Changeset 38681

Timestamp:

09/30/2016 04:09:45 AM (8 years ago)

Author:

jeremyfelt

Message:

Multisite: Ensure a consistent WP_Site return from get_site_by_path().

It is possible to short circuit get_site_by_path() using the pre_get_site_by_path filter. When this happens and a standard site object is provided, we can make sure it is upgraded to a proper WP_Site object before passing it on.

Props flixos90.
Fixes #37053.

Location:

trunk

Files:

• src/wp-includes/ms-load.php (modified) (3 diffs)
• tests/phpunit/tests/multisite/bootstrap.php (modified) (1 diff)

trunk/src/wp-includes/ms-load.php

@@ -138 +138 @@
  *
  * @since 3.9.0
+ * @since 4.7.0 Updated to always return a `WP_Site` object.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -144 +145 @@
  * @param string   $path     Path to check.
  * @param int|null $segments Path segments to use. Defaults to null, or the full path.
- * @return object|false Site object if successful. False when no site is found.
+ * @return WP_Site|false Site object if successful. False when no site is found.
  */
 function get_site_by_path( $domain, $path, $segments = null ) {
@@ -187 +188 @@
      * @since 3.9.0
      *
-     * @param null|bool|object $site     Site value to return by path.
-     * @param string           $domain   The requested domain.
-     * @param string           $path     The requested path, in full.
-     * @param int|null         $segments The suggested number of paths to consult.
-     *                                   Default null, meaning the entire path was to be consulted.
-     * @param array            $paths    The paths to search for, based on $path and $segments.
+     * @param null|bool|WP_Site $site     Site value to return by path.
+     * @param string            $domain   The requested domain.
+     * @param string            $path     The requested path, in full.
+     * @param int|null          $segments The suggested number of paths to consult.
+     *                                    Default null, meaning the entire path was to be consulted.
+     * @param array             $paths    The paths to search for, based on $path and $segments.
      */
     $pre = apply_filters( 'pre_get_site_by_path', null, $domain, $path, $segments, $paths );
     if ( null !== $pre ) {
+        if ( false !== $pre && ! $pre instanceof WP_Site ) {
+            $pre = new WP_Site( $pre );
+        }
         return $pre;
     }

trunk/tests/phpunit/tests/multisite/bootstrap.php

@@ -209 +209 @@
     }
 
+    /**
+     * @ticket 37053
+     */
+    public function test_get_site_by_path_returns_wp_site() {
+        add_filter( 'pre_get_site_by_path', array( $this, 'filter_pre_get_site_by_path' ), 10, 3 );
+
+        $site = get_site_by_path( 'example.com', '/foo/' );
+
+        remove_filter( 'pre_get_site_by_path', array( $this, 'filter_pre_get_site_by_path' ), 10 );
+
+        $this->assertInstanceOf( 'WP_Site', $site );
+    }
+
     public function filter_path_segments_to_two() {
         return 2;
     }
+
+    public function filter_pre_get_site_by_path( $site, $domain, $path ) {
+        $site = new stdClass();
+        $site->blog_id = 100;
+        $site->domain = $domain;
+        $site->path = $path;
+        $site->site_id = 1;
+
+        return $site;
+    }
 }