Changeset 32611 for trunk/src/wp-includes/ms-load.php

Timestamp:

05/26/2015 09:50:13 PM (10 years ago)

Author:

wonderboymusic

Message:

Fix doc blocks for ms-*.php files.
A few functions can return a conditional instead of an if/else of true/false.

See #32444.

File:

• trunk/src/wp-includes/ms-load.php (modified) (7 diffs)

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

@@ -20 +20 @@
         return SUBDOMAIN_INSTALL;
 
-    if ( defined('VHOST') && VHOST == 'yes' )
-        return true;
-
-    return false;
+    return ( defined( 'VHOST' ) && VHOST == 'yes' );
 }
 
@@ -69 +66 @@
  * @since 3.0.0
  *
- * @return bool|string Returns true on success, or drop-in file to include.
+ * @return true|string Returns true on success, or drop-in file to include.
  */
 function ms_site_check() {
@@ -118 +115 @@
  * @since 3.9.0
  *
+ * @global wpdb $wpdb
+ *
  * @param string   $domain   Domain to check.
  * @param string   $path     Path to check.
  * @param int|null $segments Path segments to use. Defaults to null, or the full path.
- * @return object|bool Network object if successful. False when no network is found.
+ * @return object|false Network object if successful. False when no network is found.
  */
 function get_network_by_path( $domain, $path, $segments = null ) {
@@ -261 +260 @@
  * @since 3.9.0
  *
+ * @global wpdb $wpdb
+ *
  * @param object|int $network The network's database row or ID.
- * @return object|bool Object containing network information if found, false if not.
+ * @return object|false Object containing network information if found, false if not.
  */
 function wp_get_network( $network ) {
@@ -282 +283 @@
  * @since 3.9.0
  *
+ * @global wpdb $wpdb
+ *
  * @param string   $domain   Domain to check.
  * @param string   $path     Path to check.
  * @param int|null $segments Path segments to use. Defaults to null, or the full path.
- * @return object|bool Site object if successful. False when no site is found.
+ * @return object|false Site object if successful. False when no site is found.
  */
 function get_site_by_path( $domain, $path, $segments = null ) {
@@ -392 +395 @@
  * @access private
  * @since 3.0.0
+ *
+ * @global wpdb   $wpdb
+ * @global string $domain
+ * @global string $path
  */
 function ms_not_installed() {
@@ -464 +471 @@
  * @deprecated 3.9.0
  *
+ * @global object $current_site
+ *
  * @return object
  */