← All changes | json-endpoints/class.wpcom-json-api-update-post-v1-2-endpoint.php +103 -57 12.0.3 → 16.3-a.1 View file →

		@@ -8,8 +8,12 @@
8	8	* Delete a post: /sites/%s/posts/%d/delete
9	9	* Restore a post: /sites/%s/posts/%d/restore
10	10	*/
11	11
	12	+if ( ! defined( 'ABSPATH' ) ) {
	13	+ exit( 0 );
	14	+}
	15	+
12	16	new WPCOM_JSON_API_Update_Post_v1_2_Endpoint(
13	17	array(
14	18	'description' => 'Create a post.',
15	19	'group' => 'posts',
		@@ -105,17 +109,17 @@
105	109	'autosave' => '(bool) True if the post was saved automatically.',
106	110	),
107	111
108	112	'request_format' => array(
109		- 'date' => "(ISO 8601 datetime) The post's creation time.",
110		- 'title' => '(HTML) The post title.',
111		- 'content' => '(HTML) The post content.',
112		- 'excerpt' => '(HTML) An optional post excerpt.',
113		- 'slug' => '(string) The name (slug) for the post, used in URLs.',
114		- 'author' => '(string) The username or ID for the user to assign the post to.',
115		- 'publicize' => '(array|bool) True or false if the post be shared to external services. An array of services if we only want to share to a select few. Defaults to true.',
116		- 'publicize_message' => '(string) Custom message to be shared to external services.',
117		- 'status' => array(
	113	+ 'date' => "(ISO 8601 datetime) The post's creation time.",
	114	+ 'title' => '(HTML) The post title.',
	115	+ 'content' => '(HTML) The post content.',
	116	+ 'excerpt' => '(HTML) An optional post excerpt.',
	117	+ 'slug' => '(string) The name (slug) for the post, used in URLs.',
	118	+ 'author' => '(string) The username or ID for the user to assign the post to.',
	119	+ 'publicize' => '(array|bool) True or false if the post be shared to external services. An array of services if we only want to share to a select few. Defaults to true.',
	120	+ 'publicize_message' => '(string) Custom message to be shared to external services.',
	121	+ 'status' => array(
118	122	'publish' => 'Publish the post.',
119	123	'private' => 'Privately publish the post.',
120	124	'draft' => 'Save the post as a draft.',
121	125	'future' => 'Schedule the post (alias for publish; you must also set a future date).',
		@@ -121,31 +125,32 @@
121	125	'future' => 'Schedule the post (alias for publish; you must also set a future date).',
122	126	'pending' => 'Mark the post as pending editorial approval.',
123	127	'trash' => 'Set the post as trashed.',
124	128	),
125		- 'sticky' => array(
	129	+ 'sticky' => array(
126	130	'false' => 'Post is not marked as sticky.',
127	131	'true' => 'Stick the post to the front page.',
128	132	),
129		- 'password' => '(string) The plaintext password protecting the post, or, more likely, the empty string if the post is not password protected.',
130		- 'parent' => "(int) The post ID of the new post's parent.",
131		- 'terms' => '(object) Mapping of taxonomy to comma-separated list or array of term names',
132		- 'terms_by_id' => '(object) Mapping of taxonomy to comma-separated list or array of term IDs',
133		- 'categories' => '(array|string) Comma-separated list or array of category names',
134		- 'categories_by_id' => '(array|string) Comma-separated list or array of category IDs',
135		- 'tags' => '(array|string) Comma-separated list or array of tag names',
136		- 'tags_by_id' => '(array|string) Comma-separated list or array of tag IDs',
137		- 'format' => array_merge( array( 'default' => 'Use default post format' ), get_post_format_strings() ),
138		- 'discussion' => '(object) A hash containing one or more of the following boolean values, which default to the blog\'s discussion preferences: `comments_open`, `pings_open`',
139		- 'likes_enabled' => '(bool) Should the post be open to likes?',
140		- 'menu_order' => '(int) (Pages only) the order pages should appear in. Use 0 to maintain alphabetical order.',
141		- 'page_template' => '(string) (Pages Only) The page template this page should use.',
142		- 'sharing_enabled' => '(bool) Should sharing buttons show on this post?',
143		- 'featured_image' => '(string) The post ID of an existing attachment to set as the featured image. Pass an empty string to delete the existing image.',
144		- 'media' => '(media) An array of files to attach to the post. To upload media, the entire request should be multipart/form-data encoded. Multiple media items will be displayed in a gallery. Accepts jpg, jpeg, png, gif, pdf, doc, ppt, odt, pptx, docx, pps, ppsx, xls, xlsx, key. Audio and Video may also be available. See <code>allowed_file_types</code> in the options resposne of the site endpoint. <br /><br /><strong>Example</strong>:<br />' .
	133	+ 'password' => '(string) The plaintext password protecting the post, or, more likely, the empty string if the post is not password protected.',
	134	+ 'parent' => "(int) The post ID of the new post's parent.",
	135	+ 'terms' => '(object) Mapping of taxonomy to comma-separated list or array of term names',
	136	+ 'terms_by_id' => '(object) Mapping of taxonomy to comma-separated list or array of term IDs',
	137	+ 'categories' => '(array|string) Comma-separated list or array of category names',
	138	+ 'categories_by_id' => '(array|string) Comma-separated list or array of category IDs',
	139	+ 'tags' => '(array|string) Comma-separated list or array of tag names',
	140	+ 'tags_by_id' => '(array|string) Comma-separated list or array of tag IDs',
	141	+ 'format' => array_merge( array( 'default' => 'Use default post format' ), get_post_format_strings() ),
	142	+ 'discussion' => '(object) A hash containing one or more of the following boolean values, which default to the blog\'s discussion preferences: `comments_open`, `pings_open`',
	143	+ 'likes_enabled' => '(bool) Should the post be open to likes?',
	144	+ 'menu_order' => '(int) (Pages only) the order pages should appear in. Use 0 to maintain alphabetical order.',
	145	+ 'page_template' => '(string) (Pages Only) The page template this page should use.',
	146	+ 'sharing_enabled' => '(bool) Should sharing buttons show on this post?',
	147	+ 'featured_image' => '(string) The post ID of an existing attachment to set as the featured image. Pass an empty string to delete the existing image.',
	148	+ 'media' => '(media) An array of files to attach to the post. To upload media, the entire request should be multipart/form-data encoded. Multiple media items will be displayed in a gallery. Accepts jpg, jpeg, png, gif, pdf, doc, ppt, odt, pptx, docx, pps, ppsx, xls, xlsx, key. Audio and Video may also be available. See <code>allowed_file_types</code> in the options resposne of the site endpoint. <br /><br /><strong>Example</strong>:<br />' .
145	149	"<code>curl \<br />--form 'title=Image' \<br />--form 'media[]=@/path/to/file.jpg' \<br />-H 'Authorization: BEARER your-token' \<br />'https://public-api.wordpress.com/rest/v1/sites/123/posts/new'</code>",
146		- 'media_urls' => '(array) An array of URLs for images to attach to a post. Sideloads the media in for a post.',
147		- 'metadata' => '(array) Array of metadata objects containing the following properties: `key` (metadata key), `id` (meta ID), `previous_value` (if set, the action will only occur for the provided previous value), `value` (the new value to set the meta to), `operation` (the operation to perform: `update` or `add`; defaults to `update`). All unprotected meta keys are available by default for read requests. Both unprotected and protected meta keys are available for authenticated requests with proper capabilities. Protected meta keys can be made available with the <code>rest_api_allowed_public_metadata</code> filter.',
	150	+ 'media_urls' => '(array) An array of URLs for images to attach to a post. Sideloads the media in for a post.',
	151	+ 'metadata' => '(array) Array of metadata objects containing the following properties: `key` (metadata key), `id` (meta ID), `previous_value` (if set, the action will only occur for the provided previous value), `value` (the new value to set the meta to), `operation` (the operation to perform: `update` or `add`; defaults to `update`). All unprotected meta keys are available by default for read requests. Both unprotected and protected meta keys are available for authenticated requests with proper capabilities. Protected meta keys can be made available with the <code>rest_api_allowed_public_metadata</code> filter.',
	152	+ 'if_not_modified_since' => '(ISO 8601 datetime) If the post has been modified since this time, the post will not be updated.',
148	153	),
149	154
150	155	'example_request' => 'https://public-api.wordpress.com/rest/v1.2/sites/82974409/posts/881',
151	156
		@@ -163,13 +168,15 @@
163	168	),
164	169	)
165	170	);
166	171
167		-use function \Automattic\Jetpack\Extensions\Map\map_block_from_geo_points;
	172	+use function Automattic\Jetpack\Extensions\Map\map_block_from_geo_points;
168	173
169	174	// phpcs:disable PEAR.NamingConventions.ValidClassName.Invalid
170	175	/**
171	176	* Update post v1.2 endpoint class.
	177	+ *
	178	+ * @phan-constructor-used-for-side-effects
172	179	*/
173	180	class WPCOM_JSON_API_Update_Post_v1_2_Endpoint extends WPCOM_JSON_API_Update_Post_v1_1_Endpoint {
174	181	/**
175	182	* Create or update a post.
		@@ -181,8 +188,10 @@
181	188	* @param int $blog_id Blog ID.
182	189	* @param int $post_id Post ID.
183	190	*/
184	191	public function write_post( $path, $blog_id, $post_id ) {
	192	+ $delete_featured_image = null;
	193	+ $media_results = array();
185	194	global $wpdb;
186	195
187	196	$new = $this->api->ends_with( $path, '/new' );
188	197	$args = $this->query_args();
		@@ -192,10 +201,9 @@
192	201	}
193	202
194	203	// unhook publicize, it's hooked again later -- without this, skipping services is impossible.
195	204	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
196		- remove_action( 'save_post', array( $GLOBALS['publicize_ui']->publicize, 'async_publicize_post' ), 100, 2 );
197		- add_action( 'rest_api_inserted_post', array( $GLOBALS['publicize_ui']->publicize, 'async_publicize_post' ) );
	205	+ remove_action( 'save_post', array( $GLOBALS['publicize_ui']->publicize, 'async_publicize_post' ), 100 );
198	206
199	207	if ( $this->should_load_theme_functions( $post_id ) ) {
200	208	$this->load_theme_functions();
201	209	}
		@@ -255,8 +263,13 @@
255	263	if ( ! is_array( $input ) || ! $input ) {
256	264	return new WP_Error( 'invalid_input', 'Invalid request input', 400 );
257	265	}
258	266
	267	+ $post = get_post( $post_id );
	268	+ if ( ! $post || is_wp_error( $post ) ) {
	269	+ return new WP_Error( 'unknown_post', 'Unknown post', 404 );
	270	+ }
	271	+
259	272	if ( isset( $input['status'] ) && 'trash' === $input['status'] && ! current_user_can( 'delete_post', $post_id ) ) {
260	273	return new WP_Error( 'unauthorized', 'User cannot delete post', 403 );
261	274	}
262	275
		@@ -264,13 +277,8 @@
264	277	if ( isset( $input['status'] ) && 'future' === $input['status'] ) {
265	278	$input['status'] = 'publish';
266	279	}
267	280
268		- $post = get_post( $post_id );
269		- if ( ! $post || is_wp_error( $post ) ) {
270		- return new WP_Error( 'unknown_post', 'Unknown post', 404 );
271		- }
272		-
273	281	$_post_type = ( ! empty( $input['type'] ) ) ? $input['type'] : $post->post_type;
274	282	$post_type = get_post_type_object( $_post_type );
275	283
276	284	if ( ! current_user_can( 'edit_post', $post->ID ) ) {
		@@ -275,8 +283,14 @@
275	283
276	284	if ( ! current_user_can( 'edit_post', $post->ID ) ) {
277	285	return new WP_Error( 'unauthorized', 'User cannot edit post', 403 );
278	286	}
	287	+ // The input `if_not_modified_since` input is the format ISO 8601 datetime and get converted to `if_not_modified_since_gmt` and `if_not_modified_since`
	288	+ if ( ! empty( $input['if_not_modified_since_gmt'] ) ) {
	289	+ if ( mysql2date( 'U', $post->post_modified_gmt ) > mysql2date( 'U', $input['if_not_modified_since_gmt'] ) ) {
	290	+ return new WP_Error( 'old-revision', 'There is a revision of this post that is more recent.', 409 );
	291	+ }
	292	+ }
279	293
280	294	if ( ! empty( $input['author'] ) ) {
281	295	$author_id = parent::parse_and_set_author( $input['author'], $_post_type );
282	296	unset( $input['author'] );
		@@ -288,9 +302,9 @@
288	302	if ( ( isset( $input['status'] ) && 'publish' === $input['status'] ) && 'publish' !== $post->post_status && ! current_user_can( 'publish_post', $post->ID ) ) {
289	303	$input['status'] = 'pending';
290	304	}
291	305	$last_status = $post->post_status;
292		- $new_status = isset( $input['status'] ) ? $input['status'] : $last_status;
	306	+ $new_status = $input['status'] ?? $last_status;
293	307
294	308	// Make sure that drafts get the current date when transitioning to publish if not supplied in the post.
295	309	// Similarly, scheduled posts that are manually published before their scheduled date should have the date reset.
296	310	$date_in_past = ( strtotime( $post->post_date_gmt ) < time() );
		@@ -313,11 +327,16 @@
313	327	}
314	328
315	329	// If date is set, $this->input will set date_gmt, date still needs to be adjusted.
316	330	if ( isset( $input['date_gmt'] ) ) {
317		- $gmt_offset = get_option( 'gmt_offset' );
318		- $time_with_offset = strtotime( $input['date_gmt'] ) + $gmt_offset * HOUR_IN_SECONDS;
319		- $input['date'] = gmdate( 'Y-m-d H:i:s', $time_with_offset );
	331	+ $date_gmt_timestamp = strtotime( $input['date_gmt'] );
	332	+ if ( $date_gmt_timestamp ) {
	333	+ $gmt_offset = (int) get_option( 'gmt_offset' );
	334	+ $time_with_offset = $date_gmt_timestamp + $gmt_offset * HOUR_IN_SECONDS;
	335	+ $input['date'] = gmdate( 'Y-m-d H:i:s', $time_with_offset );
	336	+ } else { // Invalid input.
	337	+ unset( $input['date_gmt'] );
	338	+ }
320	339	}
321	340
322	341	if ( ! empty( $author_id ) && get_current_user_id() !== $author_id ) {
323	342	if ( ! current_user_can( $post_type->cap->edit_others_posts ) ) {
		@@ -488,12 +507,12 @@
488	507	$insert['menu_order'] = $input['menu_order'];
489	508	unset( $input['menu_order'] );
490	509	}
491	510
492		- $publicize = isset( $input['publicize'] ) ? $input['publicize'] : null;
	511	+ $publicize = $input['publicize'] ?? null;
493	512	unset( $input['publicize'] );
494	513
495		- $publicize_custom_message = isset( $input['publicize_message'] ) ? $input['publicize_message'] : null;
	514	+ $publicize_custom_message = $input['publicize_message'] ?? null;
496	515	unset( $input['publicize_message'] );
497	516
498	517	if ( isset( $input['featured_image'] ) ) {
499	518	$featured_image = trim( $input['featured_image'] );
		@@ -500,18 +519,18 @@
500	519	$delete_featured_image = empty( $featured_image );
501	520	unset( $input['featured_image'] );
502	521	}
503	522
504		- $metadata = isset( $input['metadata'] ) ? $input['metadata'] : null;
	523	+ $metadata = $input['metadata'] ?? null;
505	524	unset( $input['metadata'] );
506	525
507		- $likes = isset( $input['likes_enabled'] ) ? $input['likes_enabled'] : null;
	526	+ $likes = $input['likes_enabled'] ?? null;
508	527	unset( $input['likes_enabled'] );
509	528
510		- $sharing = isset( $input['sharing_enabled'] ) ? $input['sharing_enabled'] : null;
	529	+ $sharing = $input['sharing_enabled'] ?? null;
511	530	unset( $input['sharing_enabled'] );
512	531
513		- $sticky = isset( $input['sticky'] ) ? $input['sticky'] : null;
	532	+ $sticky = $input['sticky'] ?? null;
514	533	unset( $input['sticky'] );
515	534
516	535	foreach ( $input as $key => $value ) {
517	536	$insert[ "post_$key" ] = $value;
		@@ -526,16 +545,19 @@
526	545	}
527	546
528	547	$has_media = ! empty( $input['media'] ) ? count( $input['media'] ) : false;
529	548	$has_media_by_url = ! empty( $input['media_urls'] ) ? count( $input['media_urls'] ) : false;
	549	+ $media_files = array();
	550	+ $media_urls = array();
	551	+ $media_attrs = array();
	552	+ $media_id_string = '';
530	553
531		- $media_id_string = '';
532	554	if ( $has_media || $has_media_by_url ) {
533	555	$media_files = ! empty( $input['media'] ) ? $input['media'] : array();
534	556	$media_urls = ! empty( $input['media_urls'] ) ? $input['media_urls'] : array();
535	557	$media_attrs = ! empty( $input['media_attrs'] ) ? $input['media_attrs'] : array();
536	558	$media_results = $this->handle_media_creation_v1_1( $media_files, $media_urls, $media_attrs );
537		- $media_id_string = join( ',', array_filter( array_map( 'absint', $media_results['media_ids'] ) ) );
	559	+ $media_id_string = implode( ',', array_filter( array_map( 'absint', $media_results['media_ids'] ) ) );
538	560	}
539	561
540	562	$is_dtp_fb_post = false;
541	563	if ( in_array( '_dtp_fb', wp_list_pluck( (array) $metadata, 'key' ), true ) ) {
		@@ -542,8 +564,28 @@
542	564	$is_dtp_fb_post = true;
543	565	add_filter( 'rest_api_allowed_public_metadata', array( $this, 'dtp_fb_allowed_metadata' ) );
544	566	}
545	567
	568	+ /**
	569	+ * Log Media details for a Post creation request.
	570	+ * Temporary logging for media data.
	571	+ *
	572	+ * @see p1709028174665519-slack-CDLH4C1UZ
	573	+ *
	574	+ * @since 13.2
	575	+ *
	576	+ * @param bool $is_dtp_fb_post Is this for a Facebook import?
	577	+ * @param int $blog_id Blog ID.
	578	+ * @param array $input Whole input.
	579	+ * @param array $media_files File upload data.
	580	+ * @param array $media_urls URLs to fetch.
	581	+ * @param array $media_attrs Attributes corresponding to each entry in `$media_files`/`$media_urls`.
	582	+ * @param array $media_results
	583	+ * - media_ids: IDs created, by index in `$media_files`/`$media_urls`.
	584	+ * - errors: Errors encountered, by index in `$media_files`/`$media_urls`.
	585	+ */
	586	+ do_action( 'jetpack_dtp_fb_media', $is_dtp_fb_post, $blog_id, $input, $media_files, $media_urls, $media_attrs, $media_results );
	587	+
546	588	if ( $new ) {
547	589	if ( isset( $input['content'] ) && ! has_shortcode( $input['content'], 'gallery' ) && ( $has_media || $has_media_by_url ) ) {
548	590	switch ( ( $has_media + $has_media_by_url ) ) {
549	591	case 0:
		@@ -567,9 +609,9 @@
567	609	break;
568	610	}
569	611	}
570	612
571		- $insert['post_date'] = isset( $insert['post_date'] ) ? $insert['post_date'] : '';
	613	+ $insert['post_date'] ??= '';
572	614
573	615	if ( $is_dtp_fb_post ) {
574	616	$insert = $this->dtp_fb_preprocess_post( $insert, $metadata );
575	617	}
		@@ -578,8 +620,9 @@
578	620	if ( 0 === $post_id ) {
579	621	$post_id = wp_insert_post( add_magic_quotes( $insert ), true );
580	622	}
581	623	} else {
	624	+ // @phan-suppress-next-line PhanPossiblyUndeclaredVariable -- $post is set and validated several blocks earlier if $new (only set once) is falsy.
582	625	$insert['ID'] = $post->ID;
583	626
584	627	// wp_update_post ignores date unless edit_date is set
585	628	// See: https://codex.wordpress.org/Function_Reference/wp_update_post#Scheduling_posts
		@@ -664,9 +707,9 @@
664	707
665	708	// Set sharing status of the post.
666	709	if ( $new ) {
667	710	$sharing_enabled = isset( $sharing ) ? (bool) $sharing : true;
668		- if ( false === $sharing_enabled ) {
	711	+ if ( ! $sharing_enabled ) {
669	712	update_post_meta( $post_id, 'sharing_disabled', 1 );
670	713	}
671	714	} elseif ( isset( $sharing ) && true === $sharing ) {
672	715	delete_post_meta( $post_id, 'sharing_disabled' );
		@@ -725,14 +768,14 @@
725	768	* * associative are to pass specific connections per service
726	769	*
727	770	* We do support mixed arrays: mixed integer and string keys (see 3rd example below).
728	771	*
729		- * EG: array( 'twitter', 'facebook') will only publicize to those, ignoring the other available services
730		- * Form data: publicize[]=twitter&publicize[]=facebook
731		- * EG: array( 'twitter' => '(int) $pub_conn_id_0, (int) $pub_conn_id_3', 'facebook' => (int) $pub_conn_id_7 ) will publicize to two Twitter accounts, and one Facebook connection, of potentially many.
732		- * Form data: publicize[twitter]=$pub_conn_id_0,$pub_conn_id_3&publicize[facebook]=$pub_conn_id_7
733		- * EG: array( 'twitter', 'facebook' => '(int) $pub_conn_id_0, (int) $pub_conn_id_3' ) will publicize to all available Twitter accounts, but only 2 of potentially many Facebook connections
734		- * Form data: publicize[]=twitter&publicize[facebook]=$pub_conn_id_0,$pub_conn_id_3
	772	+ * EG: array( 'linkedin', 'facebook') will only publicize to those, ignoring the other available services
	773	+ * Form data: publicize[]=linkedin&publicize[]=facebook
	774	+ * EG: array( 'linkedin' => '(int) $pub_conn_id_0, (int) $pub_conn_id_3', 'facebook' => (int) $pub_conn_id_7 ) will publicize to two LinkedIn accounts, and one Facebook connection, of potentially many.
	775	+ * Form data: publicize[linkedin]=$pub_conn_id_0,$pub_conn_id_3&publicize[facebook]=$pub_conn_id_7
	776	+ * EG: array( 'linkedin', 'facebook' => '(int) $pub_conn_id_0, (int) $pub_conn_id_3' ) will publicize to all available LinkedIn accounts, but only 2 of potentially many Facebook connections
	777	+ * Form data: publicize[]=linkedin&publicize[facebook]=$pub_conn_id_0,$pub_conn_id_3
735	778	*/
736	779
737	780	// Delete any stale SKIP value for the service by name. We'll add it back by ID.
738	781	delete_post_meta( $post_id, $GLOBALS['publicize_ui']->publicize->POST_SKIP . $name );
		@@ -923,9 +966,9 @@
923	966	*/
924	967	protected function should_load_theme_functions( $post_id = null ) {
925	968	if ( empty( $post_id ) ) {
926	969	$input = $this->input( true );
927		- $type = $input['type'];
	970	+ $type = $input['type'] ?? null;
928	971	} else {
929	972	$type = get_post_type( $post_id );
930	973	}
931	974
		@@ -969,8 +1012,11 @@
969	1012	'latitude' => $fb_point['latitude'],
970	1013	),
971	1014	'title' => $fb_point['name'],
972	1015	);
	1016	+ }
	1017	+ if ( ! function_exists( 'map_block_from_geo_points' ) ) {
	1018	+ require_once JETPACK__PLUGIN_DIR . 'extensions/blocks/map/map.php';
973	1019	}
974	1020	$map_block = map_block_from_geo_points( $geo_points );
975	1021
976	1022	$post['post_content'] = $map_block . $post['post_content'];