WP_Users_List_Table::extra_tablenav( string $which )
- Since
- 3.1.0
- Source
wp-admin/includes/class-wp-users-list-table.php:300
Compatibility
- WordPress
- since 3.1.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
$whichstring- Whether this is being invoked above ("top") or below the table ("bottom").
Performance profile
How much work a call to WP_Users_List_Table::extra_tablenav() 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
- Trivial
- Scaling
- Constant
- Instructions
- 24–60
- Plugin surface
- 2 hooks
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 62.
Third-party callbacks on 'restrict_manage_users', 'manage_users_extra_tablenav' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()called directly
Further down the call graph this can also reach query, option, 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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Users_List_Table::extra_tablenav() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!current_user_can() | 24–26 | current_user_can(), do_action(), do_action() |
current_user_can() && !->has_items() | 27–29 | current_user_can(), ->has_items(), do_action(), do_action() |
current_user_can() && ->has_items() | 58–60 | current_user_can(), ->has_items(), _e(), _e(), wp_dropdown_roles(), _e(), __(), submit_button(), do_action(), do_action() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 62 instructions, 24–60 executed per call, 4 branches. The work does not change between versions.
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::extra_tablenav() runs, in this order:
- do_action( restrict_manage_users )actionline 330 (+30 into the body)
Fires just before the closing div containing the bulk role-change controls in the Users list table.
- do_action( manage_users_extra_tablenav )actionline 342 (+42 into the body)
Fires immediately following the closing "actions" div in the tablenav for the users list table.
Uses · 7
- current_user_can()Returns whether the current user has the specified capability.
- _e()Displays translated text.
- wp_dropdown_roles()Prints out option HTML elements for role selectors.
- submit_button()Echoes a submit button, with provided text and appropriate class(es).
- __()Retrieves the translation of $text.
- do_action()Calls the callback functions that have been added to an action hook.
- WP_Users_List_Table::has_items()
Source code
protected function extra_tablenav( $which ) { $id = 'bottom' === $which ? 'new_role2' : 'new_role'; $button_id = 'bottom' === $which ? 'changeit2' : 'changeit'; ?> <div class="alignleft actions"> <?php if ( current_user_can( 'promote_users' ) && $this->has_items() ) : ?> <label class="screen-reader-text" for="<?php echo $id; ?>"> <?php /* translators: Hidden accessibility text. */ _e( 'Change role to…' ); ?> </label> <select name="<?php echo $id; ?>" id="<?php echo $id; ?>"> <option value=""><?php _e( 'Change role to…' ); ?></option> <?php wp_dropdown_roles(); ?> <option value="none"><?php _e( '— No role for this site —' ); ?></option> </select> <?php submit_button( __( 'Change' ), '', $button_id, false ); endif; /** * Fires just before the closing div containing the bulk role-change controls * in the Users list table. * * @since 3.5.0 * @since 4.6.0 The `$which` parameter was added. * * @param string $which The location of the extra table nav markup: 'top' or 'bottom'. */ do_action( 'restrict_manage_users', $which ); ?> </div> <?php /** * Fires immediately following the closing "actions" div in the tablenav for the users * list table. * * @since 4.9.0 * * @param string $which The location of the extra table nav markup: 'top' or 'bottom'. */ do_action( 'manage_users_extra_tablenav', $which ); }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.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 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.