apply_filters( ‘set-screen-option’, mixed $screen_option, string $option, int $value )

User Contributed Notes

1. Skip to note 3 content

   Lance Cleveland 7 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   This cannot be called too late in the WordPress action stack or it will not fire at the right time. You cannot put it inside a function running during the ‘admin_menu’ hook, for example. For the Store Locator Plus plugin (you can find up-to-date working code buried in there) I find adding the filter inside the WordPress ‘init’ methods works best as this is called early in the WordPress action stack.

   The “sister” add_screen_option() call, however, tends to work better later in the call stack such as within the ‘admin_menu’ hook.

   The general premise: save the options goes before (WP ‘init’ hook) setting up the options (WP ‘admin_menu’ hook).

   • As @Store Locator Plus said, call it on ‘init’ hook I have been figthing for hours with my per_page config not getting saved just because I had it on the ‘admin_init’ hook, that’s not enough

     gon123 2 years ago
2. Skip to note 4 content

   vee 6 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   To make it really work and easy to understand.

   This code will NOT work.

   add_filter('set-screen-option', 'myFilterScreenOption', 10, 3);
   function myFilterScreenOption($keep, $option, $value) {
       if ($option === 'myitem_per_page') {
           if ($value < 0) {
               $value = 0;
           } elseif ($value > 100) {
               $value = 100;
           }
       }
       return $value;
   }

   If you enter 200 as item per page, it will still be 200 not 100 because you call to this filter too early.

   This code will work.

   add_filter('set-screen-option', 'myFilterScreenOption', 11, 3);
   function myFilterScreenOption($keep, $option, $value) {
       if ($option === 'myitem_per_page') {
           if ($value < 0) {
               $value = 0;
           } elseif ($value > 100) {
               $value = 100;
           }
       }
       return $value;
   }

   Just add priority to more than 10.

   Tested in WordPress 5.1