WP_Comments_List_Table::extra_tablenav( string $which )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$whichstring

Performance profile

How much work a call to WP_Comments_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

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

19–73

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 77.

Plugin surface

2 hooks

Third-party callbacks on 'restrict_manage_comments', 'manage_comments_nav' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_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 · 24 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Comments_List_Table::extra_tablenav() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while WP_Comments_List_Table::extra_tablenav() runs, in this order:

1. 1
   do_action( restrict_manage_comments )actionline 424 (+20 into the body)

   Fires just before the Filter submit button for comment types.

2. 2
   do_action( manage_comments_nav )actionline 451 (+47 into the body)

   Fires after the Filter submit button for comment types.

Uses · 8

• do_action()Calls the callback functions that have been added to an action hook.
• submit_button()Echoes a submit button, with provided text and appropriate class(es).
• __()Retrieves the translation of $text.
• current_user_can()Returns whether the current user has the specified capability.
• wp_nonce_field()Retrieves or display nonce hidden field for forms.
• esc_attr__()Retrieves the translation of $text and escapes it for safe use in an attribute.
• WP_Comments_List_Table::has_items()
• WP_Comments_List_Table::comment_type_dropdown()Displays a comment type drop-down for filtering on the Comments list table.

Source code

View on Trac ↗View on GitHub ↗

404	protected function extra_tablenav( $which ) {405		global $comment_status, $comment_type;406		static $has_items;407 408		if ( ! isset( $has_items ) ) {409			$has_items = $this->has_items();410		}411 412		echo '<div class="alignleft actions">';413 414		if ( 'top' === $which ) {415			ob_start();416 417			$this->comment_type_dropdown( $comment_type );418 419			/**420			 * Fires just before the Filter submit button for comment types.421			 *422			 * @since 3.5.0423			 */424			do_action( 'restrict_manage_comments' );425 426			$output = ob_get_clean();427 428			if ( ! empty( $output ) && $this->has_items() ) {429				echo $output;430				submit_button( __( 'Filter' ), '', 'filter_action', false, array( 'id' => 'post-query-submit' ) );431			}432		}433 434		if ( ( 'spam' === $comment_status || 'trash' === $comment_status ) && $has_items435			&& current_user_can( 'moderate_comments' )436		) {437			wp_nonce_field( 'bulk-destroy', '_destroy_nonce' );438			$title = ( 'spam' === $comment_status ) ? esc_attr__( 'Empty Spam' ) : esc_attr__( 'Empty Trash' );439			submit_button( $title, 'apply', 'delete_all', false );440		}441 442		/**443		 * Fires after the Filter submit button for comment types.444		 *445		 * @since 2.5.0446		 * @since 5.6.0 The `$which` parameter was added.447		 *448		 * @param string $comment_status The comment status name. Default 'All'.449		 * @param string $which          The location of the extra table nav markup: Either 'top' or 'bottom'.450		 */451		do_action( 'manage_comments_nav', $comment_status, $which );452 453		echo '</div>';454	}

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-admin/includes/class-wp-comments-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.