Breaking change in PageRender::renderPage()

[Toutouwai]

PW 3.0.253 makes changes to the PageRender class. Previously there was a hookable PageRender::renderPage() method that hooked Page::render().

https://github.com/processwire/processwire/blob/44fcf13ea2d7f14a04eed54c29afcc79eb46ec45/wire/modules/PageRender.module#L72

It looks like the changes are intended to be backwards compatible:

https://github.com/processwire/processwire/blob/40c456c257e2978a7224956be01cb0106a62d05b/wire/modules/PageRender.module#L396-L406

But in constructing $legacyHookEvent the event object is set to $this (i.e. PageRender) whereas previously the event object would have been Page. This breaks existing code/modules that are hooking PageRender::renderPage().

[Toutouwai]

Not sure if my diagnosis of the problem above is correct but here is a demo of the issue.

$wire->addHookBefore('PageRender::renderPage', function(HookEvent $event) {
    $otherEvent = $event->arguments(0);
    bd($otherEvent->object, "otherEvent->object");
});

PW 3.0.246 master:

PW 3.0.253 dev:

[romaincazier]

I can confirm this as I'm using this hook in modules I made (PageMjmlToHtml and MarkupComponents)

[romaincazier]

It looks like it’s just a matter of replacing $this by $page on line 399

[ryancramerdesign]

Thanks—fixed!

[Toutouwai]

There is still a breaking change here. I'm sure I'm not the only one with code in place that does something like this:

$wire->addHookBefore('PageRender::renderPage', function(HookEvent $event) {
	$otherEvent = $event->arguments(0);
	/** @var Page $page */
	$page = $otherEvent->object;
	// Replace normal page rendering when some test is met
	if($page->template == 'basic-page') {
		$event->replace = true;
		$otherEvent->cancelHooks = true; // Prevent other hooks, e.g. ProCache caching the rendered markup
		$otherEvent->return = "Hello";
	}
});

Output in PW 3.0.246 master

Output in PW 3.0.254 dev

(i.e. no output)