メタボックスから「admin_notices」にエラー/警告メッセージを渡す


20

投稿カスタムフィールドを更新するシンプルなメタボックスがあります(を使用update_post_meta())。

ユーザーが投稿を公開/更新し、メタボックスフィールドの1つを埋めない(または無効なデータを埋める)後にエラーまたは警告メッセージを次のページに送信するにはどうすればよいですか?

回答:


9

これは手動で行うことができますが、WPはネイティブで設定エラーに対して次のように行います。

  1. add_settings_error() メッセージを作成します。
  2. それから set_transient('settings_errors', get_settings_errors(), 30);
  3. settings_errors()admin_noticesディスプレイにフック(非設定画面用フックする必要があります)。

それは私が望むことをしますが、これはデータベースを大量の一時的なもので満たさないでしょうか?
onetrickpony

ネイティブプロセストランジェントの@One Trick Ponyは明示的に削除されます(get_settings_errors()ソースを参照)。非設定ページにロジックを適合させる場合、あなた自身でそれを行う必要があるかもしれません。
11

2
それでも、一時的なエラーメッセージをデータベースに保存するという考えは好きではありません。私は、入力変化にユーザーに警告するために、AJAXを使用します
onetrickpony

オブジェクトキャッシュを使用すると、データベースの乱雑さは問題になりません。
lkraav

15

あなたはadmin_noticesフックを使うことができます

最初に通知機能を定義します。

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');
}

必要に応じてメタボックス保存機能を追加します:

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

更新

私がここで約束したように、メタボックスからエラーメッセージを追加する方法の例です

<?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);
  }

}

このコードを探しているとき、post_updated_messagesフィルターフックを使用してそれを行う古い方法をほぼ同じ方法で見つけたので、それも追加します:

<?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;
}

あなたがポストを保存した後、そのアクションが実行されることはありませんので、あなたがリダイレクトされますので、本当に仕事は...ない
onetrickpony

1
どこにリダイレクトされましたか?そして、上記のコードは私が使用しているものなので、動作することがわかっています。
Bainternet

あなたのメタボックス保存機能はフックされていsave_postますか?
onetrickpony

1
感謝しますが、これはRarstが指摘したのと同じことです。エラーメッセージはdbに保存され、次のページで取得および削除されます。
-onetrickpony

1
-1 DBを使用する場合。正しいユーザーにエラーが表示されることを保証することはできません。また、不要なオーバーヘッドの価値はありません。メタボックスエラーを処理する明確な方法がないため、これは回避策としては優れていますが、それでも効率的ではありません。他の人を助けるための新しい答えに、これを行う方法の例を追加しました。
ジェレミー

11

WP TavernのOttoからのこの回答[ ミラー ]は、WordPress自体がリダイレクトの問題を克服するために行うことによって一時的な問題を実際に解決します。完全に私のために働いた。

問題は、すべての人にトランジェントが存在することです。複数のユーザーが同時に操作を行っている場合、エラーメッセージが間違った人に送信される可能性があります。それは競合状態です。

WordPressは実際にURLでメッセージパラメーターを渡すことでこれを行います。メッセージ番号は、表示するメッセージを示します。

redirect_post_locationフィルタをフックし、それを使用add_query_argしてリクエストに独自のパラメータを追加することにより、同じことを行うことができます。そのようです:

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

これによりmy_message=123、クエリが追加されます。次に、リダイレクト後、my_message設定を検出し、$_GETそれに応じて適切なメッセージを表示できます。


3

私はこの質問が古いことを知っていますが、問題を解決しないためにここで答えを見つけます。

Ottoのmethodを使用してAna Banからの回答を拡張すると、これがエラーを処理する最適な方法であることがわかりました。これには、dbにエラーを保存する必要はありません。

使用するMetaboxオブジェクトの簡易バージョンを含めました。これにより、新しいエラーメッセージを簡単に追加し、正しいユーザーにエラーメッセージが表示されるようにすることができます(dbを使用すると、これは保証されません)。

<?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
    }

}

この答えに関して私が抱えている唯一の問題は、PHP 5.2では機能しないことです。HPP 5.2をすべてサポートする必要があるとは言っていませんが、プラグインを配布する場合は、WordPressがPHP 5.2を最小要件としてサポートするまでサポートする必要があります。(
Sudar

1
無名関数を削除してパブリックメソッドにした場合、正常に機能するはずです。私はあなたの問題を理解していますが、私は個人的にPHPのEOLバージョン(php.net/eol.php)向けに開発しません。5.2EOLは2011年1月6日でした。さらに、まだEOLバージョンを提供している多くの悪いホスティング会社
Jeremy
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.