class-wp-font-library.php

<?php
/**
 * Font Library class.
 *
 * This file contains the Font Library class definition.
 *
 * @package    WordPress
 * @subpackage Font Library
 * @since      6.5.0
 */

if ( class_exists( 'WP_Font_Library' ) ) {
	return;
}

/**
 * Font Library class.
 *
 * @since 6.5.0
 */
class WP_Font_Library {

	/**
	 * Provide the expected mime-type value for font files per-PHP release. Due to differences in the values returned these values differ between PHP versions.
	 *
	 * This is necessary until a collection of valid mime-types per-file extension can be provided to 'upload_mimes' filter.
	 *
	 * @since 6.5.0
	 *
	 * @param array $php_version_id The version of PHP to provide mime types for. The default is the current PHP version.
	 *
	 * @return Array A collection of mime types keyed by file extension.
	 */
	public static function get_expected_font_mime_types_per_php_version( $php_version_id = PHP_VERSION_ID ) {

		$php_7_ttf_mime_type = $php_version_id >= 70300 ? 'application/font-sfnt' : 'application/x-font-ttf';

		return array(
			'otf'   => 'application/vnd.ms-opentype',
			'ttf'   => $php_version_id >= 70400 ? 'font/sfnt' : $php_7_ttf_mime_type,
			'woff'  => $php_version_id >= 80100 ? 'font/woff' : 'application/font-woff',
			'woff2' => $php_version_id >= 80100 ? 'font/woff2' : 'application/font-woff2',
		);
	}

	/**
	 * Font collections.
	 *
	 * @since 6.5.0
	 *
	 * @var array
	 */
	private static $collections = array();

	/**
	 * Register a new font collection.
	 *
	 * @since 6.5.0
	 *
	 * @param array $config Font collection config options.
	 *                      See {@see wp_register_font_collection()} for the supported fields.
	 * @return WP_Font_Collection|WP_Error A font collection is it was registered successfully and a WP_Error otherwise.
	 */
	public static function register_font_collection( $config ) {
		$new_collection = new WP_Font_Collection( $config );
		if ( self::is_collection_registered( $config['id'] ) ) {
			$error_message = sprintf(
				/* translators: %s: Font collection id. */
				__( 'Font collection with id: "%s" is already registered.', 'default' ),
				$config['id']
			);
			_doing_it_wrong(
				__METHOD__,
				$error_message,
				'6.5.0'
			);
			return new WP_Error( 'font_collection_registration_error', $error_message );
		}
		self::$collections[ $config['id'] ] = $new_collection;
		return $new_collection;
	}

	/**
	 * Unregisters a previously registered font collection.
	 *
	 * @since 6.5.0
	 *
	 * @param string $collection_id Font collection ID.
	 * @return bool True if the font collection was unregistered successfully and false otherwise.
	 */
	public static function unregister_font_collection( $collection_id ) {
		if ( ! self::is_collection_registered( $collection_id ) ) {
			_doing_it_wrong(
				__METHOD__,
				/* translators: %s: Font collection id. */
				sprintf( __( 'Font collection "%s" not found.', 'default' ), $collection_id ),
				'6.5.0'
			);
			return false;
		}
		unset( self::$collections[ $collection_id ] );
		return true;
	}

	/**
	 * Checks if a font collection is registered.
	 *
	 * @since 6.5.0
	 *
	 * @param string $collection_id Font collection ID.
	 * @return bool True if the font collection is registered and false otherwise.
	 */
	private static function is_collection_registered( $collection_id ) {
		return array_key_exists( $collection_id, self::$collections );
	}

	/**
	 * Gets all the font collections available.
	 *
	 * @since 6.5.0
	 *
	 * @return array List of font collections.
	 */
	public static function get_font_collections() {
		return self::$collections;
	}

	/**
	 * Gets a font collection.
	 *
	 * @since 6.5.0
	 *
	 * @param string $id Font collection id.
	 * @return array List of font collections.
	 */
	public static function get_font_collection( $id ) {
		if ( array_key_exists( $id, self::$collections ) ) {
			return self::$collections[ $id ];
		}
		return new WP_Error( 'font_collection_not_found', 'Font collection not found.' );
	}

	/**
	 * Returns an array containing the current fonts upload directory's path and URL.
	 *
	 * @since 6.5.0
	 *
	 * @param array $defaults {
	 *     Array of information about the upload directory.
	 *
	 *     @type string       $path    Base directory and subdirectory or full path to the fonts upload directory.
	 *     @type string       $url     Base URL and subdirectory or absolute URL to the fonts upload directory.
	 *     @type string       $subdir  Subdirectory
	 *     @type string       $basedir Path without subdir.
	 *     @type string       $baseurl URL path without subdir.
	 *     @type string|false $error   False or error message.
	 * }
	 *
	 * @return array $defaults {
	 *     Array of information about the upload directory.
	 *
	 *     @type string       $path    Base directory and subdirectory or full path to the fonts upload directory.
	 *     @type string       $url     Base URL and subdirectory or absolute URL to the fonts upload directory.
	 *     @type string       $subdir  Subdirectory
	 *     @type string       $basedir Path without subdir.
	 *     @type string       $baseurl URL path without subdir.
	 *     @type string|false $error   False or error message.
	 * }
	 */
	public static function fonts_dir( $defaults = array() ) {
		$site_path = self::get_multi_site_dir();

		// Sets the defaults.
		$defaults['path']    = path_join( WP_CONTENT_DIR, 'fonts' ) . $site_path;
		$defaults['url']     = untrailingslashit( content_url( 'fonts' ) ) . $site_path;
		$defaults['subdir']  = '';
		$defaults['basedir'] = path_join( WP_CONTENT_DIR, 'fonts' ) . $site_path;
		$defaults['baseurl'] = untrailingslashit( content_url( 'fonts' ) ) . $site_path;
		$defaults['error']   = false;

		// Filters the fonts directory data.
		return apply_filters( 'fonts_dir', $defaults );
	}

	/**
	 * Gets the Site dir for fonts, using the blog ID if multi-site, empty otherwise.
	 *
	 * @since 6.5.0
	 *
	 * @return string Site dir path.
	 */
	private static function get_multi_site_dir() {
		$font_sub_dir = '';
		if ( is_multisite() && ! ( is_main_network() && is_main_site() ) ) {
			$font_sub_dir = '/sites/' . get_current_blog_id();
		}
		return $font_sub_dir;
	}

	/**
	 * Gets the upload directory for fonts.
	 *
	 * @since 6.5.0
	 *
	 * @return string Path of the upload directory for fonts.
	 */
	public static function get_fonts_dir() {
		$fonts_dir_settings = self::fonts_dir();
		return $fonts_dir_settings['path'];
	}

	/**
	 * Sets the allowed mime types for fonts.
	 *
	 * @since 6.5.0
	 *
	 * @param array $mime_types List of allowed mime types.
	 * @return array Modified upload directory.
	 */
	public static function set_allowed_mime_types( $mime_types ) {
		return array_merge( $mime_types, self::get_expected_font_mime_types_per_php_version() );
	}
}