Skip to content

List custom, core and bundled fonts together in the Font Manager #2015

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

Merged
jakejackson1 merged 1 commit into from
Nov 9, 2026
Merged

List custom, core and bundled fonts together in the Font Manager #2015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
152 changes: 144 additions & 8 deletions src/Controller/Controller_Custom_Fonts.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
use GFPDF\Helper\Helper_Abstract_Options;
use GFPDF\Helper\Helper_Data;
use GFPDF\Model\Model_Custom_Fonts;
use GFPDF\Model\Model_Font_Downloader;
use GFPDF\Model\Model_Required_Fonts;
use GFPDF\Statics\Upload_Size;
use GFPDF_Vendor\GravityPdf\Upload\ErrorCode;
use GFPDF_Vendor\GravityPdf\Upload\Exception as UploadException;
Expand Down Expand Up @@ -113,8 +115,17 @@ public function register_endpoints(): void {
[
[
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'get_all_items' ],
'callback' => [ $this, 'get_scoped_items' ],
'permission_callback' => Closure::fromCallable( [ $this, 'check_permissions' ] ),
'args' => [
'scope' => [
'description' => __( 'Which to return: custom fonts, every font the Font Manager lists, or why fonts are in use', 'gravity-pdf' ),
'type' => 'string',
'enum' => [ 'custom', 'all', 'usage' ],
'default' => 'custom',
'validate_callback' => 'rest_validate_request_arg',
],
],
],

[
Expand All @@ -138,18 +149,25 @@ public function register_endpoints(): void {
'/fonts/(?P<id>[a-z0-9\-]+)',
[
'args' => [
'id' => [
'id' => [
'description' => __( 'Unique identifier for the object.', 'default' ),
'type' => 'string',
'validate_callback' => [ $this->model, 'check_font_id_valid' ],
'required' => true,
],
'scope' => [
'description' => __( 'Whether the ID is a custom font or a downloadable core font. POST installs a core font.', 'gravity-pdf' ),
'type' => 'string',
'enum' => [ 'custom', 'core' ],
'default' => 'custom',
'validate_callback' => 'rest_validate_request_arg',
],
],

[
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'update_item' ],
'permission_callback' => Closure::fromCallable( [ $this, 'check_permissions' ] ),
'callback' => [ $this, 'update_or_install_item' ],
'permission_callback' => Closure::fromCallable( [ $this, 'check_item_permissions' ] ),
'args' => [
'label' => [
'description' => __( 'The font label used for the object', 'gravity-pdf' ),
Expand Down Expand Up @@ -185,8 +203,8 @@ public function register_endpoints(): void {

[
'methods' => WP_REST_Server::DELETABLE,
'callback' => [ $this, 'delete_item' ],
'permission_callback' => Closure::fromCallable( [ $this, 'check_permissions' ] ),
'callback' => [ $this, 'delete_scoped_item' ],
'permission_callback' => Closure::fromCallable( [ $this, 'check_item_permissions' ] ),
],
]
);
Expand All @@ -210,6 +228,44 @@ public function get_all_items(): array {
return array_values( $this->model->get_custom_fonts() );
}

/**
* The fonts route's `scope`. Usage is separate from the list as it walks every form, and on Multisite every site.
*
* @return array|object|WP_Error Usage is an object, so none in use is still a JSON map
*
* @since 6.19.0
*/
public function get_scoped_items( WP_REST_Request $request ) {
$scope = $request->get_param( 'scope' );
if ( $scope === 'custom' ) {
return $this->get_all_items();
}

$downloader = $this->get_downloader();
if ( ! $downloader instanceof Model_Font_Downloader ) {
return $downloader;
}

return $scope === 'all' ? $downloader->get_installed_fonts() : (object) $downloader->get_font_usage();
}

/**
* The font route's POST: an update, or with the `core` scope an install
*
* @return array|WP_Error
*
* @since 6.19.0
*/
public function update_or_install_item( WP_REST_Request $request ) {
if ( $request->get_param( 'scope' ) !== 'core' ) {
return $this->update_item( $request );
}

$downloader = $this->get_downloader();

return $downloader instanceof Model_Font_Downloader ? $downloader->install_font( (string) $request->get_param( 'id' ) ) : $downloader;
}

/**
* Our `Create` CRUD for custom fonts
*
Expand Down Expand Up @@ -258,7 +314,7 @@ public function add_item( WP_REST_Request $request ) {

FlushCache::flush( $font['id'] );

return $font;
return $this->get_font_row( $font );
} catch ( UploadException $e ) {
$message = $e->getMessage()[0] === '{' ? json_decode( $e->getMessage(), true ) : $e->getMessage();
return new WP_Error( 'font_validation_error', $message, [ 'status' => 400 ] );
Expand Down Expand Up @@ -377,7 +433,7 @@ public function update_item( WP_REST_Request $request ) {

FlushCache::flush( $font['id'] );

return $font;
return $this->get_font_row( $font );
} catch ( UploadException $e ) {
$message = $e->getMessage()[0] === '{' ? json_decode( $e->getMessage(), true ) : $e->getMessage();
return new WP_Error( 'font_validation_error', $message, [ 'status' => 400 ] );
Expand All @@ -402,6 +458,86 @@ public function update_item( WP_REST_Request $request ) {
}
}

/**
* A saved font as the Font Manager lists it
*
* @since 6.19.0
*/
protected function get_font_row( array $font ): array {
$downloader = $this->get_downloader();

return $downloader instanceof Model_Font_Downloader ? $downloader->get_custom_font_row( $font ) : $font;
}

/**
* The downloader, unless an add-on has unhooked it
*
* @return Model_Font_Downloader|WP_Error
*
* @since 6.19.0
*/
protected function get_downloader() {
$downloader = GPDFAPI::get_mvc_class( 'Model_Font_Downloader' );

return $downloader instanceof Model_Font_Downloader ? $downloader : new WP_Error( 'invalid_model', '', [ 'status' => 500 ] );
}

/**
* Changing a core font also needs the rights over the fonts folder a Multisite shares
*
* @since 6.19.0
*/
protected function check_item_permissions( WP_REST_Request $request ): bool {
if ( ! $this->check_permissions() ) {
return false;
}

if ( $request->get_param( 'scope' ) !== 'core' ) {
return true;
}

$downloader = $this->get_downloader();

return $downloader instanceof Model_Font_Downloader && $downloader->can_change_core_fonts();
}

/**
* The font route's DELETE: of a custom font, or with the `core` scope a core font
*
* @return array|void|WP_Error
*
* @since 6.19.0
*/
public function delete_scoped_item( WP_REST_Request $request ) {
if ( $request->get_param( 'scope' ) !== 'core' ) {
return $this->delete_unused_item( $request );
}

$downloader = $this->get_downloader();

return $downloader instanceof Model_Font_Downloader ? $downloader->delete_downloaded_font( (string) $request->get_param( 'id' ) ) : $downloader;
}

/**
* Delete a custom font, refusing one in use. delete_item() doesn't, as the upgrade to 6.19 removes records whose fonts a
* source now serves, which stay in use.
*
* @return void|WP_Error
*
* @since 6.19.0
*/
public function delete_unused_item( WP_REST_Request $request ) {
$id = $request->get_param( 'id' );

$required_fonts = GPDFAPI::get_mvc_class( 'Model_Required_Fonts' );

if ( $this->model->matches_custom_font_id( $id ) && $required_fonts instanceof Model_Required_Fonts && $required_fonts->is_font_in_use( $id ) ) {
return new WP_Error( 'font_in_use', __( 'The font is in use, so it can\'t be deleted.', 'gravity-pdf' ), [ 'status' => 409 ] );
}

return $this->delete_item( $request );
}

/**
* @param WP_REST_Request $request
*
Expand Down
76 changes: 63 additions & 13 deletions src/Helper/Helper_Data.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
* @property string $template_location The current path to the PDF working directory
* @property string $template_location_url The current URL to the PDF working directory
* @property string $template_font_location The current path to the PDF font directory
* @property string|null $template_font_location_url The default PDF font directory's URL, or null when it's been moved
* @property string $template_tmp_location The current path to the PDF tmp location
* @property string $mpdf_tmp_location The current path to the mPDF tmp directory (mPDF's tempDir)
* @property string $multisite_template_location The current path to the multisite PDF working directory
Expand Down Expand Up @@ -304,33 +305,82 @@ public function get_localised_script_data( Helper_Abstract_Options $options, Hel

/* Font Manager */
'fontManagerTitle' => esc_html__( 'Font Manager', 'gravity-pdf' ),
'fontManagerSearchPlaceHolder' => esc_html__( 'Search installed fonts', 'gravity-pdf' ),
'fontListInstalledFonts' => esc_html__( 'Installed Fonts', 'gravity-pdf' ),
'fontManagerSearchPlaceHolder' => esc_html__( 'Search fonts', 'gravity-pdf' ),
'fontListSize' => esc_html__( 'Size', 'gravity-pdf' ),
'fontListInUse' => esc_html__( 'In use', 'gravity-pdf' ),
'fontListNotInUse' => esc_html__( 'Not in use', 'gravity-pdf' ),
'fontManagerDeleteTitle' => esc_html__( 'Delete font?', 'gravity-pdf' ),
/* translators: %s: the font name */
'fontManagerFontDeleted' => esc_html__( '%s deleted.', 'gravity-pdf' ),
'fontManagerCoreHint' => esc_html__( 'Downloaded when a PDF needs them. A deleted font downloads again if it\'s needed.', 'gravity-pdf' ),
'fontManagerCoreHintOffline' => esc_html__( 'Font downloads are turned off, so a deleted font won\'t come back on its own.', 'gravity-pdf' ),
'fontManagerOpensNewTab' => esc_html__( '(opens in a new tab)', 'gravity-pdf' ),
'fontsUrl' => $this->template_font_location_url ?? (string) \GPDFAPI::get_misc_class()->convert_path_to_url( $this->template_font_location ?? '' ),
/* translators: %d: the number of fonts */
'fontManagerFontInstalled' => esc_html__( '%d font installed', 'gravity-pdf' ),
/* translators: %d: the number of fonts */
'fontManagerFontsInstalled' => esc_html__( '%d fonts installed', 'gravity-pdf' ),
'fontManagerAddNew' => esc_html__( '+ Add new font', 'gravity-pdf' ),
/* translators: %d: the number of styles */
'fontManagerStyle' => esc_html__( '%d style', 'gravity-pdf' ),
/* translators: %d: the number of styles */
'fontManagerStyles' => esc_html__( '%d styles', 'gravity-pdf' ),
'fontManagerSetActive' => esc_html__( 'Set as active', 'gravity-pdf' ),
'fontManagerBundledWith' => esc_html__( 'Bundled with Gravity PDF', 'gravity-pdf' ),
'fontManagerBundledDesc' => esc_html__( 'Included with Gravity PDF, so it can\'t be deleted.', 'gravity-pdf' ),
'fontManagerTemplateUse' => esc_html__( 'Template use:', 'gravity-pdf' ),
'fontManagerPreview' => esc_html__( 'Preview', 'gravity-pdf' ),
'fontManagerPreviewStyle' => esc_html__( 'Style to preview', 'gravity-pdf' ),
'fontManagerPreviewAll' => esc_html__( 'Show all', 'gravity-pdf' ),
'fontManagerPreviewUnsupported' => esc_html__( 'Browsers can\'t display this font file, so it can\'t be previewed.', 'gravity-pdf' ),
'fontManagerPreviewFailed' => esc_html__( 'Couldn\'t load this style', 'gravity-pdf' ),
'fontManagerPreviewLoad' => esc_html__( 'Load preview', 'gravity-pdf' ),
'fontManagerPreviewUnavailable' => esc_html__( 'Previews aren\'t available because the fonts folder has no web address.', 'gravity-pdf' ),
'fontManagerSampleText' => esc_html__( 'Sample text', 'gravity-pdf' ),
'fontManagerPreviewText' => esc_html__( 'Sphinx of black quartz, judge my vow', 'gravity-pdf' ),
'fontManagerPreviewUnit' => esc_html__( 'pt', 'gravity-pdf' ),
'fontManagerFontNamePlaceholder' => esc_html__( 'e.g. Helvetica Neue, Roboto Slab, Source Sans 3', 'gravity-pdf' ),
'fontManagerNoFile' => esc_html__( 'No .ttf file added', 'gravity-pdf' ),
'fontManagerDropFile' => esc_html__( 'Drop .ttf to upload', 'gravity-pdf' ),
'fontManagerUpload' => esc_html__( '+ Upload', 'gravity-pdf' ),
'fontManagerReplace' => esc_html__( 'Replace', 'gravity-pdf' ),
/* translators: %s: the font style, e.g. Bold */
'fontManagerDeleteStyle' => esc_html__( 'Delete %s', 'gravity-pdf' ),
'fontUserDefinedGroup' => esc_html__( 'User-Defined Fonts', 'gravity-pdf' ),
'fontListRegular' => esc_html__( 'Regular', 'gravity-pdf' ),
'fontListItalics' => esc_html__( 'Italics', 'gravity-pdf' ),
'fontListItalics' => esc_html__( 'Italic', 'gravity-pdf' ),
'fontListBold' => esc_html__( 'Bold', 'gravity-pdf' ),
'fontListBoldItalics' => esc_html__( 'Bold Italics', 'gravity-pdf' ),
'fontManagerAddTitle' => esc_html__( 'Add Font', 'gravity-pdf' ),
'fontListBoldItalics' => esc_html__( 'Bold Italic', 'gravity-pdf' ),
'fontManagerAddTitle' => esc_html__( 'Add font', 'gravity-pdf' ),
'fontManagerUpdateTitle' => esc_html__( 'Update Font', 'gravity-pdf' ),
'fontManagerAddDesc' => esc_html__( 'Install new fonts for use in your PDF documents.', 'gravity-pdf' ),
'fontManagerUpdateDesc' => esc_html__( 'Once saved, PDFs configured to use this font will have your changes applied automatically for newly-generated documents.', 'gravity-pdf' ),
'fontManagerFontNameLabel' => esc_html__( 'Font Name', 'gravity-pdf' ),
'fontManagerFontNameLabel' => esc_html__( 'Font name', 'gravity-pdf' ),
'fontManagerRequiredLabel' => esc_html__( '(required)', 'gravity-pdf' ),
'fontManagerFontNameDesc' => esc_html__( 'The font name can only contain letters, numbers and spaces.', 'gravity-pdf' ),
'fontManagerFontNameDesc' => esc_html__( 'Letters, numbers, and spaces only', 'gravity-pdf' ),
'fontManagerFontNameValidationError' => esc_html__( 'Please choose a name contains letters and/or numbers (and a space if you want it).', 'gravity-pdf' ),
'fontManagerFontFilesLabel' => esc_html__( 'Font Files', 'gravity-pdf' ),
'fontManagerFontFilesDesc' => esc_html__( 'Select or drag and drop your .ttf font file for the variants below. Only the Regular type is required.', 'gravity-pdf' ),
'fontManagerFontFilesLabel' => esc_html__( 'Font files', 'gravity-pdf' ),
'fontManagerFontFilesDesc' => esc_html__( 'Add a .ttf file for each style you want to use in your PDFs. Regular is required; Italic, Bold, and Bold Italic are optional and only used when your templates need them.', 'gravity-pdf' ),
'fontManagerFontFileRequiredRegular' => esc_html__( 'Add a .ttf font file.', 'gravity-pdf' ),
'fontManagerTemplateTooltipLabel' => esc_html__( 'View template usage', 'gravity-pdf' ),
'fontManagerCancelButtonText' => esc_html__( '← Cancel', 'gravity-pdf' ),
'fontManagerDeleteFontConfirmation' => esc_html__( 'Are you sure you want to delete this font?', 'gravity-pdf' ),
/* translators: 1: Opening <a> tag (custom template link), 2: Opening <a> tag (font setting link), 3: Closing </a> tag */
'fontManagerTemplateTooltipDesc' => esc_html__( 'Add this snippet %1$sin a custom template%3$s to selectively set the font on blocks of text. If you want to apply the font to the entire PDF, %2$suse the Font setting%3$s when configuring the PDF on the form.', 'gravity-pdf' ),
'fontManagerAddFontAriaLabel' => esc_html__( 'Add font', 'gravity-pdf' ),
'fontManagerUpdateFontAriaLabel' => esc_html__( 'Update font', 'gravity-pdf' ),
'fontManagerSelectFontAriaLabel' => esc_html__( 'Select font', 'gravity-pdf' ),
'fontManagerDeleteFontAriaLabel' => esc_html__( 'Delete font', 'gravity-pdf' ),
'fontManagerTypeCustom' => esc_html__( 'Custom', 'gravity-pdf' ),
'fontManagerTypeCore' => esc_html__( 'Core', 'gravity-pdf' ),
'fontManagerLanguages' => esc_html__( 'Languages and scripts', 'gravity-pdf' ),
'fontManagerTypeAvailable' => esc_html__( 'Available to install', 'gravity-pdf' ),
'fontManagerInstall' => esc_html__( 'Install', 'gravity-pdf' ),
'fontManagerAvailableHint' => esc_html__( 'Downloaded when a PDF needs it, or install it now to have it ready.', 'gravity-pdf' ),
/* translators: %s: the font name */
'fontManagerFontJustInstalled' => esc_html__( '%s installed.', 'gravity-pdf' ),
'fontManagerTypeBundled' => esc_html__( 'Bundled', 'gravity-pdf' ),
'fontManagerNetworkOnly' => esc_html__( 'Only a network administrator can install or delete core fonts, as every site in the network shares them.', 'gravity-pdf' ),
/* translators: %s: the font name */
'fontManagerCoreConfirm' => esc_html__( 'Delete %s? It downloads again when a PDF needs it.', 'gravity-pdf' ),
/* translators: %s: the font name */
'fontManagerCoreConfirmOffline' => esc_html__( 'Delete %s? Font downloads are turned off, so it won\'t come back on its own: copy its files into the fonts folder again to restore it.', 'gravity-pdf' ),

/* Font Manager API response */
'fontListEmpty' => esc_html__( 'Font list empty.', 'gravity-pdf' ),
Expand Down
Loading