feature: Add filter to short-circuit get_edit_user_link

[Debarghya-Banerjee]

Trac Ticket: Core-53405

Description

• This pull request introduces a mechanism for short-circuiting the get_edit_user_link function in order to improve performance, especially in multisite environments. The implementation allows for early exits from the function when certain conditions are met, minimizing unnecessary processing and memory usage.

Changes Made

• Added a filter pre_get_edit_user_link to allow early return of a custom edit link.

• Refactored the function to check the filter result at the beginning, enabling short-circuit behavior before any resource-intensive operations are performed.

• Updated the function documentation to include the new filter, providing clarity on its usage and purpose.

Benefits

• Performance Improvement

  • Reduces overhead in scenarios where the edit user link can be determined early, preventing heavy operations in multisite setups.

• Enhanced Flexibility

  • Allows developers to customize the edit user link easily via the new filter without modifying core logic.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props debarghyabanerjee.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[github-actions]

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

• The Plugin and Theme Directories cannot be accessed within Playground.
• All changes will be lost when closing a tab with a Playground instance.
• All changes will be lost when refreshing the page.
• A fresh instance is created each time the link below is clicked.
• Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
  it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

[apermo]

Suggested change

	* Returning a non-empty string from this filter will effectively short-circuit
	* the function, returning the passed value instead of continuing with the
	* standard link generation process.
	*
	* @since 6.8.0
	*
	* @param string|null $link The edit link. Default is an empty string.
	* @param int $user_id User ID.
	*/
	$link = apply_filters( 'pre_get_edit_user_link', '', $user_id );
	if ( ! empty( $link ) ) {
	return $link;
	}
	* Returning a string from this filter will effectively short-circuit the function,
	* returning the passed value instead of continuing with the standard link
	* generation process.
	*
	* @since 6.8.0
	*
	* @param string|null $link The edit link. Default is an empty string.
	* @param int $user_id User ID.
	*/
	$link = apply_filters( 'pre_get_edit_user_link', null, $user_id );
	if ( null !== $link ) {
	return $link;
	}

Imho this would be a little more strict and it would also allow to return an empty link, if anyone fancies doing so. Besides that I like the solution

[mukeshpanchal27]

Move filter after the permission and user checks, otherwise the $user_id may get null value.

[apermo]

Good catch, that's an absolutely valid point.