WP_Comments_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_Comments_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_comments().

Scaling

Constant

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

Instructions

111–164

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

Plugin surface

1 hook

Third-party callbacks on 'comments_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
• querycontent queryget_comments()called directly

Further down the call graph this can also reach serialize, cache, option 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_Comments_List_Table::prepare_items() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

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

1. 1
   apply_filters( comments_list_table_query_args )filterline 168 (+82 into the body)

   Filters the arguments for the comment query in the comments list table.

Uses · 11

• set_user_setting()Adds or updates user interface setting.
• get_user_setting()Retrieves user interface setting value based on setting name.
• sanitize_key()Sanitizes a string key.
• wp_doing_ajax()Determines whether the current request is a WordPress Ajax request.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_comments()Retrieves a list of comments.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• get_pending_comments_num()Gets the number of pending comments on a post or posts.
• WP_Comments_List_Table::get_per_page()
• WP_Comments_List_Table::get_pagenum()
• WP_Comments_List_Table::set_pagination_args()

Source code

View on Trac ↗View on GitHub ↗

86	public function prepare_items() {87		global $mode, $post_id, $comment_status, $comment_type, $search;88 89		if ( ! empty( $_REQUEST['mode'] ) ) {90			$mode = 'excerpt' === $_REQUEST['mode'] ? 'excerpt' : 'list';91			set_user_setting( 'posts_list_mode', $mode );92		} else {93			$mode = get_user_setting( 'posts_list_mode', 'list' );94		}95 96		$comment_status = isset( $_REQUEST['comment_status'] ) ? $_REQUEST['comment_status'] : 'all';97 98		if ( ! in_array( $comment_status, array( 'all', 'mine', 'moderated', 'approved', 'spam', 'trash' ), true ) ) {99			$comment_status = 'all';100		}101 102		$comment_type = '';103 104		if ( ! empty( $_REQUEST['comment_type'] ) && 'note' !== $_REQUEST['comment_type'] ) {105			$comment_type = $_REQUEST['comment_type'];106		}107 108		$search = ( isset( $_REQUEST['s'] ) ) ? $_REQUEST['s'] : '';109 110		$post_type = ( isset( $_REQUEST['post_type'] ) ) ? sanitize_key( $_REQUEST['post_type'] ) : '';111 112		$user_id = ( isset( $_REQUEST['user_id'] ) ) ? $_REQUEST['user_id'] : '';113 114		$orderby = ( isset( $_REQUEST['orderby'] ) ) ? $_REQUEST['orderby'] : '';115		$order   = ( isset( $_REQUEST['order'] ) ) ? $_REQUEST['order'] : '';116 117		$comments_per_page = $this->get_per_page( $comment_status );118 119		$doing_ajax = wp_doing_ajax();120 121		if ( isset( $_REQUEST['number'] ) ) {122			$number = (int) $_REQUEST['number'];123		} else {124			$number = $comments_per_page + min( 8, $comments_per_page ); // Grab a few extra.125		}126 127		$page = $this->get_pagenum();128 129		if ( isset( $_REQUEST['start'] ) ) {130			$start = $_REQUEST['start'];131		} else {132			$start = ( $page - 1 ) * $comments_per_page;133		}134 135		if ( $doing_ajax && isset( $_REQUEST['offset'] ) ) {136			$start += $_REQUEST['offset'];137		}138 139		$status_map = array(140			'mine'      => '',141			'moderated' => 'hold',142			'approved'  => 'approve',143			'all'       => '',144		);145 146		$args = array(147			'status'                    => isset( $status_map[ $comment_status ] ) ? $status_map[ $comment_status ] : $comment_status,148			'search'                    => $search,149			'user_id'                   => $user_id,150			'offset'                    => $start,151			'number'                    => $number,152			'post_id'                   => $post_id,153			'type'                      => $comment_type,154			'type__not_in'              => array( 'note' ),155			'orderby'                   => $orderby,156			'order'                     => $order,157			'post_type'                 => $post_type,158			'update_comment_post_cache' => true,159		);160 161		/**162		 * Filters the arguments for the comment query in the comments list table.163		 *164		 * @since 5.1.0165		 *

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.