class.wpcom-json-api-update-media-v1-1-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 13.9.2

jetpack / json-endpoints / class.wpcom-json-api-update-media-v1-1-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-update-media-v1-1-endpoint.php

201 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Update media item info v1.1 endpoint.
4	*
5	* Endpoint: v1.1/sites/%s/media/%d
6	*/
7
8	new WPCOM_JSON_API_Update_Media_v1_1_Endpoint(
9	array(
10	'description' => 'Edit basic information about a media item.',
11	'group' => 'media',
12	'stat' => 'media:1:POST',
13	'min_version' => '1.1',
14	'max_version' => '1.1',
15	'method' => 'POST',
16	'path' => '/sites/%s/media/%d',
17	'path_labels' => array(
18	'$site' => '(int\|string) Site ID or domain',
19	'$media_ID' => '(int) The ID of the media item',
20	),
21
22	'request_format' => array(
23	'parent_id' => '(int) ID of the post this media is attached to',
24	'title' => '(string) The file name.',
25	'caption' => '(string) File caption.',
26	'description' => '(HTML) Description of the file.',
27	'alt' => '(string) Alternative text for image files.',
28	'rating' => '(string) Video only. Video rating.',
29	'display_embed' => '(string) Video only. Whether to share or not the video.',
30	'allow_download' => '(string) Video only. Whether the video can be downloaded or not.',
31	'privacy_setting' => '(int) Video only. The privacy level for the video.',
32	'artist' => '(string) Audio Only. Artist metadata for the audio track.',
33	'album' => '(string) Audio Only. Album metadata for the audio track.',
34	),
35
36	'response_format' => array(
37	'ID' => '(int) The ID of the media item',
38	'date' => '(ISO 8601 datetime) The date the media was uploaded',
39	'post_ID' => '(int) ID of the post this media is attached to',
40	'author_ID' => '(int) ID of the user who uploaded the media',
41	'URL' => '(string) URL to the file',
42	'guid' => '(string) Unique identifier',
43	'file' => '(string) File name',
44	'extension' => '(string) File extension',
45	'mime_type' => '(string) File mime type',
46	'title' => '(string) File name',
47	'caption' => '(string) User provided caption of the file',
48	'description' => '(string) Description of the file',
49	'alt' => '(string) Alternative text for image files.',
50	'thumbnails' => '(object) Media item thumbnail URL options',
51	'height' => '(int) (Image & video only) Height of the media item',
52	'width' => '(int) (Image & video only) Width of the media item',
53	'length' => '(int) (Video & audio only) Duration of the media item, in seconds',
54	'exif' => '(array) (Image & audio only) Exif (meta) information about the media item',
55	'rating' => '(string) (Video only) VideoPress rating of the video',
56	'display_embed' => '(string) Video only. Whether to share or not the video.',
57	'allow_download' => '(string) Video only. Whether the video can be downloaded or not.',
58	'privacy_setting' => '(int) Video only. The privacy level for the video.',
59	'videopress_guid' => '(string) (Video only) VideoPress GUID of the video when uploaded on a blog with VideoPress',
60	'videopress_processing_done' => '(bool) (Video only) If the video is uploaded on a blog with VideoPress, this will return the status of processing on the video.',
61	),
62
63	'example_request' => 'https://public-api.wordpress.com/rest/v1.1/sites/82974409/media/446',
64	'example_request_data' => array(
65	'headers' => array(
66	'authorization' => 'Bearer YOUR_API_TOKEN',
67	),
68	'body' => array(
69	'title' => 'Updated Title',
70	),
71	),
72	)
73	);
74
75	// phpcs:disable PEAR.NamingConventions.ValidClassName.Invalid
76	/**
77	* Update media item info v1.1 class.
78	*/
79	class WPCOM_JSON_API_Update_Media_v1_1_Endpoint extends WPCOM_JSON_API_Endpoint {
80	/**
81	* Update media item info API v1.1 callback.
82	*
83	* @param string $path API path.
84	* @param int $blog_id Blog ID.
85	* @param int $media_id Media ID.
86	*
87	* @return object\|WP_Error
88	*/
89	public function callback( $path = '', $blog_id = 0, $media_id = 0 ) {
90	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
91	if ( is_wp_error( $blog_id ) ) {
92	return $blog_id;
93	}
94
95	if ( ! current_user_can( 'upload_files', $media_id ) ) {
96	return new WP_Error( 'unauthorized', 'User cannot view media', 403 );
97	}
98
99	$item = $this->get_media_item_v1_1( $media_id );
100
101	if ( is_wp_error( $item ) ) {
102	return new WP_Error( 'unknown_media', 'Unknown Media', 404 );
103	}
104
105	$input = $this->input( true );
106	$insert = array();
107
108	if ( isset( $input['title'] ) ) {
109	$insert['post_title'] = $input['title'];
110	}
111
112	if ( isset( $input['caption'] ) ) {
113	$insert['post_excerpt'] = $input['caption'];
114	}
115
116	if ( isset( $input['description'] ) ) {
117	$insert['post_content'] = $input['description'];
118	}
119
120	if ( isset( $input['parent_id'] ) ) {
121	$insert['post_parent'] = $input['parent_id'];
122	}
123
124	if ( isset( $input['alt'] ) ) {
125	$alt = wp_strip_all_tags( $input['alt'], true );
126	update_post_meta( $media_id, '_wp_attachment_image_alt', $alt );
127	}
128
129	// audio only artist/album info.
130	if ( str_starts_with( $item->mime_type, 'audio/' ) ) {
131	$changed = false;
132	$id3data = wp_get_attachment_metadata( $media_id );
133
134	if ( ! is_array( $id3data ) ) {
135	$changed = true;
136	$id3data = array();
137	}
138
139	$id3_keys = array(
140	'artist' => __( 'Artist', 'jetpack' ),
141	'album' => __( 'Album', 'jetpack' ),
142	);
143
144	foreach ( $id3_keys as $key => $label ) {
145	if ( isset( $input[ $key ] ) ) {
146	$changed = true;
147	$id3data[ $key ] = wp_strip_all_tags( $input[ $key ], true );
148	}
149	}
150
151	if ( $changed ) {
152	wp_update_attachment_metadata( $media_id, $id3data );
153	}
154	}
155
156	// Pass the item to the handle_video_meta() that checks if it's a VideoPress item and saves it.
157	$result = $this->handle_video_meta( $media_id, $input, $item );
158
159	if ( is_wp_error( $result ) ) {
160	return $result;
161	}
162
163	$insert['ID'] = $media_id;
164	wp_update_post( (object) $insert );
165
166	$item = $this->get_media_item_v1_1( $media_id );
167	return $item;
168	}
169
170	/**
171	* Persist the VideoPress metadata if the given item argument is a VideoPress item.
172	*
173	* @param string $media_id The ID of the video.
174	* @param array $input The request input.
175	* @param stdClass $item The response item.
176	*
177	* @return bool\|WP_Error
178	*/
179	public function handle_video_meta( $media_id, $input, $item ) {
180	if ( ! class_exists( \Videopress_Attachment_Metadata::class ) ) {
181	return false;
182	}
183
184	if ( ! \Videopress_Attachment_Metadata::is_videopress_media( $item ) ) {
185	return false;
186	}
187
188	return \Videopress_Attachment_Metadata::persist_metadata(
189	$media_id,
190	$item->videopress_guid,
191	isset( $input['title'] ) ? $input['title'] : null,
192	isset( $input['caption'] ) ? $input['caption'] : null,
193	isset( $input['description'] ) ? $input['description'] : null,
194	isset( $input['rating'] ) ? $input['rating'] : null,
195	isset( $input['display_embed'] ) ? $input['display_embed'] : null,
196	isset( $input['allow_download'] ) ? $input['allow_download'] : null,
197	isset( $input['privacy_setting'] ) ? $input['privacy_setting'] : null
198	);
199	}
200	}
201