Changeset 37468 for trunk/src/wp-includes/ms-blogs.php

Timestamp:

05/20/2016 04:40:39 AM (8 years ago)

Author:

jeremyfelt

Message:

Multisite: Introduce get_site()

Given a site ID or site object, get_site() retrieves site data in the same vein as get_post() or get_comment(). This will allow for clean retrieval of sites from a primed cache when WP_Site_Query is implemented.

Adds a WP_Site::to_array() method to support multiple return types within get_site().

Props spacedmonkey.
See #35791.

File:

• trunk/src/wp-includes/ms-blogs.php (modified) (1 diff)

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

@@ -469 +469 @@
 
 /**
+ * Retrieves site data given a site ID or site object.
+ *
+ * Site data will be cached and returned after being passed through a filter.
+ * If the provided site is empty, the current site global will be used.
+ *
+ * @since 4.6.0
+ *
+ * @global WP_Site $current_blog The current site.
+ *
+ * @param WP_Site|int $site   Site to retrieve.
+ * @param string      $output Optional. Type of output to return. OBJECT or ARRAY_A or ARRAY_N constants.
+ * @return WP_Site|array|null Depends on $output value.
+ */
+function get_site( &$site = null, $output = OBJECT ) {
+    global $current_blog;
+    if ( empty( $site ) && isset( $current_blog ) ) {
+        $site = $current_blog;
+    }
+
+    if ( $site instanceof WP_Site ) {
+        $_site = $site;
+    } elseif ( is_object( $site ) ) {
+        $_site = new WP_Site( $site );
+    } else {
+        $_site = WP_Site::get_instance( $site );
+    }
+
+    if ( ! $_site ) {
+        return null;
+    }
+
+    /**
+     * Fires after a site is retrieved.
+     *
+     * @since 4.6.0
+     *
+     * @param mixed $_site Site data.
+     */
+    $_site = apply_filters( 'get_site', $_site );
+
+    if ( $output == OBJECT ) {
+        return $_site;
+    } elseif ( $output == ARRAY_A ) {
+        return $_site->to_array();
+    } elseif ( $output == ARRAY_N ) {
+        return array_values( $_site->to_array() );
+    }
+
+    return $_site;
+}
+
+/**
  * Retrieve option value for a given blog id based on name of option.
  *