Changeset 35573 for trunk/src/wp-includes/class-wp-network.php

Timestamp:

11/08/2015 02:24:32 AM (9 years ago)

Author:

jeremyfelt

Message:

Multisite: Clarify documentation for WP_Network::get_by_path().

See #31985.

File:

• trunk/src/wp-includes/class-wp-network.php (modified) (1 diff)

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

@@ -170 +170 @@
 
     /**
-     * Retrieve a network by its domain and path.
+     * Retrieve the closest matching network for a domain and path.
+     *
+     * This will not necessarily return an exact match for a domain and path. Instead, it
+     * breaks the domain and path into pieces that are then used to match the closest
+     * possibility from a query.
+     *
+     * The intent of this method is to match a network during bootstrap for a
+     * requested site address.
      *
      * @since 4.4.0