wp_edit_posts_query( array|false $q = false ): string[]

Parameters

$qarray|falseoptional

Array of query variables to use to build the query. Defaults to the $_GET superglobal.Default: false

Return

string[]

An array of all the statuses for the queried post type.

Hooks fired · 2

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

1. 1
   apply_filters( edit_{$post_type}_per_page )filterline 1292 (+63 into the body)

   Filters the number of items per page to show for a specific 'per_page' type.

2. 2
   apply_filters( edit_posts_per_page )filterline 1302 (+73 into the body)

   Filters the number of posts displayed per page when specifically listing "posts".

Uses · 8

• get_post_stati()Gets a list of post statuses.
• get_post_types()Gets a list of all registered post type objects.
• get_available_post_statuses()Returns all the possible statuses for a post type.
• get_user_option()Retrieves user option that can be either per Site or per Network.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_post_type_hierarchical()Determines whether the post type is hierarchical.
• get_option()Retrieves an option value based on an option name.
• wp()Sets up the WordPress query.

Used by · 1

• WP_Posts_List_Table::prepare_items()

Source

View on Trac ↗View on GitHub ↗

1229function wp_edit_posts_query( $q = false ) {1230	if ( false === $q ) {1231		$q = $_GET;1232	}1233 1234	$q['m']   = isset( $q['m'] ) ? (int) $q['m'] : 0;1235	$q['cat'] = isset( $q['cat'] ) ? (int) $q['cat'] : 0;1236 1237	$post_statuses = get_post_stati();1238 1239	if ( isset( $q['post_type'] ) && in_array( $q['post_type'], get_post_types(), true ) ) {1240		$post_type = $q['post_type'];1241	} else {1242		$post_type = 'post';1243	}1244 1245	$avail_post_stati = get_available_post_statuses( $post_type );1246	$post_status      = '';1247	$perm             = '';1248 1249	if ( isset( $q['post_status'] ) && in_array( $q['post_status'], $post_statuses, true ) ) {1250		$post_status = $q['post_status'];1251		$perm        = 'readable';1252	}1253 1254	$orderby = '';1255 1256	if ( isset( $q['orderby'] ) ) {1257		$orderby = $q['orderby'];1258	} elseif ( isset( $q['post_status'] ) && in_array( $q['post_status'], array( 'pending', 'draft' ), true ) ) {1259		$orderby = 'modified';1260	}1261 1262	$order = '';1263 1264	if ( isset( $q['order'] ) ) {1265		$order = $q['order'];1266	} elseif ( isset( $q['post_status'] ) && 'pending' === $q['post_status'] ) {1267		$order = 'ASC';1268	}1269 1270	$per_page       = "edit_{$post_type}_per_page";1271	$posts_per_page = (int) get_user_option( $per_page );1272	if ( empty( $posts_per_page ) || $posts_per_page < 1 ) {1273		$posts_per_page = 20;1274	}1275 1276	/**1277	 * Filters the number of items per page to show for a specific 'per_page' type.1278	 *1279	 * The dynamic portion of the hook name, `$post_type`, refers to the post type.1280	 *1281	 * Possible hook names include:1282	 *1283	 *  - `edit_post_per_page`1284	 *  - `edit_page_per_page`1285	 *  - `edit_attachment_per_page`1286	 *1287	 * @since 3.0.01288	 *1289	 * @param int $posts_per_page Number of posts to display per page for the given post1290	 *                            type. Default 20.1291	 */1292	$posts_per_page = apply_filters( "edit_{$post_type}_per_page", $posts_per_page );1293 1294	/**1295	 * Filters the number of posts displayed per page when specifically listing "posts".1296	 *1297	 * @since 2.8.01298	 *1299	 * @param int    $posts_per_page Number of posts to be displayed. Default 20.1300	 * @param string $post_type      The post type.1301	 */1302	$posts_per_page = apply_filters( 'edit_posts_per_page', $posts_per_page, $post_type );1303 1304	$query = compact( 'post_type', 'post_status', 'perm', 'order', 'orderby', 'posts_per_page' );1305 1306	// Hierarchical types require special args.1307	if ( is_post_type_hierarchical( $post_type ) && empty( $orderby ) ) {1308		$query['orderby']                = 'menu_order title';

History

Introduced in 2.5.0. One change between 6.7.7 and 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/post.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.