summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYury German <blueknight@gentoo.org>2022-06-15 12:08:35 -0400
committerYury German <blueknight@gentoo.org>2022-06-15 12:08:35 -0400
commit36d7691c33cb64ece817246e47a779ec648d10b0 (patch)
tree08f2fb95303a1d8eeba2c8629a24b35a91fb1cac /plugins/jetpack/json-endpoints/class.wpcom-json-api-add-widget-endpoint.php
parenttwentyfourteen upg 2.7 to 3.2 and twentysixteen from 2.0 to 2.5 (diff)
downloadblogs-gentoo-36d7691c33cb64ece817246e47a779ec648d10b0.tar.gz
blogs-gentoo-36d7691c33cb64ece817246e47a779ec648d10b0.tar.bz2
blogs-gentoo-36d7691c33cb64ece817246e47a779ec648d10b0.zip
Openid-3.6.1 and jetpack-11.0 upgrade
Signed-off-by: Yury German <blueknight@gentoo.org>
Diffstat (limited to 'plugins/jetpack/json-endpoints/class.wpcom-json-api-add-widget-endpoint.php')
-rw-r--r--plugins/jetpack/json-endpoints/class.wpcom-json-api-add-widget-endpoint.php90
1 files changed, 47 insertions, 43 deletions
diff --git a/plugins/jetpack/json-endpoints/class.wpcom-json-api-add-widget-endpoint.php b/plugins/jetpack/json-endpoints/class.wpcom-json-api-add-widget-endpoint.php
index 2c1a7eeb..c0fab26e 100644
--- a/plugins/jetpack/json-endpoints/class.wpcom-json-api-add-widget-endpoint.php
+++ b/plugins/jetpack/json-endpoints/class.wpcom-json-api-add-widget-endpoint.php
@@ -1,45 +1,46 @@
-<?php
+<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/**
* Activate a widget on a site.
*
- * https://public-api.wordpress.com/rest/v1.1/sites/$site/widgets/new
+ * Endpoint: https://public-api.wordpress.com/rest/v1.1/sites/$site/widgets/new
*/
-new WPCOM_JSON_API_Add_Widgets_Endpoint( array (
- 'description' => 'Activate a widget on a site.',
- 'group' => 'sites',
- 'stat' => 'widgets:new',
- 'method' => 'POST',
- 'min_version' => '1.1',
- 'path' => '/sites/%s/widgets/new',
- 'path_labels' => array(
- '$site' => '(string) Site ID or domain.'
- ),
- 'request_format' => array(
- 'id_base' => '(string) The base ID of the widget.',
- 'sidebar' => '(string) Optional. The ID of the sidebar where this widget will be active. If empty, the widget will be added in the first sidebar available.',
- 'position' => '(int) Optional. The position of the widget in the sidebar.',
- 'settings' => '(object) Optional. The settings for the new widget.',
- ),
- 'response_format' => array(
- 'id' => '(string) The actual ID of the widget.',
- 'sidebar' => '(string) The ID of the sidebar where this widget will be active.',
- 'position' => '(int) The final position of the widget in the sidebar.',
- 'settings' => '(array) The settings for the new widget.',
- ),
- 'example_request' => 'https://public-api.wordpress.com/rest/v1.1/sites/12345678/widgets/new',
- 'example_request_data' => array(
- 'headers' => array(
- 'authorization' => 'Bearer YOUR_API_TOKEN'
+new WPCOM_JSON_API_Add_Widgets_Endpoint(
+ array(
+ 'description' => 'Activate a widget on a site.',
+ 'group' => 'sites',
+ 'stat' => 'widgets:new',
+ 'method' => 'POST',
+ 'min_version' => '1.1',
+ 'path' => '/sites/%s/widgets/new',
+ 'path_labels' => array(
+ '$site' => '(string) Site ID or domain.',
),
- 'body' => array(
- 'id_base' => 'text',
- 'sidebar' => 'sidebar-2',
- 'position' => '0',
- 'settings' => array( 'title' => 'hello world' ),
- )
- ),
- 'example_response' => '
+ 'request_format' => array(
+ 'id_base' => '(string) The base ID of the widget.',
+ 'sidebar' => '(string) Optional. The ID of the sidebar where this widget will be active. If empty, the widget will be added in the first sidebar available.',
+ 'position' => '(int) Optional. The position of the widget in the sidebar.',
+ 'settings' => '(object) Optional. The settings for the new widget.',
+ ),
+ 'response_format' => array(
+ 'id' => '(string) The actual ID of the widget.',
+ 'sidebar' => '(string) The ID of the sidebar where this widget will be active.',
+ 'position' => '(int) The final position of the widget in the sidebar.',
+ 'settings' => '(array) The settings for the new widget.',
+ ),
+ 'example_request' => 'https://public-api.wordpress.com/rest/v1.1/sites/12345678/widgets/new',
+ 'example_request_data' => array(
+ 'headers' => array(
+ 'authorization' => 'Bearer YOUR_API_TOKEN',
+ ),
+ 'body' => array(
+ 'id_base' => 'text',
+ 'sidebar' => 'sidebar-2',
+ 'position' => '0',
+ 'settings' => array( 'title' => 'hello world' ),
+ ),
+ ),
+ 'example_response' => '
{
"id": "text-3",
"id_base": "text",
@@ -48,22 +49,25 @@ new WPCOM_JSON_API_Add_Widgets_Endpoint( array (
},
"sidebar": "sidebar-2",
"position": 0
- }'
-) );
-
+ }',
+ )
+);
+/**
+ * The Add Widgets endpoint class.
+ */
class WPCOM_JSON_API_Add_Widgets_Endpoint extends WPCOM_JSON_API_Endpoint {
/**
* API callback.
*
- * @param string $path
- * @param int $blog_id
+ * @param string $path - the path.
+ * @param int $blog_id - the blog ID.
* @uses jetpack_require_lib
* @uses Jetpack_Widgets
*
* @return array|WP_Error
*/
- function callback( $path = '', $blog_id = 0 ) {
+ public function callback( $path = '', $blog_id = 0 ) {
// Switch to the given blog.
$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
if ( is_wp_error( $blog_id ) ) {
@@ -75,7 +79,7 @@ class WPCOM_JSON_API_Add_Widgets_Endpoint extends WPCOM_JSON_API_Endpoint {
}
jetpack_require_lib( 'widgets' );
- $args = $this->input( false, false ); // Don't filter the input
+ $args = $this->input( false, false ); // Don't filter the input.
if ( empty( $args ) || ! is_array( $args ) ) {
return new WP_Error( 'no_data', 'No data was provided.', 400 );
}