WP_List_Table::bulk_actions( 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

$whichstringoptional

The location of the bulk actions: Either 'top' or 'bottom'.
This is designated as optional for backward compatibility.Default: ''

Performance profile

How much work a call to WP_List_Table::bulk_actions() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

8–67

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

Plugin surface

1 hook

Third-party callbacks on 'bulk_actions-{$this->screen->id}' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize, query 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 · 4 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while WP_List_Table::bulk_actions() runs, in this order:

1. 1
   apply_filters( bulk_actions-{$this->screen->id} )filterline 586 (+15 into the body)

   Filters the items in the bulk actions menu of the list table.

Uses · 5

• apply_filters()Calls the callback functions that have been added to a filter hook.
• esc_attr()Escaping for HTML attributes.
• __()Retrieves the translation of $text.
• submit_button()Echoes a submit button, with provided text and appropriate class(es).
• WP_List_Table::get_bulk_actions()Retrieves the list of bulk actions available for this table.

Used by · 2

• WP_List_Table::display_tablenav()Generates the table navigation above or below the table
• WP_Plugins_List_Table::bulk_actions()

Source code

View on Trac ↗View on GitHub ↗

571	protected function bulk_actions( $which = '' ) {572		if ( is_null( $this->_actions ) ) {573			$this->_actions = $this->get_bulk_actions();574 575			/**576			 * Filters the items in the bulk actions menu of the list table.577			 *578			 * The dynamic portion of the hook name, `$this->screen->id`, refers579			 * to the ID of the current screen.580			 *581			 * @since 3.1.0582			 * @since 5.6.0 A bulk action can now contain an array of options in order to create an optgroup.583			 *584			 * @param array $actions An array of the available bulk actions.585			 */586			$this->_actions = apply_filters( "bulk_actions-{$this->screen->id}", $this->_actions ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores587 588			$two = '';589		} else {590			$two = '2';591		}592 593		if ( empty( $this->_actions ) ) {594			return;595		}596 597		echo '<label for="bulk-action-selector-' . esc_attr( $which ) . '" class="screen-reader-text">' .598			/* translators: Hidden accessibility text. */599			__( 'Select bulk action' ) .600		'</label>';601		echo '<select name="action' . $two . '" id="bulk-action-selector-' . esc_attr( $which ) . "\">\n";602		echo '<option value="-1">' . __( 'Bulk actions' ) . "</option>\n";603 604		foreach ( $this->_actions as $key => $value ) {605			if ( is_array( $value ) ) {606				echo "\t" . '<optgroup label="' . esc_attr( $key ) . '">' . "\n";607 608				foreach ( $value as $name => $title ) {609					$class = ( 'edit' === $name ) ? ' class="hide-if-no-js"' : '';610 611					echo "\t\t" . '<option value="' . esc_attr( $name ) . '"' . $class . '>' . $title . "</option>\n";612				}613				echo "\t" . "</optgroup>\n";614			} else {615				$class = ( 'edit' === $key ) ? ' class="hide-if-no-js"' : '';616 617				echo "\t" . '<option value="' . esc_attr( $key ) . '"' . $class . '>' . $value . "</option>\n";618			}619		}620 621		echo "</select>\n";622 623		submit_button( __( 'Apply' ), 'action button-compact', 'bulk_action', false, array( 'id' => "doaction$two" ) );624		echo "\n";625	}

Changelog

Introduced in 3.1.0. 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 7.0.4 tag, from src/wp-admin/includes/class-wp-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.