Support » Plugins and Hacks » Hacks » How to use settings API and print custom validation errors

  • Hi there,
    .
    Can anyone point me in the direction of an example where the Settings API has been used AND specific validation errors are printed in response to a plugin’s settings page?

    ie “This is not a valid email” or “No such file”

    It appears more sensible to use the Settings API and options.php but I can’t see how to add my own error messages.

    Cheers
    ~loothi

Viewing 2 replies - 1 through 2 (of 2 total)
  • It’s not easy. Apparently that functionality is not built-in (yet) on the settings API.

    Two hacks that allow that are somewhat explained here:

    http://old.nabble.com/Settings-API%3A-Showing-errors-if-validation-fails-td26820359.html

    One involves having an extra hidden field that gets rewritten with the error message; the other, more complex to figure out, but probably cleaner, involves adding a admin_notices hook.

    I haven’t tried them myself, but hopefully they’re useful. I’m looking for a cleaner way to do that myself.

    Moderator keesiemeijer

    (@keesiemeijer)

    moderator

    I was trying this also and this worked for me:

    add_action( 'admin_notices', 'my_validation_notice');
    
      function my_validation_notice(){
        global $pagenow;
        if ($pagenow == 'options-general.php' && $_GET['page'] ==
    'my-plugin') { // change my-plugin to your plugin page
          if ( (isset($_GET['updated']) && $_GET['updated'] == 'true') || (isset($_GET['settings-updated']) && $_GET['settings-updated'] == 'true') ) {
    
          //this will clear the update message "Settings Saved" totally
          //unset($_GET['settings-updated']);
    
          //get_settings_errors() also will clear the update message
          $errors = get_settings_errors();
    
          /* get_settings_errors() returns an array With the original message
    [0] => Array
            (
                [setting] => general
                [code] => settings_updated
                [message] => Settings saved.
                [type] => updated
            )
        */
    
          // add your own messages or add the original message back 
    
          // original message
          $original_message = $errors[0]['message'];
          add_settings_error('general
    ', 'settings_updated', $original_message, 'updated');
    
          // your messages
          $error_message = 'my error message';
          add_settings_error('general
    ', 'settings_updated', $error_message, 'error');
    
          $update_message = 'my update message';
          add_settings_error('general
    ', 'settings_updated', $update_message, 'updated');
    
        }
      }
    }

    Thanks for the link Gwyneth Llewelyn. There is not much information out there on Setting Api validation and Admin page notices.

Viewing 2 replies - 1 through 2 (of 2 total)
  • The topic ‘How to use settings API and print custom validation errors’ is closed to new replies.