Passando mensagens de erro / aviso de uma meta box para "admin_notices"

20

Eu tenho uma caixa meta simples que atualiza os campos personalizados de postagem (usando update_post_meta()).

Como posso enviar uma mensagem de erro ou aviso para a próxima página depois que o usuário publica / atualiza a postagem e não preenche um dos campos da caixa meta (ou os preenche com dados inválidos)?

onetrickpony
fonte

Respostas:

9

Você pode fazer isso manualmente, mas o WP o faz de maneira nativa para erros de configuração:

  1. add_settings_error() para criar mensagem.
  2. Então set_transient('settings_errors', get_settings_errors(), 30);
  3. settings_errors()no admin_noticesgancho para exibir (será necessário conectar para telas que não sejam de configurações).
Rarst
fonte
faz o que eu quero, mas isso não preencheria o banco de dados com toneladas de transientes?
Onetrickpony
O One Trick Pony em processo nativo transitório é excluído explicitamente (consulte a get_settings_errors()fonte). Você pode fazer isso sozinho se adaptar a lógica para a página sem configurações.
Rarst
2
ainda não gosto da idéia de armazenar mensagens de erro temporárias no banco de dados. Vou usar ajax para avisar o usuário sobre a mudança de entrada
onetrickpony
Com o cache de objetos, a desorganização do banco de dados não seria um problema.
lkraav
15

você pode usar admin_noticesgancho

primeiro defina a função de aviso:

function my_admin_notice(){
    //print the message
    echo '<div id="message">
       <p>metabox as errors on save message here!!!</p>
    </div>';
    //make sure to remove notice after its displayed so its only displayed when needed.
    remove_action('admin_notices', 'my_admin_notice');
}

A função de salvar sua metabox com base, se necessário, adiciona:

...
...
if($errors){
    add_action('admin_notices', 'my_admin_notice');
}
...
...

Atualizar

Como prometi aqui, é um exemplo de como adiciono uma mensagem de erro ao meu metabox

<?php
/*
Plugin Name: one-trick-pony-notice
Plugin URI: http://en.bainternet.info
Description: Just to proof a point using admin notice form metabox
Version: 1.0
Author: Bainternet
Author URI: http://en.bainternet.info
*/

/*  admin notice */
function my_admin_notice(){
    //print the message
    global $post;
    $notice = get_option('otp_notice');
    if (empty($notice)) return '';
    foreach($notice as $pid => $m){
        if ($post->ID == $pid ){
            echo '<div id="message" class="error"><p>'.$m.'</p></div>';
            //make sure to remove notice after its displayed so its only displayed when needed.
            unset($notice[$pid]);
            update_option('otp_notice',$notice);
            break;
        }
    }
}

//hooks

add_action('add_meta_boxes', 'OT_mt_add');
add_action('save_post', 'OT_mt_save');
add_action('admin_notices', 'my_admin_notice',0);

//add metabox
function OT_mt_add() {
    add_meta_box('OT_mt_sectionid', __( 'One Trick Meta Box notice', 'textdomain' ),'OT_mt_display','post');
}

//display metabox
function OT_mt_display() {

  // Use nonce for verification
  wp_nonce_field( plugin_basename(__FILE__), 'myplugin_noncename' );

  // The actual fields for data entry
  echo '<label for="myplugin_new_field">';
       _e("leave blank to get a notice on publish or update", 'textdomain' );
  echo '</label> ';
  echo '<input type="text" id="ot_field" name="ot_field" value="" size="25" />';

}


//save metabox here is were i check the fields and if empty i display a message
function OT_mt_save( $post_id ) {

  // verify this came from the our screen and with proper authorization,
  // because save_post can be triggered at other times
    if (!isset($_POST['myplugin_noncename'])) return $post_id;
  if ( !wp_verify_nonce( $_POST['myplugin_noncename'], plugin_basename(__FILE__) ) )
      return $post_id;

  // verify if this is an auto save routine. 
  // If it is our form has not been submitted, so we dont want to do anything
  if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE ) 
      return $post_id;


  if(!isset($_POST['ot_field']) || empty($_POST['ot_field'])){
    //field left empty so we add a notice
    $notice = get_option('otp_notice');
    $notice[$post_id] = "You have left the field empty";
    update_option('otp_notice',$notice);
  }

}

Agora, ao procurar esse código, encontrei minha maneira antiga de fazê-lo usando o post_updated_messagesgancho de filtro da mesma maneira, então adicionarei também:

<?php
/*
Plugin Name: one-trick-pony-notice2
Plugin URI: http://en.bainternet.info
Description: just like the one above but this time using post_updated_messages hook
Version: 1.0
Author: Bainternet
Author URI: http://en.bainternet.info
*/

//hooks
add_filter('post_updated_messages','my_messages',0);
add_action('add_meta_boxes', 'OT_mt_add');
add_action('save_post', 'OT_mt_save');


//add metabox
function OT_mt_add() {
    add_meta_box('OT_mt_sectionid', __( 'One Trick Meta Box notice', 'textdomain' ),'OT_mt_display','post');
}

//display metabox
function OT_mt_display() {

  // Use nonce for verification
  wp_nonce_field( plugin_basename(__FILE__), 'myplugin_noncename' );

  // The actual fields for data entry
  echo '<label for="myplugin_new_field">';
       _e("leave blank to get a notice on publish or update", 'textdomain' );
  echo '</label> ';
  echo '<input type="text" id="ot_field" name="ot_field" value="" size="25" />';

}


//save metabox here is were i check the fields and if empty i display a message
function OT_mt_save( $post_id ) {

  // verify this came from the our screen and with proper authorization,
  // because save_post can be triggered at other times
    if (!isset($_POST['myplugin_noncename'])) return $post_id;
  if ( !wp_verify_nonce( $_POST['myplugin_noncename'], plugin_basename(__FILE__) ) )
      return $post_id;

  // verify if this is an auto save routine. 
  // If it is our form has not been submitted, so we dont want to do anything
  if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE ) 
      return $post_id;


  if(!isset($_POST['ot_field']) || empty($_POST['ot_field'])){
    //field left empty so we add a notice
    $notice = get_option('otp_notice');
    $notice[$post_id] = "You have left the field empty";
    update_option('otp_notice',$notice);
  }

}

//messages filter
function my_messages($m){
    global $post;
    $notice = get_option('otp_notice');
    if (empty($notice)) return $m;
    foreach($notice as $pid => $mm){
        if ($post->ID == $pid ){
            foreach ($m['post'] as $i => $message){
                $m['post'][$i] = $message.'<p>'.$mm.'</p>';

            }
            unset($notice[$pid]);
            update_option('otp_notice',$notice);
            break;
        }
    }
    return $m;
}
Bainternet
fonte
realmente não funciona, porque depois que você salvar o post, você é redirecionado para que ação nunca funciona ...
onetrickpony
11
Redirecionado para onde? E o código acima é o que eu uso, então eu sei que funciona.
Bainternet
a sua função metabox save está conectada save_post?
Onetrickpony
11
obrigado, mas faz o mesmo que Rarst apontou: a mensagem de erro é salva no banco de dados e, em seguida, recuperada e excluída na próxima página.
Onetrickpony
11
-1 para usar um banco de dados. Você não pode garantir que o usuário correto verá o erro. Além disso, não vale a sobrecarga desnecessária. Por não ter uma maneira clara de lidar com erros de metabox, é uma boa solução, mas ainda não é eficiente. Adicionei um exemplo da maneira como faço isso em uma nova resposta para ajudar outras pessoas.
Jeremy
11

Esta resposta [ espelho ] de Otto no WP Tavern, na verdade resolve o problema transitório, fazendo o que o próprio WordPress faz para superar o problema de redirecionamento. Totalmente funcionou para mim.

O problema é que os transitórios existem para todos. Se você tiver mais de um usuário fazendo as coisas ao mesmo tempo, a mensagem de erro pode ir para a pessoa errada. É uma condição de corrida.

O WordPress realmente faz isso passando um parâmetro de mensagem na URL. O número da mensagem indica qual mensagem será exibida.

Você pode fazer o mesmo conectando o redirect_post_locationfiltro e, em seguida, usando add_query_argpara adicionar seu próprio parâmetro à solicitação. Igual a:

add_filter('redirect_post_location','my_message');
function my_message($loc) {
 return add_query_arg( 'my_message', 123, $loc );
}

Isso adiciona my_message=123à consulta. Em seguida, após o redirecionamento, você pode detectar a configuração my_message no $_GETe exibir a mensagem adequada de acordo.

Ana Ban
fonte
3

Sei que esta pergunta é antiga, mas encontro as respostas aqui para não resolver o problema.

Estendendo a resposta de Ana Ban, usando o método de Otto , achei que esse era o melhor método para lidar com erros. Isso não requer o armazenamento dos erros no banco de dados.

Incluí uma versão simplificada de um objeto Metabox que eu uso. Isso me permite adicionar facilmente novas mensagens de erro e garantir que o usuário correto veja a mensagem de erro (usar o banco de dados, isso não é uma garantia).

<?php
/**
 * Class MetaboxExample
 */
class MetaboxExample {

    /**
     * Defines the whitelist for allowed screens (post_types)
     */
    private $_allowedScreens = array( 'SCREENS_TO_ALLOW_METABOX' );

    /**
     * Get parameter for the error box error code
     */
    const GET_METABOX_ERROR_PARAM = 'meta-error';

    /**
     * Defines admin hooks
     */
    public function __construct() {
        add_action('add_meta_boxes', array($this, 'addMetabox'), 50);
        add_action('save_post', array($this, 'saveMetabox'), 50);
        add_action('edit_form_top', array($this, 'adminNotices')); // NOTE: admin_notices doesn't position this right on custom post type pages, haven't testes this on POST or PAGE but I don't see this an issue
    }

    /**
     * Adds the metabox to specified post types
     */
    public function addMetabox() {
        foreach ( $this->_allowedScreens as $screen ) {
            add_meta_box(
                'PLUGIN_METABOX',
                __( 'TITLE', 'text_domain' ),
                array($this, 'metaBox'),
                $screen,
                'side',
                'high'
            );
        }
    }

    /**
     * Output metabox content
     * @param $post
     */
    public function metaBox($post) {
        // Add an nonce field so we can check for it later.
        wp_nonce_field( 'metaboxnonce', 'metaboxnonce' );
        // Load meta data for this metabox
        $someValue = get_post_meta( $post->ID, 'META_KEY_IDENTIFIER', true );
        ?>
        <p>
            <label for="some-value" style="width: 120px; display: inline-block;">
                <?php _e( 'Some Field:', 'text_domain' ); ?>
            </label>
            &nbsp;
            <input type="text" id="some-value" name="some_value" value="<?php esc_attr_e( $someValue ); ?>" size="25" />
        </p>
    <?php
    }

    /**
     * Save method for the metabox
     * @param $post_id
     */
    public function saveMetabox($post_id) {
        global $wpdb;

        // Check if our nonce is set.
        if ( ! isset( $_POST['metaboxnonce'] ) ) {
            return $post_id;
        }
        // Verify that the nonce is valid.
        if ( ! wp_verify_nonce( $_POST['metaboxnonce'], 'metaboxnonce' ) ) {
            return $post_id;
        }
        // If this is an autosave, our form has not been submitted, so we don't want to do anything.
        if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
            return $post_id;
        }
        // Check the user's permissions.
        if ( isset( $_POST['post_type'] ) && 'page' == $_POST['post_type'] ) {
            if ( ! current_user_can( 'edit_page', $post_id ) ) {
                return $post_id;
            }
        } else {
            if ( ! current_user_can( 'edit_post', $post_id ) ) {
                return $post_id;
            }
        }
        // Make sure that it is set.
        if ( !isset( $_POST['some_value'] ) ) {
            return $post_id;
        }
        // Sanitize user input.
        $someValue = sanitize_text_field( $_POST['some_value'] );
        // Check to make sure there is a value
        if (empty($someValue)) {
            // Add our error code
            add_filter('redirect_post_location', function($loc) {
                return add_query_arg( self::GET_METABOX_ERROR_PARAM, 1, $loc );
            });
            return $post_id; // make sure to return so we don't allow further processing
        }
        // Update the meta field in the database.
        update_post_meta( $post_id, 'META_KEY_IDENTIFIER', $someValue );
    }

    /**
     * Metabox admin notices
     */
    public function adminNotices() {
        if (isset($_GET[self::GET_METABOX_ERROR_PARAM])) {
            $screen = get_current_screen();
            // Make sure we are in the proper post type
            if (in_array($screen->post_type, $this->_allowedScreens)) {
                $errorCode = (int) $_GET[self::GET_METABOX_ERROR_PARAM];
                switch($errorCode) {
                    case 1:
                        $this->_showAdminNotice( __('Some error happened', 'text_domain') );
                        break;
                    // More error codes go here for outputting errors
                }
            }
        }
    }

    /**
     * Shows the admin notice for the metabox
     * @param $message
     * @param string $type
     */
    private function _showAdminNotice($message, $type='error') {
        ?>
        <div class="<?php esc_attr_e($type); ?> below-h2">
            <p><?php echo $message; ?></p>
        </div>
    <?php
    }

}
Jeremy
fonte
O único problema que tenho com esta resposta é que ele não funciona com o PHP 5.2. Não estou dizendo que todos devemos dar suporte ao HPP 5.2, mas até que o WordPress tenha o PHP 5.2 como requisito mínimo, precisamos apoiá-lo se estivermos distribuindo o plug-in :(
Sudar
11
Se você removeu a função anônima e a tornou um método público, ela deve funcionar bem. Entendo o seu problema, mas pessoalmente não desenvolverei uma versão EOL do PHP ( php.net/eol.php ). 5.2 A EOL foi em 6 de janeiro de 2011. O WordPress deve se esforçar mais para não suportar as versões da EOL, mas isso é outra história. além de muitas más companhias de hospedagem que ainda fornecidas versões EOL ...
Jeremy