forked from Automattic/vip-go-mu-plugins
-
Notifications
You must be signed in to change notification settings - Fork 0
/
async-publish-actions.php
186 lines (164 loc) · 5.84 KB
/
async-publish-actions.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<?php
/*
Plugin Name: Async Publish Actions
Description: Allow for async processing of tasks normally hooked to certain `transition_post_status` calls.
Author: Automattic
Author URI: http://automattic.com/
*/
namespace Automattic\VIP\Async_Publish_Actions;
const ASYNC_TRANSITION_EVENT = 'wpcom_vip_async_transition_post_status';
/**
* Check if the current context is suitable for offloading
*
* @return bool
*/
function should_offload() {
// Offload by default.
$context = null;
$offload = true;
if ( wp_doing_cron() ) {
$context = 'cron';
$offload = false;
} elseif ( defined( 'WP_CLI' ) && \WP_CLI ) {
$context = 'wp-cli';
$offload = false;
} elseif ( defined( 'XMLRPC_REQUEST' ) && \XMLRPC_REQUEST ) {
$context = 'xml-rpc';
$offload = false;
} elseif ( defined( 'WP_IMPORTING' ) && \WP_IMPORTING ) {
$context = 'importing';
$offload = false;
}
/**
* Filter if the current request is suitable for offloading
*
* @param bool $bypass Whether or not to offload.
* @param string $context Request context that blocked offloading.
*/
return apply_filters( 'wpcom_async_transition_post_status_should_offload', $offload, $context );
}
/**
* Cron callback to perform asynchronous tasks for a published post
*
* @access private
*
* @param int $post_id Post ID.
* @param string $new_status New post status.
* @param string $old_status Previous post status.
*/
function _wpcom_do_async_transition_post_status( $post_id, $new_status, $old_status ) {
$post = get_post( $post_id );
// If post status has changed since this was queued, abort and let the next event handle this post.
if ( $new_status !== get_post_status( $post ) ) {
return;
}
// Gauge how often this feature is used.
if ( true === WPCOM_IS_VIP_ENV && false === WPCOM_SANDBOXED ) {
\Automattic\VIP\Stats\send_pixel( [
'vip-go-async-publish-job' => FILES_CLIENT_SITE_ID,
] );
}
/**
* Fires when a post is transitioned from one status to another.
*
* @param string $new_status New post status.
* @param string $old_status Old post status.
* @param \WP_Post $post Post object.
*/
do_action( 'async_transition_post_status', $new_status, $old_status, $post );
/**
* Fires when a post is transitioned from one status to another.
*
* The dynamic portions of the hook name, `$new_status` and `$old status`,
* refer to the old and new post statuses, respectively.
*
* @param \WP_Post $post Post object.
*/
do_action( "async_{$old_status}_to_{$new_status}", $post );
/**
* Fires when a post is transitioned from one status to another.
*
* The dynamic portions of the hook name, `$new_status` and `$post->post_type`,
* refer to the new post status and post type, respectively.
*
* Please note: When this action is hooked using a particular post status (like
* 'publish', as `publish_{$post->post_type}`), it will fire both when a post is
* first transitioned to that status from something else, as well as upon
* subsequent post updates (old and new status are both the same).
*
* Therefore, if you are looking to only fire a callback when a post is first
* transitioned to a status, use the {@see 'transition_post_status'} hook instead.
*
* @param int $post_id Post ID.
* @param \WP_Post $post Post object.
*/
do_action( "async_{$new_status}_{$post->post_type}", $post->ID, $post );
}
/**
* Queue async event when status was or is `publish`
*
* @access private
*
* @param string $new_status New post status.
* @param string $old_status Old post status.
* @param object $post \WP_Post object.
*/
function _queue_async_hooks( $new_status, $old_status, $post ) {
if ( 'auto-draft' === $post->post_status ) {
return;
}
// Pass only consistent data, allowing cron's duplicate handling to take effect.
// For example, don't include post status here.
$args = [
'post_id' => (int) $post->ID,
'new_status' => $new_status,
'old_status' => $old_status,
];
/**
* Filter whether or not a cron event should be scheduled when the post transitions status.
*
* @param bool $true Whether or not to schedule the cron event.
* @param array $args Array of arguments containing the post_id, new_status, and old_status.
*/
if ( false === apply_filters( 'wpcom_async_transition_post_status_schedule_async', true, $args ) ) {
return;
}
// If nothing is hooked on, avoid scheduling a cron job.
if ( ! has_action( 'async_transition_post_status' ) && ! has_action( "async_{$old_status}_to_{$new_status}" ) && ! has_action( "async_{$new_status}_{$post->post_type}" ) ) {
return;
}
if ( false !== wp_next_scheduled( ASYNC_TRANSITION_EVENT, $args ) ) {
return;
}
if ( $new_status !== $old_status && in_array( 'publish', [ $new_status, $old_status ], true ) ) {
wp_schedule_single_event( time(), ASYNC_TRANSITION_EVENT, $args );
}
}
/**
* Maybe schedule offloading.
*/
if ( should_offload() ) {
// Trigger offloading.
add_action( 'transition_post_status', __NAMESPACE__ . '\_queue_async_hooks', 10, 3 );
}
/**
* Hook regardless `should_offload()`, lest unrelated requests be impacted
*/
add_action( ASYNC_TRANSITION_EVENT, __NAMESPACE__ . '\_wpcom_do_async_transition_post_status', 10, 3 );
/**
* Bump concurrency of the transition events.
*
* With lots of publishing activity on a site, we can end up with a backlog.
* Enabling some concurrency allows that to be cleared a bit faster.
*
* One downside is that the events are no longer atomic and anything relying
* on post state should check the current value in the event callback.
*
* For example, with a trash and untrash, the `untrash` event may fire first (or
* at the same time and `get_post( $post->ID )->post_status` should be used to
* verify what state the post is in, if needed).
*/
add_filter( 'a8c_cron_control_concurrent_event_whitelist', function( $whitelist ) {
$whitelist[ ASYNC_TRANSITION_EVENT ] = 5; // safe, low number to start
return $whitelist;
} );