Функция wp_notify_postauthor(): уведомление автора о новом комментарии

# Функция WP_NOTIFY_POSTAUTHOR() │ WP 1.0.0

Функция wp_notify_postauthor() используется для уведомления автора поста (и/или других пользователей) о новом комментарии, отклике или пингбэке на его пост.

## Плагины и замена функции

Эта функция является "плагино-безопасной" (pluggable). Это значит, что её можно заменить в любом плагине. Функция будет доступна только после загрузки всех плагинов, и до этого момента её нельзя вызвать. 

Чтобы заменить функцию, в вашем плагине (обязательном или обычном) создайте функцию с тем же названием — это заменит оригинальную функцию.

### Хуки, используемые в функции

- comment_notification_recipients
- comment_notification_notify_author
- comment_notification_headers
- comment_notification_text
- comment_notification_subject

## Возврат значения

Функция возвращает true, если операция успешна, и false, если адреса электронной почты не указаны.

## Использование

```php
wp_notify_postauthor( $comment_id, $deprecated );
  • $comment_id (int|WP_Comment) - идентификатор комментария или объект комментария.
  • $deprecated (string) - не используется.
  • Значение по умолчанию: null.

Примеры

Пример 1: Отправка уведомления автору поста

if( wp_notify_postauthor( 600 ) ) {
    echo 'Уведомление отправлено.';
}

Изменения

  • С версии 1.0.0: Функция была представлена.

Код функции wp_notify_postauthor()

function wp_notify_postauthor( $comment_id, $deprecated = null ) {
    if ( null !== $deprecated ) {
        _deprecated_argument( __FUNCTION__, '3.8.0' );
    }

    $comment = get_comment( $comment_id );
    if ( empty( $comment ) || empty( $comment->comment_post_ID ) ) {
        return false;
    }

    $post   = get_post( $comment->comment_post_ID );
    $author = get_userdata( $post->post_author );

    // Кому отправить уведомление? По умолчанию, только автору поста.
    $emails = array();
    if ( $author ) {
        $emails[] = $author->user_email;
    }

    $emails = apply_filters( 'comment_notification_recipients', $emails, $comment->comment_ID );
    $emails = array_filter( $emails );

    // Если нет адресов для отправки уведомления, выйти.
    if ( ! count( $emails ) ) {
        return false;
    }

    // Упрощаем обработку индексов.
    $emails = array_flip( $emails );

    $notify_author = apply_filters( 'comment_notification_notify_author', false, $comment->comment_ID );

    // Если комментарий оставлен автором поста, мы не отправляем уведомление.
    if ( $author && ! $notify_author && (int) $comment->user_id === (int) $post->post_author ) {
        unset( $emails[ $author->user_email ] );
    }

    // Если автор поста больше не является членом сайта.
    if ( $author && ! $notify_author && ! user_can( $post->post_author, 'read_post', $post->ID ) ) {
        unset( $emails[ $author->user_email ] );
    }

    // Если не осталось адресов для уведомления, выйти.
    if ( ! count( $emails ) ) {
        return false;
    } else {
        $emails = array_flip( $emails );
    }

    // Извлекаем адрес и имя хоста автора комментария.
    $comment_author_domain = '';
    if ( WP_Http::is_ip_address( $comment->comment_author_IP ) ) {
        $comment_author_domain = gethostbyaddr( $comment->comment_author_IP );
    }

    $blogname        = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
    $comment_content = wp_specialchars_decode( $comment->comment_content );

    $wp_email = 'wordpress@' . preg_replace( '#^www.#', '', wp_parse_url( network_home_url(), PHP_URL_HOST ) );

    // Указываем заголовки письма.
    if ( '' === $comment->comment_author ) {
        $from = "From: "$blogname" <$wp_email>";
        if ( '' !== $comment->comment_author_email ) {
            $reply_to = "Reply-To: $comment->comment_author_email";
        }
    } else {
        $from = "From: "$comment->comment_author" <$wp_email>";
        if ( '' !== $comment->comment_author_email ) {
            $reply_to = "Reply-To: "$comment->comment_author_email" <$comment->comment_author_email>";
        }
    }

    $message_headers = "$fromn"
    . 'Content-Type: text/plain; charset="' . get_option( 'blog_charset' ) . ""n";

    if ( isset( $reply_to ) ) {
        $message_headers .= $reply_to . "n";
    }

    foreach ( $emails as $email ) {
        $user = get_user_by( 'email', $email );

        if ( $user ) {
            $switched_locale = switch_to_user_locale( $user->ID );
        } else {
            $switched_locale = switch_to_locale( get_locale() );
        }

        // Формируем текст уведомления в зависимости от типа комментария.
        switch ( $comment->comment_type ) {
            case 'trackback':
                $notify_message = sprintf( __( 'Новый трекбек на вашем посте "%s"' ), $post->post_title ) . "rn";
                $subject = sprintf( __( '[%1$s] Трекбек: "%2$s"' ), $blogname, $post->post_title );
                break;

            case 'pingback':
                $notify_message = sprintf( __( 'Новый пингбек на вашем посте "%s"' ), $post->post_title ) . "rn";
                $subject = sprintf( __( '[%1$s] Пингбек: "%2$s"' ), $blogname, $post->post_title );
                break;

            default: // Комментарии.
                $notify_message = sprintf( __( 'Новый комментарий на вашем посте "%s"' ), $post->post_title ) . "rn";
                $subject = sprintf( __( '[%1$s] Комментарий: "%2$s"' ), $blogname, $post->post_title );
                break;
        }

        // Отправка уведомления.
        wp_mail( $email, wp_specialchars_decode( $subject ), $notify_message, $message_headers );

        // Восстанавливаем предыдущий локаль.
        if ( $switched_locale ) {
            restore_previous_locale();
        }
    }

    return true;
}

Связанные функции

  • wp_notify_moderator()
  • cancel_comment_reply_link()
  • comment_form()
  • get_comment()
  • get_comments()
  • wp_mail()

Leave a Reply

Ваш адрес email не будет опубликован. Обязательные поля помечены *