WP_URL_Pattern_Prefixer

18class WP_URL_Pattern_Prefixer {19 20	/**21	 * Map of `$context_string => $base_path` pairs.22	 *23	 * @since 6.8.024	 * @var array<string, string>25	 */26	private $contexts;27 28	/**29	 * Constructor.30	 *31	 * @since 6.8.032	 *33	 * @param array<string, string> $contexts Optional. Map of `$context_string => $base_path` pairs. Default is the34	 *                                        contexts returned by the35	 *                                        {@see WP_URL_Pattern_Prefixer::get_default_contexts()} method.36	 */37	public function __construct( array $contexts = array() ) {38		if ( count( $contexts ) > 0 ) {39			$this->contexts = array_map(40				static function ( string $str ): string {41					return self::escape_pattern_string( trailingslashit( $str ) );42				},43				$contexts44			);45		} else {46			$this->contexts = self::get_default_contexts();47		}48	}49 50	/**51	 * Prefixes the given URL path pattern with the base path for the given context.52	 *53	 * This ensures that these path patterns work correctly on WordPress subdirectory sites, for example in a multisite54	 * network, or when WordPress itself is installed in a subdirectory of the hostname.55	 *56	 * The given URL path pattern is only prefixed if it does not already include the expected prefix.57	 *58	 * @since 6.8.059	 *60	 * @param string $path_pattern URL pattern starting with the path segment.61	 * @param string $context      Optional. Context to use for prefixing the path pattern. Default 'home'.62	 * @return string URL pattern, prefixed as necessary.63	 */64	public function prefix_path_pattern( string $path_pattern, string $context = 'home' ): string {65		// If context path does not exist, the context is invalid.66		if ( ! isset( $this->contexts[ $context ] ) ) {67			_doing_it_wrong(68				__FUNCTION__,69				esc_html(70					sprintf(71						/* translators: %s: context string */72						__( 'Invalid URL pattern context %s.' ),73						$context74					)75				),76				'6.8.0'77			);78			return $path_pattern;79		}80 81		/*82		 * In the event that the context path contains a :, ? or # (which can cause the URL pattern parser to switch to83		 * another state, though only the latter two should be percent encoded anyway), it additionally needs to be84		 * enclosed in grouping braces. The final forward slash (trailingslashit ensures there is one) affects the85		 * meaning of the * wildcard, so is left outside the braces.86		 */87		$context_path         = $this->contexts[ $context ];88		$escaped_context_path = $context_path;89		if ( strcspn( $context_path, ':?#' ) !== strlen( $context_path ) ) {90			$escaped_context_path = '{' . substr( $context_path, 0, -1 ) . '}/';91		}92 93		/*94		 * If the path already starts with the context path (including '/'), remove it first95		 * since it is about to be added back.96		 */97		if ( str_starts_with( $path_pattern, $context_path ) ) {