Index: src/wp-includes/rest-api/endpoints/class-wp-rest-sites-controller.php =================================================================== --- src/wp-includes/rest-api/endpoints/class-wp-rest-sites-controller.php (nonexistent) +++ src/wp-includes/rest-api/endpoints/class-wp-rest-sites-controller.php (working copy) @@ -0,0 +1,990 @@ +namespace = 'wp/v2'; + $this->rest_base = 'sites'; + + $this->meta = new WP_REST_Site_Meta_Fields(); + } + + /** + * Registers the routes for the objects of the controller. + * + * @since 4.9.0 + */ + public function register_routes() { + + register_rest_route( $this->namespace, '/' . $this->rest_base, array( + array( + 'methods' => WP_REST_Server::READABLE, + 'callback' => array( $this, 'get_items' ), + 'permission_callback' => array( $this, 'get_items_permissions_check' ), + 'args' => $this->get_collection_params(), + ), + array( + 'methods' => WP_REST_Server::CREATABLE, + 'callback' => array( $this, 'create_item' ), + 'permission_callback' => array( $this, 'create_item_permissions_check' ), + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), + ), + 'schema' => array( $this, 'get_public_item_schema' ), + ) ); + + register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P[\d]+)', array( + 'args' => array( + 'id' => array( + 'description' => __( 'Unique identifier for the object.' ), + 'type' => 'integer', + ), + ), + array( + 'methods' => WP_REST_Server::READABLE, + 'callback' => array( $this, 'get_item' ), + 'permission_callback' => array( $this, 'get_item_permissions_check' ), + 'args' => array( + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), + 'password' => array( + 'description' => __( 'The password for the parent post of the site (if the post is password protected).' ), + 'type' => 'string', + ), + ), + ), + array( + 'methods' => WP_REST_Server::EDITABLE, + 'callback' => array( $this, 'update_item' ), + 'permission_callback' => array( $this, 'update_item_permissions_check' ), + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), + ), + array( + 'methods' => WP_REST_Server::DELETABLE, + 'callback' => array( $this, 'delete_item' ), + 'permission_callback' => array( $this, 'delete_item_permissions_check' ), + 'args' => array( + 'force' => array( + 'type' => 'boolean', + 'default' => false, + 'description' => __( 'Whether to bypass trash and force deletion.' ), + ), + 'password' => array( + 'description' => __( 'The password for the parent post of the site (if the post is password protected).' ), + 'type' => 'string', + ), + ), + ), + 'schema' => array( $this, 'get_public_item_schema' ), + ) ); + } + + /** + * Checks if a given request has access to read sites. + * + * @since 4.9.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|bool True if the request has read access, error object otherwise. + */ + public function get_items_permissions_check( $request ) { + + if ( ! empty( $request['context'] ) && 'edit' === $request['context'] && ! current_user_can( 'manage_sites' ) ) { + return new WP_Error( 'rest_forbidden_context', __( 'Sorry, you are not allowed to edit sites.' ), array( 'status' => rest_authorization_required_code() ) ); + } + + + return true; + } + + /** + * Retrieves a list of site items. + * + * @since 4.9.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|WP_REST_Response Response object on success, or error object on failure. + */ + public function get_items( $request ) { + + // Retrieve the list of registered collection query parameters. + $registered = $this->get_collection_params(); + + /* + * This array defines mappings between public API query parameters whose + * values are accepted as-passed, and their internal WP_Query parameter + * name equivalents (some are the same). Only values which are also + * present in $registered will be set. + */ + $parameter_mappings = array( + 'domain' => 'domain__in', + 'domain_exclude' => 'domain__not_in', + 'exclude' => 'site__not_in', + 'include' => 'site__in', + 'offset' => 'offset', + 'order' => 'order', + 'network' => 'network__in', + 'network_exclude' => 'network__not_in', + 'per_page' => 'number', + 'path' => 'path__in', + 'path_exclude' => 'path__not_in', + 'search' => 'search', + 'public' => 'public', + 'archived' => 'archived', + 'mature' => 'mature', + 'spam' => 'spam', + 'deleted' => 'deleted', + 'lang_id' => 'lang__in', + 'lang_id_exclude' => 'lang__not_in', + ); + + $prepared_args = array(); + + /* + * For each known parameter which is both registered and present in the request, + * set the parameter's value on the query $prepared_args. + */ + foreach ( $parameter_mappings as $api_param => $wp_param ) { + if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) { + $prepared_args[ $wp_param ] = $request[ $api_param ]; + } + } + + + // Ensure certain parameter values default to empty strings. + foreach ( + array( + 'search', + 'domain', + 'domain_exclude', + 'lang_id', + 'lang_id_exclude', + 'path', + 'path_exclude' + ) as $param + ) { + if ( ! isset( $prepared_args[ $param ] ) ) { + $prepared_args[ $param ] = ''; + } + } + + if ( isset( $registered['orderby'] ) ) { + $prepared_args['orderby'] = $request['orderby'] ; + } + + $prepared_args['no_found_rows'] = false; + + $prepared_args['date_query'] = array(); + + // Set before into date query. Date query must be specified as an array of an array. + if ( isset( $registered['before'], $request['before'] ) ) { + $prepared_args['date_query'][0]['before'] = $request['before']; + } + + // Set after into date query. Date query must be specified as an array of an array. + if ( isset( $registered['after'], $request['after'] ) ) { + $prepared_args['date_query'][0]['after'] = $request['after']; + } + + if ( isset( $registered['page'] ) && empty( $request['offset'] ) ) { + $prepared_args['offset'] = $prepared_args['number'] * ( absint( $request['page'] ) - 1 ); + } + + /** + * Filters arguments, before passing to WP_Site_Query, when querying sites via the REST API. + * + * @since 4.9.0 + * + * @link https://developer.wordpress.org/reference/classes/wp_site_query/ + * + * @param array $prepared_args Array of arguments for WP_Site_Query. + * @param WP_REST_Request $request The current request. + */ + $prepared_args = apply_filters( 'rest_site_query', $prepared_args, $request ); + + $query = new WP_Site_Query; + $query_result = $query->query( $prepared_args ); + + $sites = array(); + + foreach ( $query_result as $site ) { + if ( ! $this->check_read_permission( $site, $request ) ) { + continue; + } + + $data = $this->prepare_item_for_response( $site, $request ); + $sites[] = $this->prepare_response_for_collection( $data ); + } + + $total_sites = (int) $query->found_sites; + $max_pages = (int) $query->max_num_pages; + + if ( $total_sites < 1 ) { + // Out-of-bounds, run the query again without LIMIT for total count. + unset( $prepared_args['number'], $prepared_args['offset'] ); + + $query = new WP_Site_Query; + $prepared_args['count'] = true; + + $total_sites = $query->query( $prepared_args ); + $max_pages = ceil( $total_sites / $request['per_page'] ); + } + + $response = rest_ensure_response( $sites ); + $response->header( 'X-WP-Total', $total_sites ); + $response->header( 'X-WP-TotalPages', $max_pages ); + + $base = add_query_arg( $request->get_query_params(), rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ) ); + + if ( $request['page'] > 1 ) { + $prev_page = $request['page'] - 1; + + if ( $prev_page > $max_pages ) { + $prev_page = $max_pages; + } + + $prev_link = add_query_arg( 'page', $prev_page, $base ); + $response->link_header( 'prev', $prev_link ); + } + + if ( $max_pages > $request['page'] ) { + $next_page = $request['page'] + 1; + $next_link = add_query_arg( 'page', $next_page, $base ); + + $response->link_header( 'next', $next_link ); + } + + return $response; + } + + /** + * Get the site, if the ID is valid. + * + * @since 4.9.0 + * + * @param int $id Supplied ID. + * @return WP_Site|WP_Error Site object if ID is valid, WP_Error otherwise. + */ + protected function get_site( $id ) { + $error = new WP_Error( 'rest_site_invalid_id', __( 'Invalid site ID.' ), array( 'status' => 404 ) ); + if ( (int) $id <= 0 ) { + return $error; + } + + $id = (int) $id; + $site = get_site( $id ); + if ( empty( $site ) ) { + return $error; + } + + return $site; + } + + /** + * Checks if a given request has access to read the site. + * + * @since 4.9.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|bool True if the request has read access for the item, error object otherwise. + */ + public function get_item_permissions_check( $request ) { + $site = $this->get_site( $request['id'] ); + if ( is_wp_error( $site ) ) { + return $site; + } + + if ( ! empty( $request['context'] ) && 'edit' === $request['context'] && ! current_user_can( 'manage_sites' ) ) { + return new WP_Error( 'rest_forbidden_context', __( 'Sorry, you are not allowed to edit sites.' ), array( 'status' => rest_authorization_required_code() ) ); + } + + return true; + } + + /** + * Retrieves a site. + * + * @since 4.9.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|WP_REST_Response Response object on success, or error object on failure. + */ + public function get_item( $request ) { + $site = $this->get_site( $request['id'] ); + if ( is_wp_error( $site ) ) { + return $site; + } + + $data = $this->prepare_item_for_response( $site, $request ); + $response = rest_ensure_response( $data ); + + return $response; + } + + /** + * Checks if a given request has access to create a site. + * + * @since 4.9.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|bool True if the request has access to create items, error object otherwise. + */ + public function create_item_permissions_check( $request ) { + if ( 0 === get_current_user_id() ) { + return false; + } + + return current_user_can( 'create_sites' ); + } + + /** + * Creates a site. + * + * @since 4.9.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|WP_REST_Response Response object on success, or error object on failure. + */ + public function create_item( $request ) { + + if ( ! empty( $request['id'] ) ) { + return new WP_Error( 'rest_site_exists', __( 'Cannot create existing site.' ), array( 'status' => 400 ) ); + } + + $prepared_site = $this->prepare_item_for_database( $request ); + if ( is_wp_error( $prepared_site ) ) { + return $prepared_site; + } + + /* + * Do not allow a site to be created with missing or empty + * domain + */ + + if ( empty( $prepared_site['domain'] ) ) { + return new WP_Error( 'rest_domain_invalid', __( 'Invalid domain' ), array( 'status' => 400 ) ); + } + + + // Set user data if the user's logged in. + if ( is_user_logged_in() && empty( $prepared_site['user_id'] ) ) { + $user = wp_get_current_user(); + $prepared_site['user_id'] = $user->ID; + } + + /** + * Filters a site before it is inserted via the REST API. + * + * Allows modification of the site right before it is inserted via wpmu_create_blog(). + * Returning a WP_Error value from the filter will shortcircuit insertion and allow + * skipping further processing. + * + * @since 4.9.0 + * @since 4.8.0 $prepared_site can now be a WP_Error to shortcircuit insertion. + * + * @param array|WP_Error $prepared_site The prepared site data for wpmu_create_blog(). + * @param WP_REST_Request $request Request used to insert the site. + */ + $prepared_site = apply_filters( 'rest_pre_insert_site', $prepared_site, $request ); + if ( is_wp_error( $prepared_site ) ) { + return $prepared_site; + } + + $site_id = wpmu_create_blog( $prepared_site['domain'], $prepared_site['path'], $prepared_site['title'], $prepared_site['user_id'], $prepared_site['fields'], $prepared_site['network_id'] ); + + if ( is_wp_error( $site_id ) ) { + return $site_id; + } + + if ( ! $site_id ) { + return new WP_Error( 'rest_site_failed_create', __( 'Creating site failed.' ), array( 'status' => 500 ) ); + } + + $site = get_site( $site_id ); + + /** + * Fires after a site is created or updated via the REST API. + * + * @since 4.9.0 + * + * @param WP_Site $site Inserted or updated site object. + * @param WP_REST_Request $request Request object. + * @param bool $creating True when creating a site, false + * when updating. + */ + do_action( 'rest_insert_site', $site, $request, true ); + + $schema = $this->get_item_schema(); + + if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) { + $meta_update = $this->meta->update_value( $request['meta'], $site_id ); + + if ( is_wp_error( $meta_update ) ) { + return $meta_update; + } + } + + $fields_update = $this->update_additional_fields_for_object( $site, $request ); + + if ( is_wp_error( $fields_update ) ) { + return $fields_update; + } + + $context = current_user_can( 'manage_sites' ) ? 'edit' : 'view'; + + $request->set_param( 'context', $context ); + + $response = $this->prepare_item_for_response( $site, $request ); + $response = rest_ensure_response( $response ); + + $response->set_status( 201 ); + $response->header( 'Location', rest_url( sprintf( '%s/%s/%d', $this->namespace, $this->rest_base, $site_id ) ) ); + + + return $response; + } + + /** + * Checks if a given REST request has access to update a site. + * + * @since 4.9.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|bool True if the request has access to update the item, error object otherwise. + */ + public function update_item_permissions_check( $request ) { + $site = $this->get_site( $request['id'] ); + if ( is_wp_error( $site ) ) { + return $site; + } + + if ( ! $this->check_edit_permission( $site ) ) { + return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this site.' ), array( 'status' => rest_authorization_required_code() ) ); + } + + return true; + } + + /** + * Updates a site. + * + * @since 4.9.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|WP_REST_Response Response object on success, or error object on failure. + */ + public function update_item( $request ) { + $site = $this->get_site( $request['id'] ); + if ( is_wp_error( $site ) ) { + return $site; + } + + $id = $site->blog_id; + + + $prepared_args = $this->prepare_item_for_database( $request ); + + if ( is_wp_error( $prepared_args ) ) { + return $prepared_args; + } + + if ( ! empty( $prepared_args['network'] ) ) { + if ( ! get_network( $prepared_args['network'] ) ) { + return new WP_Error( 'rest_network_id_invalid', __( 'Invalid network ID.' ), array( 'status' => 400 ) ); + } + } + if ( ! empty( $prepared_args['fields'] ) ) { + $meta_fields = array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' ); + foreach ( $meta_fields as $meta_field ) { + if ( isset( $prepared_args['fields'][ $meta_field ] ) ) { + $prepared_args[ $meta_field ] = $prepared_args['fields'][ $meta_field ]; + } + } + unset( $prepared_args['fields'] ); + } + + if ( ! empty( $prepared_args ) ) { + if ( is_wp_error( $prepared_args ) ) { + return $prepared_args; + } + + if ( isset( $prepared_args['domain'] ) && empty( $prepared_args['domain'] ) ) { + return new WP_Error( 'rest_domain_invalid', __( 'Invalid domain.' ), array( 'status' => 400 ) ); + } + + update_blog_details( $id, wp_slash( (array) $prepared_args ) ); + + + } + + $site = get_site( $id ); + + /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-sites-controller.php */ + do_action( 'rest_insert_site', $site, $request, false ); + + $schema = $this->get_item_schema(); + + if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) { + $meta_update = $this->meta->update_value( $request['meta'], $id ); + + if ( is_wp_error( $meta_update ) ) { + return $meta_update; + } + } + + $fields_update = $this->update_additional_fields_for_object( $site, $request ); + + if ( is_wp_error( $fields_update ) ) { + return $fields_update; + } + + $request->set_param( 'context', 'edit' ); + + $response = $this->prepare_item_for_response( $site, $request ); + + return rest_ensure_response( $response ); + } + + /** + * Checks if a given request has access to delete a site. + * + * @since 4.9.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|bool True if the request has access to delete the item, error object otherwise. + */ + public function delete_item_permissions_check( $request ) { + $site = $this->get_site( $request['id'] ); + if ( is_wp_error( $site ) ) { + return $site; + } + + if ( 0 === (int) get_current_user_id() ) { + return false; + } + + if ( ! current_user_can( 'delete_sites' ) ) { + return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete this site.' ), array( 'status' => rest_authorization_required_code() ) ); + } + + return true; + } + + /** + * Deletes a site. + * + * @since 4.9.0 + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|WP_REST_Response Response object on success, or error object on failure. + */ + public function delete_item( $request ) { + $site = $this->get_site( $request['id'] ); + if ( is_wp_error( $site ) ) { + return $site; + } + + $force = isset( $request['force'] ) ? (bool) $request['force'] : false; + + $request->set_param( 'context', 'edit' ); + + + $previous = $this->prepare_item_for_response( $site, $request ); + wpmu_delete_blog( $site->blog_id, $force ); + $result = $this->get_site( $site->blog_id ); + $response = new WP_REST_Response(); + $response->set_data( array( 'deleted' => true, 'previous' => $previous->get_data() ) ); + + + if ( $result ) { + return new WP_Error( 'rest_cannot_delete', __( 'The site cannot be deleted.' ), array( 'status' => 500 ) ); + } + + /** + * Fires after a site is deleted via the REST API. + * + * @since 4.9.0 + * + * @param WP_Site $site The deleted site data. + * @param WP_REST_Response $response The response returned from the API. + * @param WP_REST_Request $request The request sent to the API. + */ + do_action( 'rest_delete_site', $site, $response, $request ); + + return $response; + } + + /** + * Prepares a single site output for response. + * + * @since 4.9.0 + * + * @param WP_Site $site Site object. + * @param WP_REST_Request $request Request object. + * @return WP_REST_Response Response object. + */ + public function prepare_item_for_response( $site, $request ) { + $data = array( + 'id' => (int) $site->blog_id, + 'network' => (int) $site->site_id, + 'domain' => $site->domain, + 'path' => $site->path, + 'registered' => $site->registered, + 'last_updated' => $site->last_updated, + 'public' => (int) $site->public, + 'archived' => (int) $site->archived, + 'mature' => (int) $site->mature, + 'spam' => (int) $site->spam, + 'deleted' => (int) $site->deleted, + 'lang_id' => (int) $site->lang_id, + ); + + $schema = $this->get_item_schema(); + + if ( ! empty( $schema['properties']['meta'] ) ) { + $data['meta'] = $this->meta->get_value( $site->blog_id, $request ); + } + + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; + $data = $this->add_additional_fields_to_object( $data, $request ); + $data = $this->filter_response_by_context( $data, $context ); + + // Wrap the data in a response object. + $response = rest_ensure_response( $data ); + + /** + * Filters a site returned from the API. + * + * Allows modification of the site right before it is returned. + * + * @since 4.9.0 + * + * @param WP_REST_Response $response The response object. + * @param WP_Site $site The original site object. + * @param WP_REST_Request $request Request used to generate the response. + */ + return apply_filters( 'rest_prepare_site', $response, $site, $request ); + } + + /** + * Prepares a single site to be inserted into the database. + * + * @since 4.9.0 + * + * @param WP_REST_Request $request Request object. + * @return array|WP_Error Prepared site, otherwise WP_Error object. + */ + protected function prepare_item_for_database( $request ) { + $prepared_site = array(); + + $meta_fields = array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' ); + foreach ( $meta_fields as $meta_field ) { + $prepared_site['fields'][ $meta_field ] = $request[ $meta_field ]; + } + + $prepared_comment['network'] = 1; + if ( isset( $request['network'] ) ) { + $prepared_site['network_id'] = (int) $request['network']; + } + + if ( isset( $request['user_id'] ) ) { + $prepared_site['user_id'] = (int) $request['user_id']; + } + + if ( empty( $request['path'] ) ) { + $prepared_site['path'] = '/'; + } + + if ( isset( $request['domain'] ) ) { + $prepared_comment['domain'] = $request['domain']; + } + + /** + * Filters a site after it is prepared for the database. + * + * Allows modification of the site right after it is prepared for the database. + * + * @since 4.9.0 + * + * @param array $prepared_site The prepared site data for `wpmu_create_blog`. + * @param WP_REST_Request $request The current request. + */ + return apply_filters( 'rest_preprocess_site', $prepared_site, $request ); + } + + /** + * Retrieves the site's schema, conforming to JSON Schema. + * + * @since 4.9.0 + * + * @return array + */ + public function get_item_schema() { + $schema = array( + '$schema' => 'http://json-schema.org/schema#', + 'title' => 'site', + 'type' => 'object', + 'properties' => array( + 'id' => array( + 'description' => __( 'Unique identifier for the object.' ), + 'type' => 'integer', + 'context' => array( 'view', 'edit', 'embed' ), + 'readonly' => true, + ), + 'network' => array( + 'description' => __( '' ), + 'type' => 'integer', + 'context' => array( 'view', 'edit', 'embed' ), + ), + 'domain' => array( + 'description' => __( '' ), + 'type' => 'string', + 'context' => array( 'view', 'edit', 'embed' ), + ), + 'path' => array( + 'description' => __( '' ), + 'type' => 'string', + 'context' => array( 'view', 'edit', 'embed' ), + ), + 'registered' => array( + 'description' => __( '' ), + 'type' => 'string', + 'format' => 'date-time', + 'context' => array( 'view', 'edit', 'embed' ), + ), + 'last_updated' => array( + 'description' => __( '' ), + 'type' => 'string', + 'format' => 'date-time', + 'context' => array( 'view', 'edit', 'embed' ), + ), + 'public' => array( + 'context' => array( 'view', 'edit', 'embed' ), + 'description' => __( '' ), + 'type' => 'integer', + ), + 'archived' => array( + 'context' => array( 'view', 'edit', 'embed' ), + 'description' => __( '' ), + 'type' => 'integer', + ), + 'mature' => array( + 'context' => array( 'view', 'edit', 'embed' ), + 'description' => __( '' ), + 'type' => 'integer', + ), + 'spam' => array( + 'context' => array( 'view', 'edit', 'embed' ), + 'description' => __( '' ), + 'type' => 'integer', + ), + 'deleted' => array( + 'context' => array( 'view', 'edit', 'embed' ), + 'description' => __( '' ), + 'type' => 'integer', + ), + 'lang_id' => array( + 'context' => array( 'view', 'edit', 'embed' ), + 'description' => __( '' ), + 'type' => 'integer', + ), + + ), + ); + + + $schema['properties']['meta'] = $this->meta->get_field_schema(); + + return $this->add_additional_fields_schema( $schema ); + } + + /** + * Retrieves the query params for collections. + * + * @since 4.9.0 + * + * @return array Sites collection parameters. + */ + public function get_collection_params() { + $query_params = parent::get_collection_params(); + + $query_params['context']['default'] = 'view'; + + + $query_params['domain'] = array( + 'description' => __( 'Limit result set to sites assigned to specific domain. ' ), + 'type' => 'array', + 'items' => array( + 'type' => 'string', + ), + ); + + $query_params['domain_exclude'] = array( + 'description' => __( 'Ensure result set excludes sites assigned to specific domain. ' ), + 'type' => 'array', + 'items' => array( + 'type' => 'string', + ), + ); + + $query_params['path'] = array( + 'description' => __( 'Limit result set to sites assigned to specific path. ' ), + 'type' => 'array', + 'items' => array( + 'type' => 'string', + ), + ); + + $query_params['path_exclude'] = array( + 'description' => __( 'Ensure result set excludes sites assigned to specific path. ' ), + 'type' => 'array', + 'items' => array( + 'type' => 'string', + ), + ); + + $query_params['exclude'] = array( + 'description' => __( 'Ensure result set excludes specific IDs.' ), + 'type' => 'array', + 'items' => array( + 'type' => 'integer', + ), + 'default' => array(), + ); + + $query_params['include'] = array( + 'description' => __( 'Limit result set to specific IDs.' ), + 'type' => 'array', + 'items' => array( + 'type' => 'integer', + ), + 'default' => array(), + ); + + $query_params['offset'] = array( + 'description' => __( 'Offset the result set by a specific number of items.' ), + 'type' => 'integer', + ); + + $query_params['order'] = array( + 'description' => __( 'Order sort attribute ascending or descending.' ), + 'type' => 'string', + 'default' => 'desc', + 'enum' => array( + 'asc', + 'desc', + ), + ); + + $query_params['orderby'] = array( + 'description' => __( 'Sort collection by object attribute.' ), + 'type' => 'string', + 'default' => 'id', + 'enum' => array( + 'id', + 'domain', + 'path', + 'network_id', + 'last_updated', + 'registered', + 'domain_length', + 'path_length', + 'site__in', + 'network__in' + ), + ); + $query_params['network'] = array( + 'default' => array(), + 'description' => __( 'Limit result set to sites of specific network IDs.' ), + 'type' => 'array', + 'items' => array( + 'type' => 'integer', + ), + ); + + $query_params['network_exclude'] = array( + 'default' => array(), + 'description' => __( 'Ensure result set excludes specific network IDs.' ), + 'type' => 'array', + 'items' => array( + 'type' => 'integer', + ), + ); + + + + + /** + * Filter collection parameters for the sites controller. + * + * This filter registers the collection parameter, but does not map the + * collection parameter to an internal WP_Site_Query parameter. Use the + * `rest_site_query` filter to set WP_Site_Query parameters. + * + * @since 4.9.0 + * + * @param array $query_params JSON Schema-formatted collection parameters. + */ + return apply_filters( 'rest_site_collection_params', $query_params ); + } + + /** + * Checks if the site can be read. + * + * @since 4.9.0 + * + * @param WP_Site $site Site object. + * @param WP_REST_Request $request Request data to check. + * @return bool Whether the site can be read. + */ + protected function check_read_permission( $site, $request ) { + + if ( 0 === get_current_user_id() ) { + return false; + } + + return current_user_can( 'manage_sites' ); + } + + /** + * Checks if a site can be edited or deleted. + * + * @since 4.9.0 + * + * @param object $site Site object. + * @return bool Whether the site can be edited or deleted. + */ + protected function check_edit_permission( $site ) { + if ( 0 === (int) get_current_user_id() ) { + return false; + } + + return current_user_can( 'manage_sites' ); + } + +} Property changes on: src/wp-includes/rest-api/endpoints/class-wp-rest-sites-controller.php ___________________________________________________________________ Added: svn:executable ## -0,0 +1 ## +* \ No newline at end of property Index: src/wp-includes/rest-api/fields/class-wp-rest-site-meta-fields.php =================================================================== --- src/wp-includes/rest-api/fields/class-wp-rest-site-meta-fields.php (nonexistent) +++ src/wp-includes/rest-api/fields/class-wp-rest-site-meta-fields.php (working copy) @@ -0,0 +1,40 @@ +register_routes(); + + if ( is_multisite() ) { + // Sites. + $controller = new WP_REST_Sites_Controller; + $controller->register_routes(); + } } /** Index: src/wp-settings.php =================================================================== --- src/wp-settings.php (revision 41340) +++ src/wp-settings.php (working copy) @@ -240,6 +240,11 @@ require( ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-term-meta-fields.php' ); require( ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-user-meta-fields.php' ); +if ( is_multisite() ) { + require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-sites-controller.php' ); + require( ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-site-meta-fields.php' ); +} + $GLOBALS['wp_embed'] = new WP_Embed(); // Load multisite-specific files.