Add support for custom ports in multisite site addresses

[djzone]

This patch enables MultiSite to be used with a custom port, what must be defined as WP_CUSTOM_PORT in wp-config.php.

[djzone]

Multisite custom port patch

[scribu]

Couldn't we use parse_url() for these things?

[nacin]

Yeah. ms-settings.php could stand for a scrub.

I've never been sure why custom ports are blocked in multisite. During the merge in 3.0, we tried to clean things up, but we tried not to ask "why" too often as everything would have been a rabbit hole.

We should probably review the history in MU and then work to just allow custom ports to work, without a constant.

[ipstenu]

Looks like it was hard coded in to use 80.

​http://mu.wordpress.org/forums/topic/14587

[F J Kaiser]

+1 Just encountered a situation where I - in a local MU setup - can't use the default port of :80/:443. Now I'm left with a core hack.

[F J Kaiser]

Related #15936

[F J Kaiser]

Scribus idea with parse_url is likely the route to go. Patch following that will

• also takes the absence of $_SERVER['HTTP_HOST'] into account and switch to $_SERVER['SERVER_NAME'] for reliability and those edge cases
• takes the domain via parse_url() and PHP_URL_PATH
• still falls back to the default wp_die()-message in case somehow couldn't get rid of the port

Patch needs more intense testing.

[F J Kaiser]

Ignore previous patch - added .php extension per accident

[F J Kaiser]

Closed in favor of #15936 as it seems to address IPv6 issues as well. Adding new patch there.

[SergeyBiryukov]

Duplicate of #15936.

[jeremyfelt]

Prior work on custom port numbers from 15936

[jeremyfelt]

I've reopened this ticket since it was one of the first closed as a duplicate of #15936, which we've now closed as a separate area of focus. See also #42993, which can be considered a duplicate of this ticket. I've also attached the latest patch from #15936, 15936.5.diff​, which handles some port number changes and some unnecessary IPv6 changes.

A few things to watch for / decide on:

• Is it enough to just support port numbers in the multisite bootstrap or should the UI fully support them as well? Things may seem a little strange at first.
• Should all port numbers be allowed or should there be a filtered list?

The best place to test this now may be in the default WordPress local development environment, which uses localhost:8889 as its address and requires a port number.

[johnjamesjacoby]

Should all port numbers be allowed or should there be a filtered list?

I think all port numbers should be allowed.

Story time. Yesterday I had to switch back to using MAMP PRO for local stuff. It makes both Apache and Nginx web servers available, both with http and https schemes, all on different ports. Depending on my /etc/hosts setup, depending on WordPress constants and options being filtered, depending on what I'm working on or testing, it's pretty convenient to have WordPress available on so many different ports.

MAMP has its own default ports but you can easily use 80/443/81/7443, or whatever you want really. The ability to use any port numbers is useful if you also have Docker/Lando running, or have Local running, or Valet, etc... especially when transitioning between environments.

I assume it would also be really useful with running multiple instances of something like VVV.

Lastly, ports are valid URL segments, even if they are weird to see. IMO, that means there is some inherent obligation to support them.

[jeremyfelt]

Replying to johnjamesjacoby:

Should all port numbers be allowed or should there be a filtered list?

I think all port numbers should be allowed.

I think this makes sense, especially given the story. That said, if there was a way to just get #52088 out the door by supporting only the port that WordPress is using for its development environment, that would at least be a start.

I'm not actively involved with this ticket, but I want to clarify my last comment in case it's preventing further progress here. 15936.5.diff​ is some prior work from another ticket and I don't think it addresses what is actually needed for this. It does provide some prior patch art though.

What's missing for this current ticket (IMO) is:

• Proposed solution to how a custom port should be recognized and managed in bootstrap/load and (maybe? maybe not) managed with networks/sites in the network admin UI.
• How to test the solution as part of the standard WP build process. Unit tests, end to end tests?
• Code to implement the above.
• How to test the solution locally. (Maybe it's just that the dev environment works!) :)

I'm happy to help with testing in a local environment once it's there, but I don't have the bandwidth for solution creating right now. :)

[spacedmonkey]

I think the question is, do we officially support custom ports, add a input when you register a site and save the port number somewhere ( site meta ). Then change bootstrap to support any port.

Or do we just give enough filters and hooks to enable developers to add support themselves, similar to domain mapping.

I would recommend the second course and I would even write a drop in / plugin to allow developers to do this.

I think that the current patch 15936.5.diff does solve this problem and does allow developers to do what they want.

Currently to add a custom port, you would have to add a sunrise.php and then add a filter that looks like this.

add_filters('allowed_multisite_ports', function( $current ){
  $current[] = ':81';

  return $current;
});

I think we would also need something in the bootstrap to looks up the site via a port.

This is work of course, but is not exactly use friendly. Maybe instead of filter, we could do with a PHP const.

define( 'WP_ALLOWED_PORTED', '80, 443' );

Once noting that not really good idea to have an array value of a const. So we could just use ​wp_parse_list.

So when we use it, would looks like this.

 $allowed_ports = wp_parse_list( WP_ALLOWED_PORTED );

Thoughts @jeremyfelt @johnjamesjacoby

Fix bug in patch 15936.5.diff, re-add the port number in ms-site.php

Trac ticket: https://core.trac.wordpress.org/ticket/21077

[PerS]

Please be nice, the pull request is my first patch :)

You can test it locally using VS Code devcontainer ​available as part of my plugin. A ​how-to is also available.

@costdev I'm looking into why the unit tests failed.

@costdev New unit test added.

[Clorith]

I'll add a note that multisite with custom ports appear to work out of the box, but requires you to edit the wp_sites database entry, and add the :<port> your self. This is because the sanitize on save function in multisite strips out :, leaving you with a url<port> instead of url:<port> db entry if using the interface.

I'm not sure if there's any other issue besides this one, if there's any concerns beyond back-compat then this is the place to outline them, but from some preliminary testing it would appear that updating the filters to allow a format of :[0-9]+ to pass through the sanitizer on save shouldn't break anything, and open things up for custom ports to the users hearts desire 🤔

[spacedmonkey]

I spent another couple of hours hacking on this problem, still finding issues. The issue, as I see, it where to store the custom port. If you store it as part of a domain, then that makes issues all over core, when domain is no longer domain but domain + port. I had to make lots of changes to get multisite to even bootstrap. The best place to store port number is in site ( blog ) meta. This keep the port number close to the site in meta but does not break anything.

I prototyped how this might work in ​this sunrise.php dropin.

What made it hard to test, was the lack of this filter.

$allowed_ports = apply_filters( 'allowed_multisite_ports', array( ':80', ':443' ) );

To help third parties be able to work out their own solution for this, I recommend a new ticket to add this filter. That way this functionality is not blocked while we work on another solution.

[ironprogrammer]

#57748 was marked as a duplicate.

[ironprogrammer]

#42993 was marked as a duplicate.

[Jules Colle]

My multisite network is running on localhost:8082. Everything seems to be working fine for now with this code:

<?php
add_filter( 'wp_normalize_site_data', function( $data ) {
    $data['domain'] = str_replace('8082', ':8082', $data['domain']);
    return $data;
}, 50, 1 );

I've added this in mu-plugins, but I guess it can go in your theme's functions.php or a regular plugin as well.

I can add a new site trough wp-admin or via wpmu_create_blog() without any problems.

Note that if your domain is called domain8082.com or something similar, this code will not work :)

This _should_ cover all of the areas that break when using multisite with a port.

Trac ticket: https://core.trac.wordpress.org/ticket/21077

This _should_ cover all of the areas that break when using multisite with a port.

Trac ticket: https://core.trac.wordpress.org/ticket/21077

[obliviousharmony]

I ran into this problem adding multisite to our development environment and took a pass at fixing it. I looked through all of the multisite code to find any instances where the presence of a port would cause problems and fixed them. Let's get this across the finish line!