Manipulating the output of Admin Search Box Autocomplete is not working anymore (PW >= 3.0.108)

[gingebaker]

Short description of the issue

Since PW >= 3.0.108 I am not able to hook in the Admin Search Box Autocomplete anymore. I am trying to manipulate the output of the standard title field to some customized output (other fields, concatenating fields, etc.)

Expected behavior

Before 3.0.108 I used:

$this->addHookAfter('ProcessPageSearch::executeFor',$this,'executeFor');

and for example this hook to get this behaviour:

public function executeFor($event) {
        $return = json_decode($event->return);
        if($this->input->get->admin_search) {
            $return = json_decode($event->return);
            if(isset($return->matches)) {
                $didChange = false;
                foreach($return->matches as $key => $match) {
                    if($match->template == "templateX" || $match->template == "templateY") {
                        // add vorname and nachname to title
                        $matchPage = $this->pages->get($match->id);
                        $return->matches[$key]->title = $match->title.' - '.$matchPage->get('nachname').' '.$matchPage->get('vorname');
                        $didChange = true;
                    }
                }
                if($didChange) {
                    $event->return = json_encode($return);
                }
            }
        }
    }

Actual behavior

Now with the new ProcessPageSearchLive.php Module it seems that this is not possible anymore.
There are the two hookable functions ___renderList and ___renderItem, but they are only called by viewAll Output.

So the code where I should hook into is somewhere in the findPages() function of ProcessPageSearchLive.php, but I could not find a way to Hook into and modify it?
https://github.com/processwire/processwire/blob/dev/wire/modules/Process/ProcessPageSearch/ProcessPageSearchLive.php#L736

Optional: Suggestion for a possible fix

This could be solved by hooking the ProcessPageSearchLive::find() or ProcessPageSearch::findPages() function to manipulate the returned $items or $matches array. Or even the ProcessPageSearch::execute() function?

There is a related request to also use the standard Page List Display format from template settings in the Admin Search Box. see here: processwire/processwire-requests#214 wich looks like a good addon too.

It would be great to get this working again! Thank you.

[gingebaker]

There is a workaround in the forums here:
https://processwire.com/talk/topic/19781-issue-with-hooking-processpagesearchexecutefor-and-the-new-search-feature-in-pw-30108/?tab=comments#comment-171665

I just tried that and it works. So if we could get the ProcessPageSearchLive::execute function hookable than this would work without copying the module as described in the workaround.

[ryancramerdesign]

Sure, that's no problem—I have updated it so that the execute method is now hookable.

[gingebaker]

Hello Ryan.
Thank your for the fix.
I just tested it with 3.0.112 and it works. However, it was a little tricky to implement the Hook correct for the fixed $getJSON = true variable in the Hooked Method. It seems that in the Hooked Method this variable is NULL when I try to get it via $event->arguments(0). Perhaps because it is not explicitly set in the call at:
https://github.com/processwire/processwire/blob/dev/wire/modules/Process/ProcessPageSearch/ProcessPageSearch.module#L458
I stumbled on that the first time, so I thought I will write it down in case somebody also has this problem.

I ended up wih this final Hook now:

$this->addHookAfter('ProcessPageSearchLive::execute',$this,'processPageSearchLiveExecute'); // new PW >= 3.0.112 version

public function processPageSearchLiveExecute($event) {
    $getJSON = $event->arguments(0);
    if($getJSON === NULL) { // it looks like the standard true parameter for getJSON cannot be fetched in the hook. so we check on NULL.
        $getJSON = true;
        $result = json_decode($event->return,true);
    } else {
        $result = $event->return;
    }
    // manipulate
    $changed = false;
    if(count($result['matches'])){
        foreach($result['matches'] as $key => $match) {
            if($match['template_label'] == "XXX" || $match['template_label'] == "YYY") {
                // add vorname and nachname to title
                $matchPage = $this->pages->get($match['id']);
                $result['matches'][$key]['title'] = $match['title'] .' - '.$matchPage->get('nachname').' '.$matchPage->get('vorname');
                $changed = true;
            }
        }
    }
    if($changed) {
        $event->return = $getJSON ? json_encode($result) : $result['matches'];
    }
}