WP_List_Table::months_dropdown( string $post_type )

Compatibility

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

Parameters

$post_typestring

The post type.

Performance profile

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

Scales with input

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

Instructions

10–95

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

Plugin surface

3 hooks

Third-party callbacks on 'disable_months_dropdown', 'pre_months_dropdown_query', 'months_dropdown_results' 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

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 · 7 distinct outcomes

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

Hooks and filters fired · 3

3 hooks fire while WP_List_Table::months_dropdown() runs, in this order:

1. 1
   apply_filters( disable_months_dropdown )filterline 723 (+11 into the body)

   Filters whether to remove the 'Months' drop-down from the post list table.

2. 2
   apply_filters( pre_months_dropdown_query )filterline 735 (+23 into the body)

   Filters whether to short-circuit performing the months dropdown query.

3. 3
   apply_filters( months_dropdown_results )filterline 765 (+53 into the body)

   Filters the 'Months' drop-down results.

Uses · 8

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_post_type_object()Retrieves a post type object by name.
• selected()Outputs the HTML selected attribute.
• _e()Displays translated text.
• zeroise()Add leading zeros when necessary.
• esc_attr()Escaping for HTML attributes.
• esc_html()Escaping for HTML blocks.
• __()Retrieves the translation of $text.

Source code

View on Trac ↗View on GitHub ↗

712	protected function months_dropdown( $post_type ) {713		global $wpdb, $wp_locale;714 715		/**716		 * Filters whether to remove the 'Months' drop-down from the post list table.717		 *718		 * @since 4.2.0719		 *720		 * @param bool   $disable   Whether to disable the drop-down. Default false.721		 * @param string $post_type The post type.722		 */723		if ( apply_filters( 'disable_months_dropdown', false, $post_type ) ) {724			return;725		}726 727		/**728		 * Filters whether to short-circuit performing the months dropdown query.729		 *730		 * @since 5.7.0731		 *732		 * @param object[]|false $months   'Months' drop-down results. Default false.733		 * @param string         $post_type The post type.734		 */735		$months = apply_filters( 'pre_months_dropdown_query', false, $post_type );736 737		if ( ! is_array( $months ) ) {738			$extra_checks = "AND post_status != 'auto-draft'";739			if ( ! isset( $_GET['post_status'] ) || 'trash' !== $_GET['post_status'] ) {740				$extra_checks .= " AND post_status != 'trash'";741			} elseif ( isset( $_GET['post_status'] ) ) {742				$extra_checks = $wpdb->prepare( ' AND post_status = %s', $_GET['post_status'] );743			}744 745			$months = $wpdb->get_results(746				$wpdb->prepare(747					"SELECT DISTINCT YEAR( post_date ) AS year, MONTH( post_date ) AS month748					FROM $wpdb->posts749					WHERE post_type = %s750					$extra_checks751					ORDER BY post_date DESC",752					$post_type753				)754			);755		}756 757		/**758		 * Filters the 'Months' drop-down results.759		 *760		 * @since 3.7.0761		 *762		 * @param object[] $months    Array of the months drop-down query results.763		 * @param string   $post_type The post type.764		 */765		$months = apply_filters( 'months_dropdown_results', $months, $post_type );766 767		$month_count = count( $months );768 769		if ( ! $month_count || ( 1 === $month_count && 0 === (int) $months[0]->month ) ) {770			return;771		}772 773		$selected_month = isset( $_GET['m'] ) ? (int) $_GET['m'] : 0;774		?>775		<label for="filter-by-date" class="screen-reader-text"><?php echo get_post_type_object( $post_type )->labels->filter_by_date; ?></label>776		<select name="m" id="filter-by-date">777			<option<?php selected( $selected_month, 0 ); ?> value="0"><?php _e( 'All dates' ); ?></option>778		<?php779		foreach ( $months as $arc_row ) {780			if ( 0 === (int) $arc_row->year ) {781				continue;782			}783 784			$month = zeroise( $arc_row->month, 2 );785			$year  = $arc_row->year;786 787			printf(788				"<option %s value='%s'>%s</option>\n",789				selected( $selected_month, $year . $month, false ),790				esc_attr( $year . $month ),791				/* translators: 1: Month name, 2: 4-digit year. */

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