WP_Users_List_Table::single_row( WP_User $user_object, string $style = '', string $role = '', int $numposts = 0 ): string
- Since
- 3.1.0, 4.2.0, 4.4.0
- Source
wp-admin/includes/class-wp-users-list-table.php:433
Generates HTML for a single row on the users.php admin panel.
Compatibility
- WordPress
- since 4.4.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$user_objectWP_User- The current user object.
$stylestringoptional- Deprecated. Not used.Default:
'' $rolestringoptional- Deprecated. Not used.Default:
'' $numpostsintoptional- Post count to display for this user. Defaults to zero, as in, a new user has made zero posts.Default:
0
Return value
string- Output for a single row.
Performance profile
How much work a call to WP_Users_List_Table::single_row() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Scales with input
- Instructions
- 54–210
- Plugin surface
- 2 hooks
- Called by
- 1
Reaches the database via get_user_by().
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 438.
Third-party callbacks on 'user_row_actions', 'manage_users_custom_column' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly - querycontent query
get_user_by()one call below WP_Users_List_Table::single_row() - optionnetwork option
get_site_option()one call below WP_Users_List_Table::single_row()
Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 29 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Users_List_Table::single_row() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$user_object instanceof && !is_multisite() && !current_user_can() | 54–55 | ->get_role_list(), is_multisite(), current_user_can(), get_avatar(), ->get_column_info() |
$user_object instanceof | 133–134 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), get_author_posts_url(), get_current_user_id(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof && !is_multisite() | 138–139 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), get_current_user_id(), is_multisite(), get_author_posts_url(), get_current_user_id(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 140–141 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), get_author_posts_url(), get_current_user_id(), current_user_can(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 140–141 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), get_author_posts_url(), get_current_user_id(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 145–146 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), get_author_posts_url(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof && !is_multisite() | 145–146 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), get_current_user_id(), is_multisite(), get_author_posts_url(), get_current_user_id(), current_user_can(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 147–148 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), get_author_posts_url(), get_current_user_id(), current_user_can(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof && !is_multisite() | 150–151 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), get_current_user_id(), is_multisite(), get_author_posts_url(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 152–153 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), get_author_posts_url(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 156–157 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), wp_nonce_url(), __(), get_author_posts_url(), get_current_user_id(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 159–160 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
17 further outcomes, up to 210 instructions
$user_object instanceof | 160–161 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), get_author_posts_url(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), wp_nonce_url(), __(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 163–164 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), wp_nonce_url(), __(), get_author_posts_url(), get_current_user_id(), current_user_can(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof && !is_multisite() | 165–166 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), get_current_user_id(), is_multisite(), get_author_posts_url(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), wp_nonce_url(), __(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 166–167 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), current_user_can(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 166–167 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 167–168 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), get_author_posts_url(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), wp_nonce_url(), __(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 168–169 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), wp_nonce_url(), __(), get_author_posts_url(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 171–172 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 173–174 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), current_user_can(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 178–179 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 182–183 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), wp_nonce_url(), __(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 183–184 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), wp_nonce_url(), __(), get_author_posts_url(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), wp_nonce_url(), __(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 186–187 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), wp_nonce_url(), __(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 189–190 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), wp_nonce_url(), __(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), current_user_can(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 193–194 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), wp_nonce_url(), __(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 194–195 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), wp_nonce_url(), __(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
$user_object instanceof | 209–210 | ->get_role_list(), is_multisite(), current_user_can(), wp_unslash(), urlencode(), get_edit_user_link(), add_query_arg(), esc_url(), current_user_can(), is_multisite(), is_multisite(), current_user_can(), wp_nonce_url(), __(), get_author_posts_url(), esc_url(), __(), sprintf(), esc_attr(), __(), get_current_user_id(), current_user_can(), wp_is_password_reset_allowed_for_user(), wp_nonce_url(), __(), apply_filters(), array_keys(), esc_attr(), __(), sprintf(), sprintf(), get_avatar(), ->get_column_info() |
This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 438 | 54–210 | 34 | |
| 8.5 | 438 | 54–210 | 34 | |
| 8.4 | 438 | 54–210 | 34 | 12 fewer instructions than PHP 8.3 |
| 8.3 | 450 | 58–216 | 34 | |
| 8.2 | 450 | 58–216 | 34 | 3 fewer instructions than PHP 8.1 |
| 8.1 | 453 | 62–220 | 34 | |
| 7.4 | 453 | 62–220 | 34 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 2
2 hooks fire while WP_Users_List_Table::single_row() runs, in this order:
- apply_filters( user_row_actions )filterline 520 (+87 into the body)
Filters the action links displayed under each user in the Users list table.
- apply_filters( manage_users_custom_column )filterline 625 (+192 into the body)
Filters the display output of custom columns in the Users list table.
Uses · 24
- get_userdata()Retrieves user info by user ID.
- is_multisite()Determines whether Multisite is enabled.
- current_user_can()Returns whether the current user has the specified capability.
- get_super_admins()Retrieves a list of super admins.
- __()Retrieves the translation of $text.
- esc_url()Checks and cleans a URL.
- add_query_arg()Retrieves a modified URL query string.
- wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
- get_edit_user_link()Retrieves the edit user link.
- get_current_user_id()Gets the current user's ID.
- wp_nonce_url()Retrieves URL with nonce added to URL query.
- get_author_posts_url()Retrieves the URL to the author page for the user with the ID provided.
Show all 24
- esc_attr()Escaping for HTML attributes.
- wp_is_password_reset_allowed_for_user()Checks if password reset is allowed for a specific user.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- get_avatar()Retrieves the avatar `` tag for a user, email address, MD5 hash, comment, or post.
- wp_strip_all_tags()Properly strips all HTML tags including 'script' and 'style'.
- _x()Retrieves translated string with gettext context.
- esc_html()Escaping for HTML blocks.
- _n()Translates and retrieves the singular or plural form based on the supplied number.
- number_format_i18n()Converts float number to format based on the locale.
- WP_Users_List_Table::get_role_list()Returns an array of translated user role names for a given user object.
- WP_Users_List_Table::get_column_info()
- WP_Users_List_Table::row_actions()
Used by · 1
- WP_Users_List_Table::display_rows()Generates the list table rows.
Source code
public function single_row( $user_object, $style = '', $role = '', $numposts = 0 ) { if ( ! ( $user_object instanceof WP_User ) ) { $user_object = get_userdata( (int) $user_object ); } $user_object->filter = 'display'; $email = $user_object->user_email; if ( $this->is_site_users ) { $url = "site-users.php?id={$this->site_id}&"; } else { $url = 'users.php?'; } $user_roles = $this->get_role_list( $user_object ); // Set up the hover actions for this user. $actions = array(); $checkbox = ''; $super_admin = ''; if ( is_multisite() && current_user_can( 'manage_network_users' ) ) { if ( in_array( $user_object->user_login, get_super_admins(), true ) ) { $super_admin = ' — ' . __( 'Super Admin' ); } } // Check if the user for this row is editable. if ( current_user_can( 'list_users' ) ) { // Set up the user editing link. $edit_link = esc_url( add_query_arg( 'wp_http_referer', urlencode( wp_unslash( $_SERVER['REQUEST_URI'] ) ), get_edit_user_link( $user_object->ID ) ) ); if ( current_user_can( 'edit_user', $user_object->ID ) ) { $edit = "<strong><a href=\"{$edit_link}\">{$user_object->user_login}</a>{$super_admin}</strong><br />"; $actions['edit'] = '<a href="' . $edit_link . '">' . __( 'Edit' ) . '</a>'; } else { $edit = "<strong>{$user_object->user_login}{$super_admin}</strong><br />"; } if ( ! is_multisite() && get_current_user_id() !== $user_object->ID && current_user_can( 'delete_user', $user_object->ID ) ) { $actions['delete'] = "<a class='submitdelete' href='" . wp_nonce_url( "users.php?action=delete&user=$user_object->ID", 'bulk-users' ) . "'>" . __( 'Delete' ) . '</a>'; } if ( is_multisite() && current_user_can( 'remove_user', $user_object->ID ) ) { $actions['remove'] = "<a class='submitdelete' href='" . wp_nonce_url( $url . "action=remove&user=$user_object->ID", 'bulk-users' ) . "'>" . __( 'Remove' ) . '</a>'; } // Add a link to the user's author archive, if not empty. $author_posts_url = get_author_posts_url( $user_object->ID ); if ( $author_posts_url ) { $actions['view'] = sprintf( '<a href="%s" aria-label="%s">%s</a>', esc_url( $author_posts_url ), /* translators: %s: Author's display name. */ esc_attr( sprintf( __( 'View posts by %s' ), $user_object->display_name ) ), __( 'View' ) ); } // Add a link to send the user a reset password link by email. if ( get_current_user_id() !== $user_object->ID && current_user_can( 'edit_user', $user_object->ID ) && true === wp_is_password_reset_allowed_for_user( $user_object ) ) { $actions['resetpassword'] = "<a class='resetpassword' href='" . wp_nonce_url( "users.php?action=resetpassword&users=$user_object->ID", 'bulk-users' ) . "'>" . __( 'Send password reset' ) . '</a>'; } /** * Filters the action links displayed under each user in the Users list table. *Changelog
Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
4.4.0
The
$role parameter was deprecated.from the docblock4.2.0
The
$style parameter was deprecated.from the docblock3.1.0
Introduced.from the docblock
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-admin/includes/class-wp-users-list-table.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.