Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Font Library REST API code to align with Core standards #58619

Merged
merged 4 commits into from
Feb 2, 2024
Merged

Update Font Library REST API code to align with Core standards #58619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
de7e018
Remove empty line after @return
getdave Feb 2, 2024
815b088
Fix comment format
getdave Feb 2, 2024
048d0d3
Applying fixes from https://github.com/WordPress/gutenberg/pull/58607
anton-vlasenko Feb 2, 2024
8810a32
Improve readability.
anton-vlasenko Feb 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 17 additions & 24 deletions lib/compat/wordpress-6.5/fonts/class-wp-rest-font-collections-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public function get_items( $request ) {
if ( $page > $max_pages && $total_items > 0 ) {
return new WP_Error(
'rest_post_invalid_page_number',
__( 'The page number requested is larger than the number of pages available.', 'default' ),
__( 'The page number requested is larger than the number of pages available.' ),
array( 'status' => 400 )
);
}
Expand Down Expand Up @@ -148,23 +148,17 @@ public function get_item( $request ) {
return $collection;
}

$item = $this->prepare_item_for_response( $collection, $request );

if ( is_wp_error( $item ) ) {
return $item;
}

return $item;
return $this->prepare_item_for_response( $collection, $request );
}

/*
/**
* Prepare a single collection output for response.
*
* @since 6.5.0
*
* @param WP_Font_Collection $collection Collection object.
* @param WP_REST_Request $request Request object.
* @return array|WP_Error
* @return WP_REST_Response Response object.
*/
public function prepare_item_for_response( $collection, $request ) {
$fields = $this->get_fields_for_response( $request );
Expand Down Expand Up @@ -195,9 +189,9 @@ public function prepare_item_for_response( $collection, $request ) {
*
* @since 6.5.0
*
* @param WP_REST_Response $response The response object.
* @param WP_REST_Response $response The response object.
* @param WP_Font_Collection $collection The Font Collection object.
* @param WP_REST_Request $request Request used to generate the response.
* @param WP_REST_Request $request Request used to generate the response.
*/
return apply_filters( 'rest_prepare_font_collection', $response, $collection, $request );
}
Expand Down Expand Up @@ -262,15 +256,14 @@ public function get_item_schema() {
* @return array Links for the given font collection.
*/
protected function prepare_links( $collection ) {
$links = array(
return array(
'self' => array(
'href' => rest_url( sprintf( '%s/%s/%s', $this->namespace, $this->rest_base, $collection->slug ) ),
),
'collection' => array(
'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
),
);
return $links;
}

/**
Expand Down Expand Up @@ -305,17 +298,17 @@ public function get_collection_params() {
* @return true|WP_Error True if the request has write access for the item, WP_Error object otherwise.
*/
public function get_items_permissions_check( $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable

if ( ! current_user_can( 'edit_theme_options' ) ) {
return new WP_Error(
'rest_cannot_read',
__( 'Sorry, you are not allowed to use the Font Library on this site.', 'gutenberg' ),
array(
'status' => rest_authorization_required_code(),
)
);
if ( current_user_can( 'edit_theme_options' ) ) {
return true;
}
return true;

return new WP_Error(
'rest_cannot_read',
__( 'Sorry, you are not allowed to use the Font Library on this site.', 'gutenberg' ),
array(
'status' => rest_authorization_required_code(),
)
);
}
}
}
10 changes: 4 additions & 6 deletions lib/compat/wordpress-6.5/fonts/class-wp-rest-font-faces-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ public function get_item_permissions_check( $request ) {
*
* @param string $value Encoded JSON string of font face settings.
* @param WP_REST_Request $request Request object.
* @return false|WP_Error True if the settings are valid, otherwise a WP_Error object.
* @return true|WP_Error True if the settings are valid, otherwise a WP_Error object.
*/
public function validate_create_font_face_settings( $value, $request ) {
$settings = json_decode( $value, true );
Expand Down Expand Up @@ -698,7 +698,7 @@ protected function get_parent_font_family_post( $font_family_id ) {
*/
protected function prepare_links( $post ) {
// Entity meta.
$links = array(
return array(
'self' => array(
'href' => rest_url( $this->namespace . '/font-families/' . $post->post_parent . '/font-faces/' . $post->ID ),
),
Expand All @@ -709,8 +709,6 @@ protected function prepare_links( $post ) {
'href' => rest_url( $this->namespace . '/font-families/' . $post->post_parent ),
),
);

return $links;
}

/**
Expand Down Expand Up @@ -788,7 +786,7 @@ public function handle_font_file_upload_error( $file, $message ) {
$status = 500;
$code = 'rest_font_upload_unknown_error';

if ( __( 'Sorry, you are not allowed to upload this file type.', 'default' ) === $message ) {
if ( __( 'Sorry, you are not allowed to upload this file type.' ) === $message ) {
$status = 400;
$code = 'rest_font_upload_invalid_file_type';
}
Expand All @@ -799,7 +797,7 @@ public function handle_font_file_upload_error( $file, $message ) {
/**
* Returns relative path to an uploaded font file.
*
* The path is relative to the current fonts dir.
* The path is relative to the current fonts directory.
*
* @since 6.5.0
* @access private
Expand Down
1 change: 0 additions & 1 deletion lib/compat/wordpress-6.5/fonts/class-wp-rest-font-families-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,6 @@ public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CRE
*
* @param int $font_family_id Font family post ID.
* @return int[] Array of child font face post IDs.
* .
*/
protected function get_font_face_ids( $font_family_id ) {
$query = new WP_Query(
Expand Down
Loading