投稿の保存/更新時に管理者通知を追加する方法


16

post_saveを使用してpost-metaからアドレスを取得し、Google APIから緯度/経度の座標を取得する投稿タイプがあります。座標の取得に問題があった場合、ユーザーに通知する方法が必要です。admin_noticesを使用しようとしましたが、何も表示されませんでした。

public static function update_notice() {
  echo "<div class='error'><p>Failed to retrieve coordinates. Please check key and address.<p></div>";
  remove_action('admin_notices', 'update_notice');
}

add_action('admin_notices', array('GeoPost', 'update_notice'));

間違って使用しているか、間違ったコンテキストで使用しているかはわかりません。明確にするために、実際のコードでは、add_actionは同じクラスの別の関数にあります。それはうまく機能しています。


却下可能/静的な管理者通知を簡単に追加できるスクリプトを開発しましたgithub.com/askupasoftware/wp-admin-notification
Yoav Kadosh

回答:


30

これが機能しないのは、save_postアクションの後にリダイレクトが発生するためです。欲しいものを実現する1つの方法は、クエリ変数を使用して簡単な回避策を実装することです。

デモするサンプルクラスを次に示します。

class My_Awesome_Plugin {
  public function __construct(){
   add_action( 'save_post', array( $this, 'save_post' ) );
   add_action( 'admin_notices', array( $this, 'admin_notices' ) );
  }

  public function save_post( $post_id, $post, $update ) {
   // Do you stuff here
   // ...

   // Add your query var if the coordinates are not retreive correctly.
   add_filter( 'redirect_post_location', array( $this, 'add_notice_query_var' ), 99 );
  }

  public function add_notice_query_var( $location ) {
   remove_filter( 'redirect_post_location', array( $this, 'add_notice_query_var' ), 99 );
   return add_query_arg( array( 'YOUR_QUERY_VAR' => 'ID' ), $location );
  }

  public function admin_notices() {
   if ( ! isset( $_GET['YOUR_QUERY_VAR'] ) ) {
     return;
   }
   ?>
   <div class="updated">
      <p><?php esc_html_e( 'YOUR MESSAGE', 'text-domain' ); ?></p>
   </div>
   <?php
  }
}

これが少しでもお役に立てば幸いです。乾杯


すばらしい、ありがとう!しかし、最初の行で行方不明閉じ括弧がありますpublic function admin_notices()(中の余分な閉じ括弧if ( ! isset(..ライン)
リス・ウィン

remove_query_arg('YOUR_QUERY_VAR');最後の更新から設定できることがわかったので追加しました。
トニーオハーガン

+1良い答え。
マーク

12

この種のシナリオのラッパークラスを作成しました。実際には、クラスは通知の表示を含むあらゆるシナリオで使用できます。私はPSR標準を使用しているため、命名はWordpressコードの典型ではありません。

class AdminNotice
{
    const NOTICE_FIELD = 'my_admin_notice_message';

    public function displayAdminNotice()
    {
        $option      = get_option(self::NOTICE_FIELD);
        $message     = isset($option['message']) ? $option['message'] : false;
        $noticeLevel = ! empty($option['notice-level']) ? $option['notice-level'] : 'notice-error';

        if ($message) {
            echo "<div class='notice {$noticeLevel} is-dismissible'><p>{$message}</p></div>";
            delete_option(self::NOTICE_FIELD);
        }
    }

    public static function displayError($message)
    {
        self::updateOption($message, 'notice-error');
    }

    public static function displayWarning($message)
    {
        self::updateOption($message, 'notice-warning');
    }

    public static function displayInfo($message)
    {
        self::updateOption($message, 'notice-info');
    }

    public static function displaySuccess($message)
    {
        self::updateOption($message, 'notice-success');
    }

    protected static function updateOption($message, $noticeLevel) {
        update_option(self::NOTICE_FIELD, [
            'message' => $message,
            'notice-level' => $noticeLevel
        ]);
    }
}

使用法:

add_action('admin_notices', [new AdminNotice(), 'displayAdminNotice']);
AdminNotice::displayError(__('An error occurred, check logs.'));

通知は一度表示されます。


6

@jonathanbardoの素晴らしい回答であることに加えて、新しいページが読み込まれた後にクエリ引数を削除したい場合は、removable_query_argsフィルターを使用できます。独自の引数を追加できる引数名の配列を取得します。その後、WPはURLからリスト内のすべての引数を削除します。

public function __construct() {
    ...
    add_filter('removable_query_args', array($this, 'add_removable_arg'));
}

public function add_removable_arg($args) {
    array_push($args, 'my-query-arg');
    return $args;
}

何かのようなもの:

'...post.php?post=1&my-query-arg=10'

となります:

'...post.php?post=1'

1

に基づいたシンプルでエレガントなget_settings_errors()

function wpse152033_set_admin_notice($id, $message, $status = 'success') {
    set_transient('wpse152033' . '_' . $id, [
        'message' => $message,
        'status' => $status
    ], 30);
}

function wpse152033_get_admin_notice($id) {
    $transient = get_transient( 'wpse152033' . '_' . $id );
    if ( isset( $_GET['settings-updated'] ) && $_GET['settings-updated'] && $transient ) {
        delete_transient( 'wpse152033' . '_' . $id );
    }
    return $transient;
}

使用法

投稿リクエストハンドラで:

wpse152033_set_admin_notice(get_current_user_id(), 'Hello world', 'error');
wp_redirect(add_query_arg('settings-updated', 'true',  wp_get_referer()));

管理通知を使用する場所(通常はadmin_noticesフック内)。

$notice = $this->get_admin_notice(get_current_user_id());
if (!empty($notice) && is_array($notice)) {
    $status = array_key_exists('status', $notice) ? $notice['status'] : 'success';
    $message = array_key_exists('message', $notice) ? $notice['message'] : '';
    print '<div class="notice notice-'.$status.' is-dismissible">'.$message.'</div>';
}
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.