set_screen_options()

Hooks fired · 2

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

1. 1
   apply_filters( set-screen-option )filterline 773 (+79 into the body)

   Filters a screen option value before it is set.

2. 2
   apply_filters( set_screen_option_{$option} )filterline 792 (+98 into the body)

   Filters a screen option value before it is set.

Uses · 12

• check_admin_referer()Ensures intent by verifying that a user was referred from another admin page with the correct security nonce.
• wp_get_current_user()Retrieves the current user object.
• sanitize_key()Sanitizes a string key.
• get_taxonomies()Retrieves a list of registered taxonomy names or objects.
• get_post_types()Gets a list of all registered post type objects.
• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• update_user_meta()Updates user meta field based on user ID.
• remove_query_arg()Removes an item or items from a query string.
• wp_get_referer()Retrieves referer from '_wp_http_referer' or HTTP referer.
• add_query_arg()Retrieves a modified URL query string.
• wp_safe_redirect()Performs a safe (local) redirect, using wp_redirect().

Source

View on Trac ↗View on GitHub ↗

694function set_screen_options() {695	if ( ! isset( $_POST['wp_screen_options'] ) || ! is_array( $_POST['wp_screen_options'] ) ) {696		return;697	}698 699	check_admin_referer( 'screen-options-nonce', 'screenoptionnonce' );700 701	$user = wp_get_current_user();702 703	if ( ! $user ) {704		return;705	}706 707	$option = $_POST['wp_screen_options']['option'];708	$value  = $_POST['wp_screen_options']['value'];709 710	if ( sanitize_key( $option ) !== $option ) {711		return;712	}713 714	$map_option = $option;715	$type       = str_replace( 'edit_', '', $map_option );716	$type       = str_replace( '_per_page', '', $type );717 718	if ( in_array( $type, get_taxonomies(), true ) ) {719		$map_option = 'edit_tags_per_page';720	} elseif ( in_array( $type, get_post_types(), true ) ) {721		$map_option = 'edit_per_page';722	} else {723		$option = str_replace( '-', '_', $option );724	}725 726	switch ( $map_option ) {727		case 'edit_per_page':728		case 'users_per_page':729		case 'edit_comments_per_page':730		case 'upload_per_page':731		case 'edit_tags_per_page':732		case 'plugins_per_page':733		case 'export_personal_data_requests_per_page':734		case 'remove_personal_data_requests_per_page':735			// Network admin.736		case 'sites_network_per_page':737		case 'users_network_per_page':738		case 'site_users_network_per_page':739		case 'plugins_network_per_page':740		case 'themes_network_per_page':741		case 'site_themes_network_per_page':742			$value = (int) $value;743 744			if ( $value < 1 || $value > 999 ) {745				return;746			}747 748			break;749 750		default:751			$screen_option = false;752 753			if ( str_ends_with( $option, '_page' ) || 'layout_columns' === $option ) {754				/**755				 * Filters a screen option value before it is set.756				 *757				 * The filter can also be used to modify non-standard `[items]_per_page`758				 * settings. See the parent function for a full list of standard options.759				 *760				 * Returning false from the filter will skip saving the current option.761				 *762				 * @since 2.8.0763				 * @since 5.4.2 Only applied to options ending with '_page',764				 *              or the 'layout_columns' option.765				 *766				 * @see set_screen_options()767				 *768				 * @param mixed  $screen_option The value to save instead of the option value.769				 *                              Default false (to skip saving the current option).770				 * @param string $option        The option name.771				 * @param int    $value         The option value.772				 */773				$screen_option = apply_filters( 'set-screen-option', $screen_option, $option, $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores

History

Introduced in 2.8.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 6.8.8 tag, from src/wp-admin/includes/misc.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.