Timber 2.x - ImageHelper::theme_url_to_dir() returns an invalid path when theme template is theme-name/theme

[Moustachos]

First, thanks for your great work on this project :)

Expected behavior

Path returned by ImageHelper::theme_url_to_dir() (https://github.com/timber/timber/blob/master/lib/ImageHelper.php#L445) should be consistent (always returning a file path), regardless of theme files structure.

In ImageHelper::theme_url_to_dir(), we should check if get_stylesheet() contains a / and only return what comes before the / when that's the case.

That way, $site_root won't contain /theme and theme url will properly be removed from $src.

Actual behavior

My theme has the following structure :
-- my-theme-name/
--- theme/
---- functions.php
---- style.css
--- images/
---- my-image.png

So my theme template is my-theme-name/theme and that's the value returned by get_stylesheet().

The problem is that in ImageHelper::theme_url_to_dir(), we use that to build $site_root variable, and $site_root ends with /theme (because of get_stylesheet()). But in $src, there's no /theme (because images are stored in my-theme-name/images/), so the following code fails to replace $site_root from url:
$tmp = str_replace($site_root, '', $src);

And I end up with errors in my logs whenever I try to use any Twig filter (like |webp) on a theme image:
[25-May-2021 14:20:37 UTC] [ Timber ] Error loading /[...]/themes/my-theme-name/themehttps://[...]/themes/my-theme-name/build/images/my-image.png

The /theme shouldn't be here.

Steps to reproduce behavior

• create a new theme with above files structure (taken from Starter theme 2.x: https://github.com/timber/starter-theme/tree/2.x)
• add a theme image in theme-name/images/
• load this image inside a Twig file and try to apply any image filter causing Timber to create a new image (like |webp)
• new image can't be created, because ImageHelper::theme_url_to_dir() fails to replace theme url from image $src
• see errors in PHP log

What version of WordPress, PHP and Timber are you using?

WordPress 5.7.2, PHP 7.4, Timber 2.0-dev.

How did you install Timber? (for example, from GitHub, Composer/Packagist, WP.org?)

Through Composer.

[nlemoine]

Sorry, I don't think we should support this non standard structure/edge case in core (already discussed in #2458).

The very best we could do is providing a filter so users could add their workaround.

@gchtr, @Levdbas what do you think?

[Levdbas]

A filter sounds like the way to go for me as well.

[gchtr]

Providing the relevant filters is the way to go for me as well. A pull request with the filters was already submitted in #2725.

As far as I can see, adding filters will not be a breaking change, so we could safely postpone this for 2.1 (see #2741). Let’s leave this issue open until the pull request is merged.

[Levdbas]

As discussed yesterday, this will be a minor change and thus something we can do in 2.0.1

[Levdbas]

PR merged