Skip to content

Commit ce0e56b

Browse files
felixarntzfelixarntz
committed
Add speculation rules URL pattern prefixer to support WordPress site in subdirectories.
1 parent 7404f02 commit ce0e56b

File tree

4 files changed

+170
-7
lines changed

4 files changed

+170
-7
lines changed

‎modules/js-and-css/speculation-rules/class-plsr-url-pattern-prefixer.php

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<?php
2+
/**
3+
* Class 'PLSR_URL_Pattern_Prefixer'.
4+
*
5+
* @package performance-lab
6+
* @since n.e.x.t
7+
*/
8+
9+
/**
10+
* Class for prefixing URL patterns.
11+
*
12+
* @since n.e.x.t
13+
*/
14+
class PLSR_URL_Pattern_Prefixer {
15+
16+
/**
17+
* Map of `$context_string => $base_path` pairs.
18+
*
19+
* @since n.e.x.t
20+
* @var array
21+
*/
22+
private $contexts;
23+
24+
/**
25+
* Constructor.
26+
*
27+
* @since n.e.x.t
28+
*
29+
* @param array $contexts Optional. Map of `$context_string => $base_path` pairs. Default is the contexts returned
30+
* by the {@see PLSR_URL_Pattern_Prefixer::get_default_contexts()} method.
31+
*/
32+
public function __construct( array $contexts = array() ) {
33+
if ( $contexts ) {
34+
$this->contexts = array_map( 'trailingslashit', $contexts );
35+
} else {
36+
$this->contexts = self::get_default_contexts();
37+
}
38+
}
39+
40+
/**
41+
* Prefixes the given URL path pattern with the base path for the given context.
42+
*
43+
* This ensures that these path patterns work correctly on WordPress subdirectory sites, for example in a multisite
44+
* network, or when WordPress itself is installed in a subdirectory of the hostname.
45+
*
46+
* The given URL path pattern is only prefixed if it does not already include the expected prefix.
47+
*
48+
* @since n.e.x.t
49+
*
50+
* @param string $path_pattern URL pattern starting with the path segment.
51+
* @param string $context Optional. Either 'home' (any frontend content) or 'site' (content relative to the
52+
* directory that WordPress is installed in). Default 'home'.
53+
* @return string URL pattern, prefixed as necessary.
54+
*/
55+
public function prefix_path_pattern( string $path_pattern, string $context = 'home' ) {
56+
// If context path does not exist, the context is invalid.
57+
if ( ! isset( $this->contexts[ $context ] ) ) {
58+
_doing_it_wrong(
59+
__FUNCTION__,
60+
sprintf(
61+
/* translators: %s: context string */
62+
esc_html__( 'Invalid context %s.', 'performance-lab' ),
63+
esc_html( $context )
64+
),
65+
'Performance Lab n.e.x.t'
66+
);
67+
return $path_pattern;
68+
}
69+
70+
// If the path already starts with the context path (including '/'), there is nothing to prefix.
71+
if ( str_starts_with( $path_pattern, $this->contexts[ $context ] ) ) {
72+
return $path_pattern;
73+
}
74+
75+
return $this->contexts[ $context ] . ltrim( $path_pattern, '/' );
76+
}
77+
78+
/**
79+
* Returns the default contexts used by the class.
80+
*
81+
* @since n.e.x.t
82+
*
83+
* @return array Map of `$context_string => $base_path` pairs.
84+
*/
85+
public static function get_default_contexts(): array {
86+
return array(
87+
'home' => trailingslashit( wp_parse_url( home_url( '/' ), PHP_URL_PATH ) ),
88+
'site' => trailingslashit( wp_parse_url( site_url( '/' ), PHP_URL_PATH ) ),
89+
);
90+
}
91+
}

‎modules/js-and-css/speculation-rules/helper.php

+9-7
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@
1717
* @return array Associative array of speculation rules by type.
1818
*/
1919
function plsr_get_speculation_rules() {
20+
$prefixer = new PLSR_URL_Pattern_Prefixer();
21+
2022
$base_href_exclude_paths = array(
21-
'/wp-login.php',
22-
'/wp-admin/*',
23+
$prefixer->prefix_path_pattern( '/wp-login.php', 'site' ),
24+
$prefixer->prefix_path_pattern( '/wp-admin/*', 'site' ),
2325
);
2426
$href_exclude_paths = $base_href_exclude_paths;
2527

@@ -29,6 +31,8 @@ function plsr_get_speculation_rules() {
2931
* All paths should start in a forward slash, relative to the root document. The `*` can be used as a wildcard.
3032
* By default, the array includes `/wp-login.php` and `/wp-admin/*`.
3133
*
34+
* If the WordPress site is in a subdirectory, the exclude paths will automatically be prefixed as necessary.
35+
*
3236
* @since n.e.x.t
3337
*
3438
* @param array $href_exclude_paths Paths to disable speculative prerendering for.
@@ -38,10 +42,8 @@ function plsr_get_speculation_rules() {
3842
// Ensure that there are no duplicates and that the base paths cannot be removed.
3943
$href_exclude_paths = array_unique(
4044
array_map(
41-
static function ( $exclude_path ) {
42-
if ( ! str_starts_with( $exclude_path, '/' ) ) {
43-
$exclude_path = '/' . $exclude_path;
44-
}
45+
static function ( $exclude_path ) use ( $prefixer ) {
46+
$exclude_path = $prefixer->prefix_path_pattern( $exclude_path );
4547

4648
/*
4749
* TODO: Remove this eventually as it's no longer needed in Chrome 121+.
@@ -65,7 +67,7 @@ static function ( $exclude_path ) {
6567
'and' => array(
6668
// Prerender any URLs within the same site.
6769
array(
68-
'href_matches' => '/*\\?*',
70+
'href_matches' => $prefixer->prefix_path_pattern( '/*\\?*' ),
6971
'relative_to' => 'document',
7072
),
7173
// Except for WP login and admin URLs.

‎modules/js-and-css/speculation-rules/load.php

+1
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@
1515

1616
define( 'SPECULATION_RULES_VERSION', 'Performance Lab ' . PERFLAB_VERSION );
1717

18+
require_once __DIR__ . '/class-plsr-url-pattern-prefixer.php';
1819
require_once __DIR__ . '/helper.php';
1920
require_once __DIR__ . '/hooks.php';

‎tests/modules/js-and-css/speculation-rules/plsr-url-pattern-prefixer-test.php

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<?php
2+
/**
3+
* Tests for PLSR_URL_Pattern_Prefixer class.
4+
*
5+
* @package performance-lab
6+
* @group speculation-rules
7+
*/
8+
9+
class PLSR_URL_Pattern_Prefixer_Tests extends WP_UnitTestCase {
10+
11+
/**
12+
* @dataProvider data_prefix_path_pattern
13+
*/
14+
public function test_prefix_path_pattern( $base_path, $path_pattern, $expected ) {
15+
$p = new PLSR_URL_Pattern_Prefixer( array( 'demo' => $base_path ) );
16+
17+
$this->assertSame(
18+
$expected,
19+
$p->prefix_path_pattern( $path_pattern, 'demo' )
20+
);
21+
}
22+
23+
public function data_prefix_path_pattern() {
24+
return array(
25+
array( '/', '/my-page/', '/my-page/' ),
26+
array( '/', 'my-page/', '/my-page/' ),
27+
array( '/wp/', '/my-page/', '/wp/my-page/' ),
28+
array( '/wp/', 'my-page/', '/wp/my-page/' ),
29+
array( '/wp/', '/blog/2023/11/new-post/', '/wp/blog/2023/11/new-post/' ),
30+
array( '/wp/', 'blog/2023/11/new-post/', '/wp/blog/2023/11/new-post/' ),
31+
array( '/subdir', '/my-page/', '/subdir/my-page/' ),
32+
array( '/subdir', 'my-page/', '/subdir/my-page/' ),
33+
// Missing trailing slash still works, does not consider "cut-off" directory names.
34+
array( '/subdir', '/subdirectory/my-page/', '/subdir/subdirectory/my-page/' ),
35+
array( '/subdir', 'subdirectory/my-page/', '/subdir/subdirectory/my-page/' ),
36+
);
37+
}
38+
39+
public function test_get_default_contexts() {
40+
$contexts = PLSR_URL_Pattern_Prefixer::get_default_contexts();
41+
42+
$this->assertArrayHasKey( 'home', $contexts );
43+
$this->assertArrayHasKey( 'site', $contexts );
44+
$this->assertSame( '/', $contexts['home'] );
45+
$this->assertSame( '/', $contexts['site'] );
46+
}
47+
48+
public function test_get_default_contexts_with_subdirectories() {
49+
add_filter(
50+
'home_url',
51+
static function () {
52+
return 'https://example.com/subdir/';
53+
}
54+
);
55+
add_filter(
56+
'site_url',
57+
static function () {
58+
return 'https://example.com/subdir/wp/';
59+
}
60+
);
61+
62+
$contexts = PLSR_URL_Pattern_Prefixer::get_default_contexts();
63+
64+
$this->assertArrayHasKey( 'home', $contexts );
65+
$this->assertArrayHasKey( 'site', $contexts );
66+
$this->assertSame( '/subdir/', $contexts['home'] );
67+
$this->assertSame( '/subdir/wp/', $contexts['site'] );
68+
}
69+
}

0 commit comments

Comments
 (0)