WP_MS_Users_List_Table::prepare_items()

Compatibility

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

Performance profile

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

Reaches the database via ->get_results().

Scaling

Constant

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

Instructions

73–134

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

Plugin surface

1 hook

Third-party callbacks on 'users_list_table_query_args' 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 callbacksapply_filters()called directly
• sqldatabase query->get_results()called directly
• optionnetwork optionget_site_option()one call below WP_MS_Users_List_Table::prepare_items()

Further down the call graph this can also reach 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 · 32 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while WP_MS_Users_List_Table::prepare_items() runs, in this order:

1. 1
   apply_filters( users_list_table_query_args )filterline 93 (+63 into the body)

   Filters the query arguments used to retrieve users for the current users list table.

Uses · 10

• set_user_setting()Adds or updates user interface setting.
• get_user_setting()Retrieves user interface setting value based on setting name.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• wp_is_large_network()Determines whether or not we have a large network.
• get_super_admins()Retrieves a list of super admins.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_MS_Users_List_Table::get_items_per_page()
• WP_MS_Users_List_Table::get_pagenum()
• WP_User_Query::__construct()Constructor.
• WP_MS_Users_List_Table::set_pagination_args()

Source code

View on Trac ↗View on GitHub ↗

30	public function prepare_items() {31		global $mode, $usersearch, $role;32 33		if ( ! empty( $_REQUEST['mode'] ) ) {34			$mode = 'excerpt' === $_REQUEST['mode'] ? 'excerpt' : 'list';35			set_user_setting( 'network_users_list_mode', $mode );36		} else {37			$mode = get_user_setting( 'network_users_list_mode', 'list' );38		}39 40		$usersearch = isset( $_REQUEST['s'] ) ? wp_unslash( trim( $_REQUEST['s'] ) ) : '';41 42		$users_per_page = $this->get_items_per_page( 'users_network_per_page' );43 44		$role = isset( $_REQUEST['role'] ) ? $_REQUEST['role'] : '';45 46		$paged = $this->get_pagenum();47 48		$args = array(49			'number'  => $users_per_page,50			'offset'  => ( $paged - 1 ) * $users_per_page,51			'search'  => $usersearch,52			'blog_id' => 0,53			'fields'  => 'all_with_meta',54		);55 56		if ( wp_is_large_network( 'users' ) ) {57			$args['search'] = ltrim( $args['search'], '*' );58		} elseif ( '' !== $args['search'] ) {59			$args['search'] = trim( $args['search'], '*' );60			$args['search'] = '*' . $args['search'] . '*';61		}62 63		if ( 'super' === $role ) {64			$args['login__in'] = get_super_admins();65		}66 67		/*68		 * If the network is large and a search is not being performed,69		 * show only the latest users with no paging in order to avoid70		 * expensive count queries.71		 */72		if ( ! $usersearch && wp_is_large_network( 'users' ) ) {73			if ( ! isset( $_REQUEST['orderby'] ) ) {74				$_GET['orderby']     = 'id';75				$_REQUEST['orderby'] = 'id';76			}77			if ( ! isset( $_REQUEST['order'] ) ) {78				$_GET['order']     = 'DESC';79				$_REQUEST['order'] = 'DESC';80			}81			$args['count_total'] = false;82		}83 84		if ( isset( $_REQUEST['orderby'] ) ) {85			$args['orderby'] = $_REQUEST['orderby'];86		}87 88		if ( isset( $_REQUEST['order'] ) ) {89			$args['order'] = $_REQUEST['order'];90		}91 92		/** This filter is documented in wp-admin/includes/class-wp-users-list-table.php */93		$args = apply_filters( 'users_list_table_query_args', $args );94 95		// Query the user IDs for this page.96		$wp_user_search = new WP_User_Query( $args );97 98		$this->items = $wp_user_search->get_results();99 100		$this->set_pagination_args(101			array(102				'total_items' => $wp_user_search->get_total(),103				'per_page'    => $users_per_page,104			)105		);106	}

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-ms-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.