Automattic\WooCommerce\Internal\PushNotifications\Dispatchers
WpcomNotificationDispatcher::dispatch │ public │ WC 10.7.0
Dispatches a notification with push tokens to WPCOM.
invalid_tokens holds the token strings WPCOM refused, exactly as sent, when the outcome is a token rejection; it is empty otherwise.
Метод класса: WpcomNotificationDispatcher{}
Хуков нет.
Возвращает
array{success: bool, retry_after: int|null, outcome: string, invalid_tokens: string[]}.
Использование
$WpcomNotificationDispatcher = new WpcomNotificationDispatcher();
$WpcomNotificationDispatcher->dispatch( $notification, $tokens ): array;
- $notification(Notification) (обязательный)
- The notification to send.
- $tokens(PushToken[]) (обязательный)
- The push tokens to send to.
Список изменений
Код WpcomNotificationDispatcher::dispatch() WpcomNotificationDispatcher::dispatch
WC 11.3.0
public function dispatch( Notification $notification, array $tokens ): array {
$site_id = class_exists( Jetpack_Options::class ) ? Jetpack_Options::get_option( 'id' ) : null;
if ( empty( $site_id ) ) {
$this->step_logger->log_failure(
$notification,
'dispatched',
SendOutcome::SITE_ID_MISSING,
'error',
'Cannot send push notifications: Jetpack site ID unavailable.'
);
return self::failure( SendOutcome::SITE_ID_MISSING );
}
$payload = $notification->to_payload();
if ( null === $payload ) {
$this->step_logger->log_failure(
$notification,
'dispatched',
SendOutcome::RESOURCE_MISSING,
'error',
sprintf(
'Cannot send push notification: resource no longer exists (type=%s, resource_id=%d).',
$notification->get_type(),
$notification->get_resource_id()
)
);
return self::failure( SendOutcome::RESOURCE_MISSING );
}
$response = $this->make_request( $site_id, $payload, $tokens );
if ( is_wp_error( $response ) ) {
$this->step_logger->log_failure(
$notification,
'dispatched',
SendOutcome::REQUEST_FAILED,
'error',
sprintf( 'Push notification request failed: %s', $response->get_error_message() ),
array( 'error_code' => $response->get_error_code() )
);
return self::failure( SendOutcome::REQUEST_FAILED );
}
$status_code = (int) wp_remote_retrieve_response_code( $response );
$body = json_decode( (string) wp_remote_retrieve_body( $response ), true );
$body = is_array( $body ) ? $body : array();
if ( WP_Http::OK === $status_code ) {
$queued = (int) ( $body['queued'] ?? 0 );
$deduplicated = (int) ( $body['deduplicated'] ?? 0 );
// The endpoint delivers to the first 100 tokens of a request and drops the rest.
$dropped = (int) ( $body['dropped'] ?? 0 );
$outcome = $queued > 0 ? SendOutcome::ACCEPTED : SendOutcome::DEDUPLICATED;
$this->step_logger->log_notification_step(
$notification,
'dispatched',
$outcome,
array(
'recipients' => count( $tokens ),
'queued' => $queued,
'deduplicated' => $deduplicated,
'dropped' => $dropped,
)
);
return array(
'success' => true,
'retry_after' => null,
'outcome' => $outcome,
'invalid_tokens' => array(),
);
}
$retry_after = wp_remote_retrieve_header( $response, 'retry-after' );
$error_code = (string) ( $body['code'] ?? '' );
$invalid_tokens = array();
$outcome = SendOutcome::FAILED;
if ( self::WPCOM_ERROR_INVALID_TOKENS === $error_code ) {
$outcome = SendOutcome::REJECTED_INVALID_TOKEN;
$invalid_tokens = array_values( array_filter( (array) ( $body['data']['invalid_tokens'] ?? array() ), 'is_string' ) );
} elseif ( self::WPCOM_ERROR_INVALID_PARAM === $error_code ) {
$outcome = SendOutcome::REJECTED_INVALID_NOTIFICATION;
}
$this->step_logger->log_failure(
$notification,
'dispatched',
$outcome,
'error',
sprintf( 'Push notification request returned HTTP %d.', $status_code ),
array(
'http_status' => $status_code,
'error_code' => $error_code,
'recipients' => count( $tokens ),
'invalid_tokens' => count( $invalid_tokens ),
'retry_after' => '' !== $retry_after ? (int) $retry_after : null,
)
);
return array(
'success' => false,
'retry_after' => '' !== $retry_after ? (int) $retry_after : null,
'outcome' => $outcome,
'invalid_tokens' => $invalid_tokens,
);
}