get_search_form() function calls an action and a filter with the same hook.

[marquex]

The get_search_form() functions starts calling the action 'get_search_form', and its ends applying the filter 'get_search_form' if a searchform.php file doesn't exists.

So if a function is hooked in 'get_search_form' action, it is also called by the filter, as long as do_action and apply_filters grab the functions from the same array.

If I add an action in 'get_search_form' I would like to be called just once. Maybe the best thing to do here is to change the action hook name.

Cheers

[nacin]

Was introduced like this.

[WraithKenny]

you could add a did_action check if you'd like it to fire only once.

[SergeyBiryukov]

The get_search_form() functions starts calling the action 'get_search_form', and its ends applying the filter 'get_search_form' if a searchform.php file doesn't exists.

With the changes in #16541, the filter is now applied if searchform.php exists as well.

If a function is hooked to get_search_form as an action (e.g. to print something), it runs twice, so the output is printed twice. If it's hooked as a filter, it still runs twice, but at least properly returns the value.

I guess we should rename the action. I'd suggest get_search_form_before.

[DrewAPicture]

Replying to SergeyBiryukov:

I guess we should rename the action. I'd suggest get_search_form_before.

I don't like 'before' because it implies there's a matching "after" filter, a la the theme hooks debate. What about something like 'pre_get_search_form' instead?

[SergeyBiryukov]

Replying to DrewAPicture:

What about something like 'pre_get_search_form' instead?

Works for me. That was my initial idea as well, but it seemed that pre_* is often used in core for filters, so I thought it might be confusing as an action name.

[SergeyBiryukov]

Replying to SergeyBiryukov:

If a function is hooked to get_search_form as an action (e.g. to print something), it runs twice, so the output is printed twice.

It also kills the search form if it doesn't return anything.

[DrewAPicture]

'pre_get_search_form'

[SergeyBiryukov]

Replying to SergeyBiryukov:

It also kills the search form if it doesn't return anything.

19321.3.patch​ fixes that and keeps back compat for both current use cases.

[SergeyBiryukov]

Refreshed after [23798]

[SergeyBiryukov]

In 23800:

Rename 'get_search_form' action to 'pre_get_search_form' to prevent collision with the filter of the same name. Make sure the filtered result is not null to prevent search form from disappearing if an action function is attached to the old hook. fixes #19321.