On this page
get_edit_user_link( int $user_id = null ): string
Retrieves the edit user link.
Parameters
$user_idint Optional-
User ID. Defaults to the current user.
Default:
null
Return
string URL to edit user page or empty string.
Source
File: wp-includes/link-template.php. View all references
function get_edit_user_link( $user_id = null ) {
if ( ! $user_id ) {
$user_id = get_current_user_id();
}
if ( empty( $user_id ) || ! current_user_can( 'edit_user', $user_id ) ) {
return '';
}
$user = get_userdata( $user_id );
if ( ! $user ) {
return '';
}
if ( get_current_user_id() == $user->ID ) {
$link = get_edit_profile_url( $user->ID );
} else {
$link = add_query_arg( 'user_id', $user->ID, self_admin_url( 'user-edit.php' ) );
}
/**
* Filters the user edit link.
*
* @since 3.5.0
*
* @param string $link The edit link.
* @param int $user_id User ID.
*/
return apply_filters( 'get_edit_user_link', $link, $user->ID );
}
Hooks
- apply_filters( 'get_edit_user_link',
string $link ,int $user_id ) -
Filters the user edit link.
Related
Uses
| Uses | Description |
|---|---|
| get_edit_profile_url() wp-includes/link-template.php | Retrieves the URL to the user’s profile editor. |
| self_admin_url() wp-includes/link-template.php | Retrieves the URL to the admin area for either the current site or the network depending on context. |
| current_user_can() wp-includes/capabilities.php | Returns whether the current user has the specified capability. |
| get_userdata() wp-includes/pluggable.php | Retrieves user info by user ID. |
| add_query_arg() wp-includes/functions.php | Retrieves a modified URL query string. |
| apply_filters() wp-includes/plugin.php | Calls the callback functions that have been added to a filter hook. |
| get_current_user_id() wp-includes/user.php | Gets the current user’s ID. |
Used By
| Used By | Description |
|---|---|
| WP_MS_Users_List_Table::handle_row_actions() wp-admin/includes/class-wp-ms-users-list-table.php | Generates and displays row action links. |
| WP_MS_Users_List_Table::column_username() wp-admin/includes/class-wp-ms-users-list-table.php | Handles the username column output. |
| WP_Users_List_Table::single_row() wp-admin/includes/class-wp-users-list-table.php | Generate HTML for a single row on the users.php admin panel. |
| attachment_submitbox_metadata() wp-admin/includes/media.php | Displays non-editable attachment metadata in the publish meta box. |
| wp_admin_bar_edit_menu() wp-includes/admin-bar.php | Provides an edit link for posts and terms. |
| wp_prepare_attachment_for_js() wp-includes/media.php | Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model. |
| comment_form() wp-includes/comment-template.php | Outputs a complete commenting form for use within a template. |
Changelog
| Version | Description |
|---|---|
| 3.5.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_edit_user_link