Filter hook 'set-screen-option'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into set-screen-option
add_filter('set-screen-option', 'my_custom_filter', 10, 3);

function my_custom_filter($screen_option, $option, $value) {
    // Your custom filtering logic here
    return $screen_option;
}

Source Code Context

<?php
 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
 774  			}
 775  
 776  			/**
 777  			 * Filters a screen option value before it is set.
 778  			 *

PHP Documentation

<?php
/**
				 * Filters a screen option value before it is set.
				 *
				 * The filter can also be used to modify non-standard `[items]_per_page`
				 * settings. See the parent function for a full list of standard options.
				 *
				 * Returning false from the filter will skip saving the current option.
				 *
				 * @since 2.8.0
				 * @since 5.4.2 Only applied to options ending with '_page',
				 *              or the 'layout_columns' option.
				 *
				 * @see set_screen_options()
				 *
				 * @param mixed  $screen_option The value to save instead of the option value.
				 *                              Default false (to skip saving the current option).
				 * @param string $option        The option name.
				 * @param int    $value         The option value.
				 */