<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[34099] trunk/src/wp-includes: Multisite: Implement the `get_by_path` method in `WP_Network`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/34099">34099</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/34099","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jeremyfelt</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-13 23:39:20 +0000 (Sun, 13 Sep 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Multisite: Implement the `get_by_path` method in `WP_Network`.
Move the internals of `get_network_by_path()` to `WP_Network()` and allow network objects to be retrieved by passing a requested domain and path.
Props johnjamesjacoby, jeremyfelt, drewapicture, wonderboymusic.
See <a href="https://core.trac.wordpress.org/ticket/31985">#31985</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpnetworkphp">trunk/src/wp-includes/class-wp-network.php</a></li>
<li><a href="#trunksrcwpincludesmsloadphp">trunk/src/wp-includes/ms-load.php</a></li>
<li><a href="#trunksrcwpincludesmssettingsphp">trunk/src/wp-includes/ms-settings.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpnetworkphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-network.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-network.php 2015-09-13 23:33:30 UTC (rev 34098)
+++ trunk/src/wp-includes/class-wp-network.php 2015-09-13 23:39:20 UTC (rev 34099)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -151,4 +151,158 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->cookie_domain = substr( $this->cookie_domain, 4 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Retrieve a network by its domain and path.
+ *
+ * @since 4.4.0
+ * @access public
+ * @static
+ *
+ * @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 WP_Network|bool Network object if successful. False when no network is found.
+ */
+ public static function get_by_path( $domain = '', $path = '', $segments = null ) {
+ global $wpdb;
+
+ $domains = array( $domain );
+ $pieces = explode( '.', $domain );
+
+ /*
+ * It's possible one domain to search is 'com', but it might as well
+ * be 'localhost' or some other locally mapped domain.
+ */
+ while ( array_shift( $pieces ) ) {
+ if ( ! empty( $pieces ) ) {
+ $domains[] = implode( '.', $pieces );
+ }
+ }
+
+ /*
+ * If we've gotten to this function during normal execution, there is
+ * more than one network installed. At this point, who knows how many
+ * we have. Attempt to optimize for the situation where networks are
+ * only domains, thus meaning paths never need to be considered.
+ *
+ * This is a very basic optimization; anything further could have
+ * drawbacks depending on the setup, so this is best done per-install.
+ */
+ $using_paths = true;
+ if ( wp_using_ext_object_cache() ) {
+ $using_paths = wp_cache_get( 'networks_have_paths', 'site-options' );
+ if ( false === $using_paths ) {
+ $using_paths = $wpdb->get_var( "SELECT id FROM {$wpdb->site} WHERE path <> '/' LIMIT 1" );
+ wp_cache_add( 'networks_have_paths', (int) $using_paths, 'site-options' );
+ }
+ }
+
+ $paths = array();
+ if ( true === $using_paths ) {
+ $path_segments = array_filter( explode( '/', trim( $path, '/' ) ) );
+
+ /**
+ * Filter the number of path segments to consider when searching for a site.
+ *
+ * @since 3.9.0
+ *
+ * @param int|null $segments The number of path segments to consider. WordPress by default looks at
+ * one path segment. The function default of null only makes sense when you
+ * know the requested path should match a network.
+ * @param string $domain The requested domain.
+ * @param string $path The requested path, in full.
+ */
+ $segments = apply_filters( 'network_by_path_segments_count', $segments, $domain, $path );
+
+ if ( ( null !== $segments ) && count( $path_segments ) > $segments ) {
+ $path_segments = array_slice( $path_segments, 0, $segments );
+ }
+
+ while ( count( $path_segments ) ) {
+ $paths[] = '/' . implode( '/', $path_segments ) . '/';
+ array_pop( $path_segments );
+ }
+
+ $paths[] = '/';
+ }
+
+ /**
+ * Determine a network by its domain and path.
+ *
+ * This allows one to short-circuit the default logic, perhaps by
+ * replacing it with a routine that is more optimal for your setup.
+ *
+ * Return null to avoid the short-circuit. Return false if no network
+ * can be found at the requested domain and path. Otherwise, return
+ * an object from wp_get_network().
+ *
+ * @since 3.9.0
+ *
+ * @param null|bool|object $network Network 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_network_by_path', null, $domain, $path, $segments, $paths );
+ if ( null !== $pre ) {
+ return $pre;
+ }
+
+ // @todo Consider additional optimization routes, perhaps as an opt-in for plugins.
+ // We already have paths covered. What about how far domains should be drilled down (including www)?
+
+ $search_domains = "'" . implode( "', '", $wpdb->_escape( $domains ) ) . "'";
+
+ if ( false === $using_paths ) {
+ $network = $wpdb->get_row( "
+ SELECT * FROM {$wpdb->site}
+ WHERE domain IN ({$search_domains})
+ ORDER BY CHAR_LENGTH(domain)
+ DESC LIMIT 1
+ " );
+
+ if ( ! empty( $network ) && ! is_wp_error( $network ) ) {
+ return new WP_Network( $network );
+ }
+
+ return false;
+
+ } else {
+ $search_paths = "'" . implode( "', '", $wpdb->_escape( $paths ) ) . "'";
+ $networks = $wpdb->get_results( "
+ SELECT * FROM {$wpdb->site}
+ WHERE domain IN ({$search_domains})
+ AND path IN ({$search_paths})
+ ORDER BY CHAR_LENGTH(domain) DESC, CHAR_LENGTH(path) DESC
+ " );
+ }
+
+ /*
+ * Domains are sorted by length of domain, then by length of path.
+ * The domain must match for the path to be considered. Otherwise,
+ * a network with the path of / will suffice.
+ */
+ $found = false;
+ foreach ( $networks as $network ) {
+ if ( ( $network->domain === $domain ) || ( "www.{$network->domain}" === $domain ) ) {
+ if ( in_array( $network->path, $paths, true ) ) {
+ $found = true;
+ break;
+ }
+ }
+ if ( $network->path === '/' ) {
+ $found = true;
+ break;
+ }
+ }
+
+ if ( true === $found ) {
+ return new WP_Network( $network );
+ }
+
+ return false;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesmsloadphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/ms-load.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/ms-load.php 2015-09-13 23:33:30 UTC (rev 34098)
+++ trunk/src/wp-includes/ms-load.php 2015-09-13 23:39:20 UTC (rev 34099)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -113,145 +113,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieve a network object by its domain and path.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 Converted to a wrapper for WP_Network::get_by_path()
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global wpdb $wpdb
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Domain to check.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $path Path to check.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|null $segments Path segments to use. Defaults to null, or the full path.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return object|false Network object if successful. False when no network is found.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Network|false Network object if successful. False when no network is found.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_network_by_path( $domain, $path, $segments = null ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wpdb;
-
- $domains = array( $domain );
- $pieces = explode( '.', $domain );
-
- /*
- * It's possible one domain to search is 'com', but it might as well
- * be 'localhost' or some other locally mapped domain.
- */
- while ( array_shift( $pieces ) ) {
- if ( $pieces ) {
- $domains[] = implode( '.', $pieces );
- }
- }
-
- /*
- * If we've gotten to this function during normal execution, there is
- * more than one network installed. At this point, who knows how many
- * we have. Attempt to optimize for the situation where networks are
- * only domains, thus meaning paths never need to be considered.
- *
- * This is a very basic optimization; anything further could have drawbacks
- * depending on the setup, so this is best done per-install.
- */
- $using_paths = true;
- if ( wp_using_ext_object_cache() ) {
- $using_paths = wp_cache_get( 'networks_have_paths', 'site-options' );
- if ( false === $using_paths ) {
- $using_paths = (bool) $wpdb->get_var( "SELECT id FROM $wpdb->site WHERE path <> '/' LIMIT 1" );
- wp_cache_add( 'networks_have_paths', (int) $using_paths, 'site-options' );
- }
- }
-
- $paths = array();
- if ( $using_paths ) {
- $path_segments = array_filter( explode( '/', trim( $path, "/" ) ) );
-
- /**
- * Filter the number of path segments to consider when searching for a site.
- *
- * @since 3.9.0
- *
- * @param int|null $segments The number of path segments to consider. WordPress by default looks at
- * one path segment. The function default of null only makes sense when you
- * know the requested path should match a network.
- * @param string $domain The requested domain.
- * @param string $path The requested path, in full.
- */
- $segments = apply_filters( 'network_by_path_segments_count', $segments, $domain, $path );
-
- if ( null !== $segments && count($path_segments ) > $segments ) {
- $path_segments = array_slice( $path_segments, 0, $segments );
- }
-
- while ( count( $path_segments ) ) {
- $paths[] = '/' . implode( '/', $path_segments ) . '/';
- array_pop( $path_segments );
- }
-
- $paths[] = '/';
- }
-
- /**
- * Determine a network by its domain and path.
- *
- * This allows one to short-circuit the default logic, perhaps by
- * replacing it with a routine that is more optimal for your setup.
- *
- * Return null to avoid the short-circuit. Return false if no network
- * can be found at the requested domain and path. Otherwise, return
- * an object from wp_get_network().
- *
- * @since 3.9.0
- *
- * @param null|bool|object $network Network 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_network_by_path', null, $domain, $path, $segments, $paths );
- if ( null !== $pre ) {
- return $pre;
- }
-
- // @todo Consider additional optimization routes, perhaps as an opt-in for plugins.
- // We already have paths covered. What about how far domains should be drilled down (including www)?
-
- $search_domains = "'" . implode( "', '", $wpdb->_escape( $domains ) ) . "'";
-
- if ( ! $using_paths ) {
- $network = $wpdb->get_row( "SELECT id, domain, path FROM $wpdb->site
- WHERE domain IN ($search_domains) ORDER BY CHAR_LENGTH(domain) DESC LIMIT 1" );
- if ( $network ) {
- return wp_get_network( $network );
- }
- return false;
-
- } else {
- $search_paths = "'" . implode( "', '", $wpdb->_escape( $paths ) ) . "'";
- $networks = $wpdb->get_results( "SELECT id, domain, path FROM $wpdb->site
- WHERE domain IN ($search_domains) AND path IN ($search_paths)
- ORDER BY CHAR_LENGTH(domain) DESC, CHAR_LENGTH(path) DESC" );
- }
-
- /*
- * Domains are sorted by length of domain, then by length of path.
- * The domain must match for the path to be considered. Otherwise,
- * a network with the path of / will suffice.
- */
- $found = false;
- foreach ( $networks as $network ) {
- if ( $network->domain === $domain || "www.$network->domain" === $domain ) {
- if ( in_array( $network->path, $paths, true ) ) {
- $found = true;
- break;
- }
- }
- if ( $network->path === '/' ) {
- $found = true;
- break;
- }
- }
-
- if ( $found ) {
- return wp_get_network( $network );
- }
-
- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return WP_Network::get_by_path( $domain, $path, $segments );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunksrcwpincludesmssettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/ms-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/ms-settings.php 2015-09-13 23:33:30 UTC (rev 34098)
+++ trunk/src/wp-includes/ms-settings.php 2015-09-13 23:39:20 UTC (rev 34099)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,7 +87,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $current_site ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $current_site = get_network_by_path( $domain, $path, 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $current_site = WP_Network::get_by_path( $domain, $path, 1 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $current_site ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -118,7 +118,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $current_site = WP_Network::get_instance( $current_blog->site_id ? $current_blog->site_id : 1 );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> // If you don't have a site with the same domain/path as a network, you're pretty screwed, but:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $current_site = get_network_by_path( $domain, $path, 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $current_site = WP_Network::get_by_path( $domain, $path, 1 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>