Customize: get_custom_logo filter should include blog parameter

[achbed]

The get_custom_logo function potentially performs a blog context switch in order to render the custom logo. However, the get_custom_logo filter is not called within that context switch, and the filter handlers have no way of knowing if a blog context switch was requested or required.

This patch solves both problems by providing the blog ID parameter to the get_custom_logo filter as well as moving the filter call so that it is in the same blog context.

[westonruter]

Good one. Makes sense to me!

[ocean90]

Yep, makes sense and would be consistent with get_site_icon_url. But let's not change the restore_current_blog() part.

[achbed]

The patch doesn't modify the restore_current_blog() call itself, just the lines before and after. Those lines got included by svn diff automagically.

[juanfra]

Patch without modifying the restore_current_blog() position

[achbed]

Should we not do the get_custom_logo filtering while we're in the switched blog scope? That would allow more consistent results if the alternate blog has additional filtering wouldn't it?

[flixos90]

Replying to achbed:

Should we not do the get_custom_logo filtering while we're in the switched blog scope? That would allow more consistent results if the alternate blog has additional filtering wouldn't it?

The filter is currently applied outside of the switched blog scope, so we should stick with this for backwards compatibility in case someone is using the filter at this point. Applying the filter inside the switched scope could cause inconsistencies with whatever logic is executed in the filter functions.

Another reason to apply the filter outside of the switched scope is to be consistent with get_site_icon_url, as stated above.

[achbed]

Replying to flixos90:

Replying to achbed:

Should we not do the get_custom_logo filtering while we're in the switched blog scope? That would allow more consistent results if the alternate blog has additional filtering wouldn't it?

The filter is currently applied outside of the switched blog scope, so we should stick with this for backwards compatibility in case someone is using the filter at this point. Applying the filter inside the switched scope could cause inconsistencies with whatever logic is executed in the filter functions.

Another reason to apply the filter outside of the switched scope is to be consistent with get_site_icon_url, as stated above.

That makes sense. I concur - let's go with 36639.2.patch then. Thanks for the input (and thanks @juanfra for working that up)!

[juanfra]

@achbed my pleasure :)

[chriscct7]

Docbloc needs an update to mention parameter since 4.6

[ocean90]

In 37645:

Template: Pass $blog_id to the get_custom_logo filter.

Props achbed, juanfra.
Fixes #36639.