+ *
+ *
+ * @since 6.5.0
+ *
+ * @param string $source_name The name of the source. It must be a string containing a namespace prefix, i.e.
+ * `my-plugin/my-custom-source`. It must only contain lowercase alphanumeric
+ * characters, the forward slash `/` and dashes.
+ * @param array $source_properties {
+ * The array of arguments that are used to register a source.
+ *
+ * @type string $label The label of the source.
+ * @type callback $get_value_callback A callback executed when the source is processed during block rendering.
+ * The callback should have the following signature:
+ *
+ * `function ($source_args, $block_instance,$attribute_name): mixed`
+ * - @param array $source_args Array containing source arguments
+ * used to look up the override value,
+ * i.e. {"key": "foo"}.
+ * - @param WP_Block $block_instance The block instance.
+ * - @param string $attribute_name The name of an attribute .
+ * The callback has a mixed return type; it may return a string to override
+ * the block's original value, null, false to remove an attribute, etc.
+ * }
+ * @return WP_Block_Bindings_Source|false Source when the registration was successful, or `false` on failure.
+ */
+function register_block_bindings_source( string $source_name, array $source_properties ) {
+ return WP_Block_Bindings_Registry::get_instance()->register( $source_name, $source_properties );
+}
+
+/**
+ * Unregisters a block bindings source.
+ *
+ * @since 6.5.0
+ *
+ * @param string $source_name Block bindings source name including namespace.
+ * @return WP_Block_Bindings_Source|false The unregistered block bindings source on success and `false` otherwise.
+ */
+function unregister_block_bindings_source( string $source_name ) {
+ return WP_Block_Bindings_Registry::get_instance()->unregister( $source_name );
+}
+
+/**
+ * Retrieves the list of all registered block bindings sources.
+ *
+ * @since 6.5.0
+ *
+ * @return WP_Block_Bindings_Source[] The array of registered block bindings sources.
+ */
+function get_all_registered_block_bindings_sources() {
+ return WP_Block_Bindings_Registry::get_instance()->get_all_registered();
+}
+
+/**
+ * Retrieves a registered block bindings source.
+ *
+ * @since 6.5.0
+ *
+ * @param string $source_name The name of the source.
+ * @return WP_Block_Bindings_Source|null The registered block bindings source, or `null` if it is not registered.
+ */
+function get_block_bindings_source( string $source_name ) {
+ return WP_Block_Bindings_Registry::get_instance()->get_registered( $source_name );
+}
diff --git a/src/wp-includes/block-bindings/pattern-overrides.php b/src/wp-includes/block-bindings/pattern-overrides.php
new file mode 100644
index 0000000000000..6f719101ef5dd
--- /dev/null
+++ b/src/wp-includes/block-bindings/pattern-overrides.php
@@ -0,0 +1,46 @@
+ "foo" ).
+ * @param WP_Block $block_instance The block instance.
+ * @param string $attribute_name The name of the target attribute.
+ * @return mixed The value computed for the source.
+ */
+function _block_bindings_pattern_overrides_get_value( array $source_args, $block_instance, string $attribute_name ) {
+ if ( empty( $block_instance->attributes['metadata']['id'] ) ) {
+ return null;
+ }
+ $block_id = $block_instance->attributes['metadata']['id'];
+ return _wp_array_get( $block_instance->context, array( 'pattern/overrides', $block_id, $attribute_name ), null );
+}
+
+/**
+ * Registers Pattern Overrides source in the Block Bindings registry.
+ *
+ * @since 6.5.0
+ * @access private
+ */
+function _register_block_bindings_pattern_overrides_source() {
+ register_block_bindings_source(
+ 'core/pattern-overrides',
+ array(
+ 'label' => _x( 'Pattern Overrides', 'block bindings source' ),
+ 'get_value_callback' => '_block_bindings_pattern_overrides_get_value',
+ )
+ );
+}
+
+add_action( 'init', '_register_block_bindings_pattern_overrides_source' );
diff --git a/src/wp-includes/block-bindings/post-meta.php b/src/wp-includes/block-bindings/post-meta.php
new file mode 100644
index 0000000000000..4be1ae96b7620
--- /dev/null
+++ b/src/wp-includes/block-bindings/post-meta.php
@@ -0,0 +1,58 @@
+ "foo" ).
+ * @return mixed The value computed for the source.
+ */
+function _block_bindings_post_meta_get_value( array $source_args ) {
+ if ( ! isset( $source_args['key'] ) ) {
+ return null;
+ }
+
+ // Use the postId attribute if available.
+ if ( isset( $source_args['postId'] ) ) {
+ $post_id = $source_args['postId'];
+ } else {
+ // $block_instance->context['postId'] is not available in the Image block.
+ $post_id = get_the_ID();
+ }
+
+ // If a post isn't public, we need to prevent unauthorized users from accessing the post meta.
+ $post = get_post( $post_id );
+ if ( ( ! is_post_publicly_viewable( $post ) && ! current_user_can( 'read_post', $post_id ) ) || post_password_required( $post ) ) {
+ return null;
+ }
+
+ return get_post_meta( $post_id, $source_args['key'], true );
+}
+
+/**
+ * Registers Post Meta source in the block bindings registry.
+ *
+ * @since 6.5.0
+ * @access private
+ */
+function _register_block_bindings_post_meta_source() {
+ register_block_bindings_source(
+ 'core/post-meta',
+ array(
+ 'label' => _x( 'Post Meta', 'block bindings source' ),
+ 'get_value_callback' => '_block_bindings_post_meta_get_value',
+ )
+ );
+}
+
+add_action( 'init', '_register_block_bindings_post_meta_source' );
diff --git a/src/wp-includes/block-patterns.php b/src/wp-includes/block-patterns.php
index 66bdfd68e7caa..e5c770e1d4330 100644
--- a/src/wp-includes/block-patterns.php
+++ b/src/wp-includes/block-patterns.php
@@ -135,6 +135,20 @@ function _register_core_block_patterns_and_categories() {
'description' => __( 'Different layouts containing video or audio.' ),
)
);
+ register_block_pattern_category(
+ 'videos',
+ array(
+ 'label' => _x( 'Videos', 'Block pattern category' ),
+ 'description' => __( 'Different layouts containing videos.' ),
+ )
+ );
+ register_block_pattern_category(
+ 'audio',
+ array(
+ 'label' => _x( 'Audio', 'Block pattern category' ),
+ 'description' => __( 'Different layouts containing audio.' ),
+ )
+ );
register_block_pattern_category(
'posts',
array(
diff --git a/src/wp-includes/block-supports/background.php b/src/wp-includes/block-supports/background.php
index 283833991f57b..9b82e6a9d598d 100644
--- a/src/wp-includes/block-supports/background.php
+++ b/src/wp-includes/block-supports/background.php
@@ -70,13 +70,13 @@ function wp_render_background_support( $block_content, $block ) {
return $block_content;
}
- $background_size = isset( $block_attributes['style']['background']['backgroundSize'] )
+ $background_size = isset( $block_attributes['style']['background']['backgroundSize'] )
? $block_attributes['style']['background']['backgroundSize']
: 'cover';
- $background_position = isset( $block_attributes['style']['background']['backgroundPosition'] )
+ $background_position = isset( $block_attributes['style']['background']['backgroundPosition'] )
? $block_attributes['style']['background']['backgroundPosition']
: null;
- $background_repeat = isset( $block_attributes['style']['background']['backgroundRepeat'] )
+ $background_repeat = isset( $block_attributes['style']['background']['backgroundRepeat'] )
? $block_attributes['style']['background']['backgroundRepeat']
: null;
diff --git a/src/wp-includes/block-supports/dimensions.php b/src/wp-includes/block-supports/dimensions.php
index a889e78a16973..da68f187c3915 100644
--- a/src/wp-includes/block-supports/dimensions.php
+++ b/src/wp-includes/block-supports/dimensions.php
@@ -83,6 +83,86 @@ function wp_apply_dimensions_support( $block_type, $block_attributes ) {
return $attributes;
}
+/**
+ * Renders server-side dimensions styles to the block wrapper.
+ * This block support uses the `render_block` hook to ensure that
+ * it is also applied to non-server-rendered blocks.
+ *
+ * @since 6.5.0
+ * @access private
+ *
+ * @param string $block_content Rendered block content.
+ * @param array $block Block object.
+ * @return string Filtered block content.
+ */
+function wp_render_dimensions_support( $block_content, $block ) {
+ $block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
+ $block_attributes = ( isset( $block['attrs'] ) && is_array( $block['attrs'] ) ) ? $block['attrs'] : array();
+ $has_aspect_ratio_support = block_has_support( $block_type, array( 'dimensions', 'aspectRatio' ), false );
+
+ if (
+ ! $has_aspect_ratio_support ||
+ wp_should_skip_block_supports_serialization( $block_type, 'dimensions', 'aspectRatio' )
+ ) {
+ return $block_content;
+ }
+
+ $dimensions_block_styles = array();
+ $dimensions_block_styles['aspectRatio'] = $block_attributes['style']['dimensions']['aspectRatio'] ?? null;
+
+ // To ensure the aspect ratio does not get overridden by `minHeight` unset any existing rule.
+ if (
+ isset( $dimensions_block_styles['aspectRatio'] )
+ ) {
+ $dimensions_block_styles['minHeight'] = 'unset';
+ } elseif (
+ isset( $block_attributes['style']['dimensions']['minHeight'] ) ||
+ isset( $block_attributes['minHeight'] )
+ ) {
+ $dimensions_block_styles['aspectRatio'] = 'unset';
+ }
+
+ $styles = wp_style_engine_get_styles( array( 'dimensions' => $dimensions_block_styles ) );
+
+ if ( ! empty( $styles['css'] ) ) {
+ // Inject dimensions styles to the first element, presuming it's the wrapper, if it exists.
+ $tags = new WP_HTML_Tag_Processor( $block_content );
+
+ if ( $tags->next_tag() ) {
+ $existing_style = $tags->get_attribute( 'style' );
+ $updated_style = '';
+
+ if ( ! empty( $existing_style ) ) {
+ $updated_style = $existing_style;
+ if ( ! str_ends_with( $existing_style, ';' ) ) {
+ $updated_style .= ';';
+ }
+ }
+
+ $updated_style .= $styles['css'];
+ $tags->set_attribute( 'style', $updated_style );
+
+ if ( ! empty( $styles['classnames'] ) ) {
+ foreach ( explode( ' ', $styles['classnames'] ) as $class_name ) {
+ if (
+ str_contains( $class_name, 'aspect-ratio' ) &&
+ ! isset( $block_attributes['style']['dimensions']['aspectRatio'] )
+ ) {
+ continue;
+ }
+ $tags->add_class( $class_name );
+ }
+ }
+ }
+
+ return $tags->get_updated_html();
+ }
+
+ return $block_content;
+}
+
+add_filter( 'render_block', 'wp_render_dimensions_support', 10, 2 );
+
// Register the block support.
WP_Block_Supports::get_instance()->register(
'dimensions',
diff --git a/src/wp-includes/block-supports/layout.php b/src/wp-includes/block-supports/layout.php
index 67d6a3f1b77ac..f5acd75a72d7c 100644
--- a/src/wp-includes/block-supports/layout.php
+++ b/src/wp-includes/block-supports/layout.php
@@ -615,6 +615,9 @@ function wp_render_layout_support_flag( $block_content, $block ) {
$processor->add_class( $class_name );
}
return $processor->get_updated_html();
+ } elseif ( ! $block_supports_layout ) {
+ // Ensure layout classnames are not injected if there is no layout support.
+ return $block_content;
}
$global_settings = wp_get_global_settings();
@@ -834,7 +837,8 @@ function wp_render_layout_support_flag( $block_content, $block ) {
break;
}
- if ( false !== strpos( $processor->get_attribute( 'class' ), $inner_block_wrapper_classes ) ) {
+ $class_attribute = $processor->get_attribute( 'class' );
+ if ( is_string( $class_attribute ) && str_contains( $class_attribute, $inner_block_wrapper_classes ) ) {
break;
}
} while ( $processor->next_tag() );
diff --git a/src/wp-includes/block-supports/shadow.php b/src/wp-includes/block-supports/shadow.php
index 6fa05b248f4c4..0ccaf3fd44b76 100644
--- a/src/wp-includes/block-supports/shadow.php
+++ b/src/wp-includes/block-supports/shadow.php
@@ -58,9 +58,8 @@ function wp_apply_shadow_support( $block_type, $block_attributes ) {
$shadow_block_styles = array();
- $preset_shadow = array_key_exists( 'shadow', $block_attributes ) ? "var:preset|shadow|{$block_attributes['shadow']}" : null;
- $custom_shadow = isset( $block_attributes['style']['shadow'] ) ? $block_attributes['style']['shadow'] : null;
- $shadow_block_styles['shadow'] = $preset_shadow ? $preset_shadow : $custom_shadow;
+ $custom_shadow = $block_attributes['style']['shadow'] ?? null;
+ $shadow_block_styles['shadow'] = $custom_shadow;
$attributes = array();
$styles = wp_style_engine_get_styles( $shadow_block_styles );
diff --git a/src/wp-includes/block-supports/typography.php b/src/wp-includes/block-supports/typography.php
index bccde4f5c0221..e7d081c937ee4 100644
--- a/src/wp-includes/block-supports/typography.php
+++ b/src/wp-includes/block-supports/typography.php
@@ -398,6 +398,7 @@ function wp_get_typography_value_and_unit( $raw_value, $options = array() ) {
*
* @since 6.1.0
* @since 6.3.0 Checks for unsupported min/max viewport values that cause invalid clamp values.
+ * @since 6.5.0 Returns early when min and max viewport subtraction is zero to avoid division by zero.
* @access private
*
* @param array $args {
@@ -468,12 +469,18 @@ function wp_get_computed_fluid_typography_value( $args = array() ) {
return null;
}
+ // Calculates the linear factor denominator. If it's 0, we cannot calculate a fluid value.
+ $linear_factor_denominator = $maximum_viewport_width['value'] - $minimum_viewport_width['value'];
+ if ( empty( $linear_factor_denominator ) ) {
+ return null;
+ }
+
/*
* Build CSS rule.
* Borrowed from https://websemantics.uk/tools/responsive-font-calculator/.
*/
$view_port_width_offset = round( $minimum_viewport_width['value'] / 100, 3 ) . $font_size_unit;
- $linear_factor = 100 * ( ( $maximum_font_size['value'] - $minimum_font_size['value'] ) / ( $maximum_viewport_width['value'] - $minimum_viewport_width['value'] ) );
+ $linear_factor = 100 * ( ( $maximum_font_size['value'] - $minimum_font_size['value'] ) / ( $linear_factor_denominator ) );
$linear_factor_scaled = round( $linear_factor * $scale_factor, 3 );
$linear_factor_scaled = empty( $linear_factor_scaled ) ? 1 : $linear_factor_scaled;
$fluid_target_font_size = implode( '', $minimum_font_size_rem ) . " + ((1vw - $view_port_width_offset) * $linear_factor_scaled)";
diff --git a/src/wp-includes/block-template-utils.php b/src/wp-includes/block-template-utils.php
index e2cd7c1587b9f..3f912ad0611b6 100644
--- a/src/wp-includes/block-template-utils.php
+++ b/src/wp-includes/block-template-utils.php
@@ -251,7 +251,7 @@ function _get_block_templates_paths( $base_directory ) {
* @param string $template_type 'wp_template' or 'wp_template_part'.
* @param string $slug Template slug.
* @return array|null {
- * Array with template metadata if $template_type is one of 'wp_template' or 'wp_template_part'.
+ * Array with template metadata if $template_type is one of 'wp_template' or 'wp_template_part',
* null otherwise.
*
* @type string $slug Template slug.
diff --git a/src/wp-includes/blocks.php b/src/wp-includes/blocks.php
index 431e2b015332c..b7c2c2c433190 100644
--- a/src/wp-includes/blocks.php
+++ b/src/wp-includes/blocks.php
@@ -64,6 +64,7 @@ function generate_block_asset_handle( $block_name, $field_name, $index = 0 ) {
'viewScript' => 'view-script',
'editorStyle' => 'editor-style',
'style' => 'style',
+ 'viewStyle' => 'view-style',
);
$asset_handle = str_replace( '/', '-', $block_name ) .
'-' . $field_mappings[ $field_name ];
@@ -123,12 +124,13 @@ function get_block_asset_url( $path ) {
/**
* Finds a script handle for the selected block metadata field. It detects
- * when a path to file was provided and finds a corresponding asset file
- * with details necessary to register the script under automatically
+ * when a path to file was provided and optionally finds a corresponding asset
+ * file with details necessary to register the script under automatically
* generated handle name. It returns unprocessed script handle otherwise.
*
* @since 5.5.0
* @since 6.1.0 Added `$index` parameter.
+ * @since 6.5.0 The asset file is optional.
*
* @param array $metadata Block metadata.
* @param string $field_name Field name to pick from metadata.
@@ -162,21 +164,6 @@ function register_block_script_handle( $metadata, $field_name, $index = 0 ) {
realpath( $script_asset_raw_path )
);
- if ( empty( $script_asset_path ) ) {
- _doing_it_wrong(
- __FUNCTION__,
- sprintf(
- /* translators: 1: Asset file location, 2: Field name, 3: Block name. */
- __( 'The asset file (%1$s) for the "%2$s" defined in "%3$s" block definition is missing.' ),
- $script_asset_raw_path,
- $field_name,
- $metadata['name']
- ),
- '5.5.0'
- );
- return false;
- }
-
$script_path_norm = wp_normalize_path( realpath( $path . '/' . $script_path ) );
$script_uri = get_block_asset_url( $script_path_norm );
@@ -185,7 +172,8 @@ function register_block_script_handle( $metadata, $field_name, $index = 0 ) {
$script_args['strategy'] = 'defer';
}
- $script_asset = require $script_asset_path;
+ // Asset file for blocks is optional. See https://core.trac.wordpress.org/ticket/60460.
+ $script_asset = ! empty( $script_asset_path ) ? require $script_asset_path : array();
$script_dependencies = isset( $script_asset['dependencies'] ) ? $script_asset['dependencies'] : array();
$result = wp_register_script(
$script_handle,
@@ -326,6 +314,7 @@ function get_block_metadata_i18n_schema() {
* @since 6.1.0 Added support for `render` field.
* @since 6.3.0 Added `selectors` field.
* @since 6.4.0 Added support for `blockHooks` field.
+ * @since 6.5.0 Added support for `allowedBlocks` and `viewStyle` fields.
*
* @param string $file_or_folder Path to the JSON file with metadata definition for
* the block or path to the folder where the `block.json` file is located.
@@ -422,6 +411,7 @@ function register_block_type_from_metadata( $file_or_folder, $args = array() ) {
'styles' => 'styles',
'variations' => 'variations',
'example' => 'example',
+ 'allowedBlocks' => 'allowed_blocks',
);
$textdomain = ! empty( $metadata['textdomain'] ) ? $metadata['textdomain'] : null;
$i18n_schema = get_block_metadata_i18n_schema();
@@ -503,6 +493,7 @@ function register_block_type_from_metadata( $file_or_folder, $args = array() ) {
$style_fields = array(
'editorStyle' => 'editor_style_handles',
'style' => 'style_handles',
+ 'viewStyle' => 'view_style_handles',
);
foreach ( $style_fields as $metadata_field_name => $settings_field_name ) {
if ( ! empty( $settings[ $metadata_field_name ] ) ) {
@@ -758,27 +749,33 @@ function get_hooked_blocks() {
}
/**
- * Conditionally returns the markup for a given hooked block type.
+ * Conditionally returns the markup for a given hooked block.
*
- * Accepts two arguments: A reference to an anchor block, and the name of a hooked block type.
+ * Accepts three arguments: A hooked block, its type, and a reference to an anchor block.
* If the anchor block has already been processed, and the given hooked block type is in the list
* of ignored hooked blocks, an empty string is returned.
*
+ * The hooked block type is specified separately as it's possible that a filter might've modified
+ * the hooked block such that `$hooked_block['blockName']` does no longer reflect the original type.
+ *
* This function is meant for internal use only.
*
* @since 6.5.0
* @access private
*
- * @param array $anchor_block The anchor block. Passed by reference.
- * @param string $hooked_block_type The name of the hooked block type.
- * @return string The markup for the given hooked block type, or an empty string if the block is ignored.
+ * @param array $hooked_block The hooked block, represented as a parsed block array.
+ * @param string $hooked_block_type The type of the hooked block. This could be different from
+ * $hooked_block['blockName'], as a filter might've modified the latter.
+ * @param array $anchor_block The anchor block, represented as a parsed block array.
+ * Passed by reference.
+ * @return string The markup for the given hooked block, or an empty string if the block is ignored.
*/
-function get_hooked_block_markup( &$anchor_block, $hooked_block_type ) {
+function get_hooked_block_markup( $hooked_block, $hooked_block_type, &$anchor_block ) {
if ( ! isset( $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] ) ) {
$anchor_block['attrs']['metadata']['ignoredHookedBlocks'] = array();
}
- if ( in_array( $hooked_block_type, $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] ) ) {
+ if ( in_array( $hooked_block_type, $anchor_block['attrs']['metadata']['ignoredHookedBlocks'], true ) ) {
return '';
}
@@ -786,7 +783,72 @@ function get_hooked_block_markup( &$anchor_block, $hooked_block_type ) {
// However, its presence does not affect the frontend.
$anchor_block['attrs']['metadata']['ignoredHookedBlocks'][] = $hooked_block_type;
- return get_comment_delimited_block_content( $hooked_block_type, array(), '' );
+ return serialize_block( $hooked_block );
+}
+
+/**
+ * Returns the markup for blocks hooked to the given anchor block in a specific relative position.
+ *
+ * @since 6.5.0
+ * @access private
+ *
+ * @param array $parsed_anchor_block The anchor block, in parsed block array format.
+ * @param string $relative_position The relative position of the hooked blocks.
+ * Can be one of 'before', 'after', 'first_child', or 'last_child'.
+ * @param array $hooked_blocks An array of hooked block types, grouped by anchor block and relative position.
+ * @param WP_Block_Template|array $context The block template, template part, or pattern that the anchor block belongs to.
+ * @return string
+ */
+function insert_hooked_blocks( &$parsed_anchor_block, $relative_position, $hooked_blocks, $context ) {
+ $anchor_block_type = $parsed_anchor_block['blockName'];
+ $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] )
+ ? $hooked_blocks[ $anchor_block_type ][ $relative_position ]
+ : array();
+
+ /**
+ * Filters the list of hooked block types for a given anchor block type and relative position.
+ *
+ * @since 6.4.0
+ *
+ * @param string[] $hooked_block_types The list of hooked block types.
+ * @param string $relative_position The relative position of the hooked blocks.
+ * Can be one of 'before', 'after', 'first_child', or 'last_child'.
+ * @param string $anchor_block_type The anchor block type.
+ * @param WP_Block_Template|WP_Post|array $context The block template, template part, `wp_navigation` post type,
+ * or pattern that the anchor block belongs to.
+ */
+ $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );
+
+ $markup = '';
+ foreach ( $hooked_block_types as $hooked_block_type ) {
+ $parsed_hooked_block = array(
+ 'blockName' => $hooked_block_type,
+ 'attrs' => array(),
+ 'innerBlocks' => array(),
+ 'innerContent' => array(),
+ );
+
+ /**
+ * Filters the parsed block array for a given hooked block.
+ *
+ * The dynamic portion of the hook name, `$hooked_block_type`, refers to the block type name of the specific hooked block.
+ *
+ * @since 6.5.0
+ *
+ * @param array $parsed_hooked_block The parsed block array for the given hooked block type.
+ * @param string $relative_position The relative position of the hooked block.
+ * @param array $parsed_anchor_block The anchor block, in parsed block array format.
+ * @param WP_Block_Template|WP_Post|array $context The block template, template part, `wp_navigation` post type,
+ * or pattern that the anchor block belongs to.
+ */
+ $parsed_hooked_block = apply_filters( "hooked_block_{$hooked_block_type}", $parsed_hooked_block, $relative_position, $parsed_anchor_block, $context );
+
+ // It's possible that the `hooked_block_{$hooked_block_type}` filter returned a block of a different type,
+ // so we need to pass the original $hooked_block_type as well.
+ $markup .= get_hooked_block_markup( $parsed_hooked_block, $hooked_block_type, $parsed_anchor_block );
+ }
+
+ return $markup;
}
/**
@@ -801,8 +863,9 @@ function get_hooked_block_markup( &$anchor_block, $hooked_block_type ) {
* @since 6.4.0
* @access private
*
- * @param array $hooked_blocks An array of blocks hooked to another given block.
- * @param WP_Block_Template|array $context A block template, template part, or pattern that the blocks belong to.
+ * @param array $hooked_blocks An array of blocks hooked to another given block.
+ * @param WP_Block_Template|WP_Post|array $context A block template, template part, `wp_navigation` post object,
+ * or pattern that the blocks belong to.
* @return callable A function that returns the serialized markup for the given block,
* including the markup for any hooked blocks before it.
*/
@@ -826,40 +889,10 @@ function make_before_block_visitor( $hooked_blocks, $context ) {
if ( $parent_block && ! $prev ) {
// Candidate for first-child insertion.
- $relative_position = 'first_child';
- $anchor_block_type = $parent_block['blockName'];
- $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] )
- ? $hooked_blocks[ $anchor_block_type ][ $relative_position ]
- : array();
-
- /**
- * Filters the list of hooked block types for a given anchor block type and relative position.
- *
- * @since 6.4.0
- *
- * @param string[] $hooked_block_types The list of hooked block types.
- * @param string $relative_position The relative position of the hooked blocks.
- * Can be one of 'before', 'after', 'first_child', or 'last_child'.
- * @param string $anchor_block_type The anchor block type.
- * @param WP_Block_Template|array $context The block template, template part, or pattern that the anchor block belongs to.
- */
- $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );
- foreach ( $hooked_block_types as $hooked_block_type ) {
- $markup .= get_hooked_block_markup( $parent_block, $hooked_block_type );
- }
+ $markup .= insert_hooked_blocks( $parent_block, 'first_child', $hooked_blocks, $context );
}
- $relative_position = 'before';
- $anchor_block_type = $block['blockName'];
- $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] )
- ? $hooked_blocks[ $anchor_block_type ][ $relative_position ]
- : array();
-
- /** This filter is documented in wp-includes/blocks.php */
- $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );
- foreach ( $hooked_block_types as $hooked_block_type ) {
- $markup .= get_hooked_block_markup( $block, $hooked_block_type );
- }
+ $markup .= insert_hooked_blocks( $block, 'before', $hooked_blocks, $context );
return $markup;
};
@@ -877,8 +910,9 @@ function make_before_block_visitor( $hooked_blocks, $context ) {
* @since 6.4.0
* @access private
*
- * @param array $hooked_blocks An array of blocks hooked to another block.
- * @param WP_Block_Template|array $context A block template, template part, or pattern that the blocks belong to.
+ * @param array $hooked_blocks An array of blocks hooked to another block.
+ * @param WP_Block_Template|WP_Post|array $context A block template, template part, `wp_navigation` post object,
+ * or pattern that the blocks belong to.
* @return callable A function that returns the serialized markup for the given block,
* including the markup for any hooked blocks after it.
*/
@@ -895,33 +929,11 @@ function make_after_block_visitor( $hooked_blocks, $context ) {
* @return string The serialized markup for the given block, with the markup for any hooked blocks appended to it.
*/
return function ( &$block, &$parent_block = null, $next = null ) use ( $hooked_blocks, $context ) {
- $markup = '';
-
- $relative_position = 'after';
- $anchor_block_type = $block['blockName'];
- $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] )
- ? $hooked_blocks[ $anchor_block_type ][ $relative_position ]
- : array();
-
- /** This filter is documented in wp-includes/blocks.php */
- $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );
- foreach ( $hooked_block_types as $hooked_block_type ) {
- $markup .= get_hooked_block_markup( $block, $hooked_block_type );
- }
+ $markup = insert_hooked_blocks( $block, 'after', $hooked_blocks, $context );
if ( $parent_block && ! $next ) {
// Candidate for last-child insertion.
- $relative_position = 'last_child';
- $anchor_block_type = $parent_block['blockName'];
- $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] )
- ? $hooked_blocks[ $anchor_block_type ][ $relative_position ]
- : array();
-
- /** This filter is documented in wp-includes/blocks.php */
- $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );
- foreach ( $hooked_block_types as $hooked_block_type ) {
- $markup .= get_hooked_block_markup( $parent_block, $hooked_block_type );
- }
+ $markup .= insert_hooked_blocks( $parent_block, 'last_child', $hooked_blocks, $context );
}
return $markup;
diff --git a/src/wp-includes/blocks/audio/block.json b/src/wp-includes/blocks/audio/block.json
index a4740e304451c..04df268a74a63 100644
--- a/src/wp-includes/blocks/audio/block.json
+++ b/src/wp-includes/blocks/audio/block.json
@@ -16,8 +16,8 @@
"__experimentalRole": "content"
},
"caption": {
- "type": "string",
- "source": "html",
+ "type": "rich-text",
+ "source": "rich-text",
"selector": "figcaption",
"__experimentalRole": "content"
},
diff --git a/src/wp-includes/blocks/avatar/block.json b/src/wp-includes/blocks/avatar/block.json
index 3b4ac7c84f617..fa86541b2963f 100644
--- a/src/wp-includes/blocks/avatar/block.json
+++ b/src/wp-includes/blocks/avatar/block.json
@@ -30,7 +30,11 @@
"alignWide": false,
"spacing": {
"margin": true,
- "padding": true
+ "padding": true,
+ "__experimentalDefaultControls": {
+ "margin": false,
+ "padding": false
+ }
},
"__experimentalBorder": {
"__experimentalSkipSerialization": true,
diff --git a/src/wp-includes/blocks/block.php b/src/wp-includes/blocks/block.php
index d51b35d68b23d..444001fa49859 100644
--- a/src/wp-includes/blocks/block.php
+++ b/src/wp-includes/blocks/block.php
@@ -46,8 +46,28 @@ function render_block_core_block( $attributes ) {
$content = $wp_embed->run_shortcode( $reusable_block->post_content );
$content = $wp_embed->autoembed( $content );
+ $has_pattern_overrides = isset( $attributes['overrides'] );
+
+ /**
+ * We set the `pattern/overrides` context through the `render_block_context`
+ * filter so that it is available when a pattern's inner blocks are
+ * rendering via do_blocks given it only receives the inner content.
+ */
+ if ( $has_pattern_overrides ) {
+ $filter_block_context = static function ( $context ) use ( $attributes ) {
+ $context['pattern/overrides'] = $attributes['overrides'];
+ return $context;
+ };
+ add_filter( 'render_block_context', $filter_block_context, 1 );
+ }
+
$content = do_blocks( $content );
unset( $seen_refs[ $attributes['ref'] ] );
+
+ if ( $has_pattern_overrides ) {
+ remove_filter( 'render_block_context', $filter_block_context, 1 );
+ }
+
return $content;
}
diff --git a/src/wp-includes/blocks/block/block.json b/src/wp-includes/blocks/block/block.json
index 4cb53960725d2..b30c865e57a7f 100644
--- a/src/wp-includes/blocks/block/block.json
+++ b/src/wp-includes/blocks/block/block.json
@@ -10,11 +10,15 @@
"attributes": {
"ref": {
"type": "number"
+ },
+ "overrides": {
+ "type": "object"
}
},
"supports": {
"customClassName": false,
"html": false,
- "inserter": false
+ "inserter": false,
+ "renaming": false
}
}
diff --git a/src/wp-includes/blocks/blocks-json.php b/src/wp-includes/blocks/blocks-json.php
index 85656181b047b..99eb57a0eddf0 100644
--- a/src/wp-includes/blocks/blocks-json.php
+++ b/src/wp-includes/blocks/blocks-json.php
@@ -75,8 +75,8 @@
'__experimentalRole' => 'content'
),
'caption' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'figcaption',
'__experimentalRole' => 'content'
),
@@ -154,7 +154,11 @@
'alignWide' => false,
'spacing' => array(
'margin' => true,
- 'padding' => true
+ 'padding' => true,
+ '__experimentalDefaultControls' => array(
+ 'margin' => false,
+ 'padding' => false
+ )
),
'__experimentalBorder' => array(
'__experimentalSkipSerialization' => true,
@@ -192,12 +196,16 @@
'attributes' => array(
'ref' => array(
'type' => 'number'
+ ),
+ 'overrides' => array(
+ 'type' => 'object'
)
),
'supports' => array(
'customClassName' => false,
'html' => false,
- 'inserter' => false
+ 'inserter' => false,
+ 'renaming' => false
)
),
'button' => array(
@@ -214,6 +222,9 @@
'link'
),
'textdomain' => 'default',
+ 'usesContext' => array(
+ 'pattern/overrides'
+ ),
'attributes' => array(
'tagName' => array(
'type' => 'string',
@@ -245,8 +256,8 @@
'__experimentalRole' => 'content'
),
'text' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'a,button',
'__experimentalRole' => 'content'
),
@@ -516,8 +527,8 @@
'textdomain' => 'default',
'attributes' => array(
'content' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'code',
'__unstablePreserveWhiteSpace' => true
)
@@ -1314,7 +1325,7 @@
'ancestor' => array(
'core/comments'
),
- 'description' => 'Displays a title with the number of comments',
+ 'description' => 'Displays a title with the number of comments.',
'textdomain' => 'default',
'usesContext' => array(
'postId',
@@ -1397,9 +1408,6 @@
),
'alt' => array(
'type' => 'string',
- 'source' => 'attribute',
- 'selector' => 'img',
- 'attribute' => 'alt',
'default' => ''
),
'hasParallax' => array(
@@ -1420,6 +1428,9 @@
'customOverlayColor' => array(
'type' => 'string'
),
+ 'isUserOverlayColor' => array(
+ 'type' => 'boolean'
+ ),
'backgroundType' => array(
'type' => 'string',
'default' => 'image'
@@ -1508,6 +1519,9 @@
),
'enableContrastChecker' => false
),
+ 'dimensions' => array(
+ 'aspectRatio' => true
+ ),
'typography' => array(
'fontSize' => true,
'lineHeight' => true,
@@ -1548,8 +1562,8 @@
'default' => false
),
'summary' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'summary'
)
),
@@ -1615,8 +1629,8 @@
'__experimentalRole' => 'content'
),
'caption' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'figcaption',
'__experimentalRole' => 'content'
),
@@ -1679,8 +1693,8 @@
'attribute' => 'id'
),
'fileName' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'a:not([download])'
),
'textLinkHref' => array(
@@ -1700,8 +1714,8 @@
'default' => true
),
'downloadButtonText' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'a[download]'
),
'displayPreview' => array(
@@ -1730,7 +1744,6 @@
),
'interactivity' => true
),
- 'viewScript' => 'file:./view.min.js',
'editorStyle' => 'wp-block-file-editor',
'style' => 'wp-block-file'
),
@@ -1740,7 +1753,7 @@
'name' => 'core/footnotes',
'title' => 'Footnotes',
'category' => 'text',
- 'description' => '',
+ 'description' => 'Display footnotes added to the page.',
'keywords' => array(
'references'
),
@@ -1774,6 +1787,7 @@
'html' => false,
'multiple' => false,
'reusable' => false,
+ 'inserter' => false,
'spacing' => array(
'margin' => true,
'padding' => true,
@@ -1873,8 +1887,8 @@
'attribute' => 'data-id'
),
'caption' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => '.blocks-gallery-item__caption'
)
)
@@ -1903,14 +1917,18 @@
'maximum' => 8
),
'caption' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => '.blocks-gallery-caption'
),
'imageCrop' => array(
'type' => 'boolean',
'default' => true
),
+ 'randomOrder' => array(
+ 'type' => 'boolean',
+ 'default' => false
+ ),
'fixedHeight' => array(
'type' => 'boolean',
'default' => true
@@ -2018,7 +2036,6 @@
'__experimentalOnEnter' => true,
'__experimentalOnMerge' => true,
'__experimentalSettings' => true,
- '__experimentalMetadata' => true,
'align' => array(
'wide',
'full'
@@ -2027,7 +2044,11 @@
'ariaLabel' => true,
'html' => false,
'background' => array(
- 'backgroundImage' => true
+ 'backgroundImage' => true,
+ 'backgroundSize' => true,
+ '__experimentalDefaultControls' => array(
+ 'backgroundImage' => true
+ )
),
'color' => array(
'gradients' => true,
@@ -2101,15 +2122,17 @@
'subtitle'
),
'textdomain' => 'default',
+ 'usesContext' => array(
+ 'pattern/overrides'
+ ),
'attributes' => array(
'textAlign' => array(
'type' => 'string'
),
'content' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'h1,h2,h3,h4,h5,h6',
- 'default' => '',
'__experimentalRole' => 'content'
),
'level' => array(
@@ -2154,9 +2177,7 @@
'__experimentalTextDecoration' => true,
'__experimentalWritingMode' => true,
'__experimentalDefaultControls' => array(
- 'fontSize' => true,
- 'fontAppearance' => true,
- 'textTransform' => true
+ 'fontSize' => true
)
),
'__unstablePasteTextInline' => true,
@@ -2243,7 +2264,8 @@
'usesContext' => array(
'allowResize',
'imageCrop',
- 'fixedHeight'
+ 'fixedHeight',
+ 'pattern/overrides'
),
'description' => 'Insert an image to make a visual statement.',
'keywords' => array(
@@ -2253,9 +2275,6 @@
),
'textdomain' => 'default',
'attributes' => array(
- 'align' => array(
- 'type' => 'string'
- ),
'url' => array(
'type' => 'string',
'source' => 'attribute',
@@ -2272,8 +2291,8 @@
'__experimentalRole' => 'content'
),
'caption' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'figcaption',
'__experimentalRole' => 'content'
),
@@ -2339,6 +2358,14 @@
)
),
'supports' => array(
+ 'interactivity' => true,
+ 'align' => array(
+ 'left',
+ 'center',
+ 'right',
+ 'wide',
+ 'full'
+ ),
'anchor' => true,
'color' => array(
'text' => false,
@@ -2377,8 +2404,7 @@
)
),
'editorStyle' => 'wp-block-image-editor',
- 'style' => 'wp-block-image',
- 'viewScript' => 'file:./view.min.js'
+ 'style' => 'wp-block-image'
),
'latest-comments' => array(
'$schema' => 'https://schemas.wp.org/trunk/block.json',
@@ -2559,6 +2585,7 @@
'style' => 'wp-block-latest-posts'
),
'legacy-widget' => array(
+ '$schema' => 'https://schemas.wp.org/trunk/block.json',
'apiVersion' => 3,
'name' => 'core/legacy-widget',
'title' => 'Legacy Widget',
@@ -2686,16 +2713,23 @@
'type' => 'string'
),
'content' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'li',
- 'default' => '',
'__experimentalRole' => 'content'
)
),
'supports' => array(
'className' => false,
'__experimentalSelector' => 'li',
+ 'spacing' => array(
+ 'margin' => true,
+ 'padding' => true,
+ '__experimentalDefaultControls' => array(
+ 'margin' => false,
+ 'padding' => false
+ )
+ ),
'typography' => array(
'fontSize' => true,
'lineHeight' => true,
@@ -2736,6 +2770,14 @@
),
'supports' => array(
'className' => true,
+ 'spacing' => array(
+ 'margin' => true,
+ 'padding' => true,
+ '__experimentalDefaultControls' => array(
+ 'margin' => false,
+ 'padding' => false
+ )
+ ),
'typography' => array(
'fontSize' => true,
'lineHeight' => true,
@@ -2904,7 +2946,7 @@
),
'originalContent' => array(
'type' => 'string',
- 'source' => 'html'
+ 'source' => 'raw'
)
),
'supports' => array(
@@ -3101,9 +3143,9 @@
)
)
),
- 'interactivity' => true
+ 'interactivity' => true,
+ 'renaming' => false
),
- 'viewScript' => 'file:./view.min.js',
'editorStyle' => 'wp-block-navigation-editor',
'style' => 'wp-block-navigation'
),
@@ -3182,7 +3224,8 @@
'__experimentalDefaultControls' => array(
'fontSize' => true
)
- )
+ ),
+ 'renaming' => false
),
'editorStyle' => 'wp-block-navigation-link-editor',
'style' => 'wp-block-navigation-link'
@@ -3403,17 +3446,17 @@
),
'textdomain' => 'default',
'usesContext' => array(
- 'postId'
+ 'postId',
+ 'pattern/overrides'
),
'attributes' => array(
'align' => array(
'type' => 'string'
),
'content' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'p',
- 'default' => '',
'__experimentalRole' => 'content'
),
'dropCap' => array(
@@ -3442,7 +3485,6 @@
'text' => true
)
),
- '__experimentalConnections' => true,
'spacing' => array(
'margin' => true,
'padding' => true,
@@ -3480,7 +3522,8 @@
'description' => 'Show a block pattern.',
'supports' => array(
'html' => false,
- 'inserter' => false
+ 'inserter' => false,
+ 'renaming' => false
),
'textdomain' => 'default',
'attributes' => array(
@@ -3934,6 +3977,10 @@
),
'customGradient' => array(
'type' => 'string'
+ ),
+ 'useFirstImageFromPost' => array(
+ 'type' => 'boolean',
+ 'default' => false
)
),
'usesContext' => array(
@@ -4005,8 +4052,18 @@
'arrow' => array(
'type' => 'string',
'default' => 'none'
+ ),
+ 'inSameTerm' => array(
+ 'type' => 'boolean'
+ ),
+ 'taxonomy' => array(
+ 'type' => 'string',
+ 'default' => ''
)
),
+ 'usesContext' => array(
+ 'postType'
+ ),
'supports' => array(
'reusable' => false,
'html' => false,
@@ -4044,7 +4101,6 @@
'usesContext' => array(
'queryId',
'query',
- 'queryContext',
'displayLayout',
'templateSlug',
'previewPostType',
@@ -4218,9 +4274,7 @@
'__experimentalTextDecoration' => true,
'__experimentalLetterSpacing' => true,
'__experimentalDefaultControls' => array(
- 'fontSize' => true,
- 'fontAppearance' => true,
- 'textTransform' => true
+ 'fontSize' => true
)
)
),
@@ -4236,10 +4290,9 @@
'textdomain' => 'default',
'attributes' => array(
'content' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'pre',
- 'default' => '',
'__unstablePreserveWhiteSpace' => true,
'__experimentalRole' => 'content'
)
@@ -4283,16 +4336,15 @@
'textdomain' => 'default',
'attributes' => array(
'value' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'p',
'__experimentalRole' => 'content'
),
'citation' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'cite',
- 'default' => '',
'__experimentalRole' => 'content'
),
'textAlign' => array(
@@ -4316,6 +4368,10 @@
'text' => true
)
),
+ 'spacing' => array(
+ 'margin' => true,
+ 'padding' => true
+ ),
'typography' => array(
'fontSize' => true,
'lineHeight' => true,
@@ -4326,8 +4382,7 @@
'__experimentalTextDecoration' => true,
'__experimentalLetterSpacing' => true,
'__experimentalDefaultControls' => array(
- 'fontSize' => true,
- 'fontAppearance' => true
+ 'fontSize' => true
)
),
'__experimentalBorder' => array(
@@ -4413,8 +4468,7 @@
'layout' => true
),
'editorStyle' => 'wp-block-query-editor',
- 'style' => 'wp-block-query',
- 'viewScript' => 'file:./view.min.js'
+ 'style' => 'wp-block-query'
),
'query-no-results' => array(
'$schema' => 'https://schemas.wp.org/trunk/block.json',
@@ -4577,7 +4631,7 @@
'parent' => array(
'core/query-pagination'
),
- 'description' => 'Displays a list of page numbers for pagination',
+ 'description' => 'Displays a list of page numbers for pagination.',
'textdomain' => 'default',
'attributes' => array(
'midSize' => array(
@@ -4719,9 +4773,7 @@
'__experimentalTextTransform' => true,
'__experimentalTextDecoration' => true,
'__experimentalDefaultControls' => array(
- 'fontSize' => true,
- 'fontAppearance' => true,
- 'textTransform' => true
+ 'fontSize' => true
)
)
),
@@ -4749,10 +4801,9 @@
'__experimentalRole' => 'content'
),
'citation' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'cite',
- 'default' => '',
'__experimentalRole' => 'content'
),
'align' => array(
@@ -4774,8 +4825,7 @@
'__experimentalTextDecoration' => true,
'__experimentalLetterSpacing' => true,
'__experimentalDefaultControls' => array(
- 'fontSize' => true,
- 'fontAppearance' => true
+ 'fontSize' => true
)
),
'color' => array(
@@ -4786,6 +4836,12 @@
'background' => true,
'text' => true
)
+ ),
+ 'layout' => array(
+ 'allowEditing' => false
+ ),
+ 'spacing' => array(
+ 'blockGap' => true
)
),
'styles' => array(
@@ -4965,10 +5021,6 @@
)
),
- 'buttonBehavior' => array(
- 'type' => 'string',
- 'default' => 'expand-searchfield'
- ),
'isSearchFieldHidden' => array(
'type' => 'boolean',
'default' => false
@@ -5017,7 +5069,6 @@
),
'html' => false
),
- 'viewScript' => 'file:./view.min.js',
'editorStyle' => 'wp-block-search-editor',
'style' => 'wp-block-search'
),
@@ -5283,11 +5334,7 @@
'__experimentalFontWeight' => true,
'__experimentalLetterSpacing' => true,
'__experimentalDefaultControls' => array(
- 'fontSize' => true,
- 'lineHeight' => true,
- 'fontAppearance' => true,
- 'letterSpacing' => true,
- 'textTransform' => true
+ 'fontSize' => true
)
)
),
@@ -5496,10 +5543,9 @@
'default' => false
),
'caption' => array(
- 'type' => 'string',
- 'source' => 'html',
- 'selector' => 'figcaption',
- 'default' => ''
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
+ 'selector' => 'figcaption'
),
'head' => array(
'type' => 'array',
@@ -5518,8 +5564,8 @@
'selector' => 'td,th',
'query' => array(
'content' => array(
- 'type' => 'string',
- 'source' => 'html'
+ 'type' => 'rich-text',
+ 'source' => 'rich-text'
),
'tag' => array(
'type' => 'string',
@@ -5567,8 +5613,8 @@
'selector' => 'td,th',
'query' => array(
'content' => array(
- 'type' => 'string',
- 'source' => 'html'
+ 'type' => 'rich-text',
+ 'source' => 'rich-text'
),
'tag' => array(
'type' => 'string',
@@ -5616,8 +5662,8 @@
'selector' => 'td,th',
'query' => array(
'content' => array(
- 'type' => 'string',
- 'source' => 'html'
+ 'type' => 'rich-text',
+ 'source' => 'rich-text'
),
'tag' => array(
'type' => 'string',
@@ -5794,7 +5840,8 @@
'supports' => array(
'align' => true,
'html' => false,
- 'reusable' => false
+ 'reusable' => false,
+ 'renaming' => false
),
'editorStyle' => 'wp-block-template-part-editor'
),
@@ -5900,10 +5947,9 @@
'textdomain' => 'default',
'attributes' => array(
'content' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'pre',
- 'default' => '',
'__unstablePreserveWhiteSpace' => true,
'__experimentalRole' => 'content'
),
@@ -5931,8 +5977,7 @@
'__experimentalTextTransform' => true,
'__experimentalTextDecoration' => true,
'__experimentalDefaultControls' => array(
- 'fontSize' => true,
- 'fontAppearance' => true
+ 'fontSize' => true
)
),
'spacing' => array(
@@ -5972,8 +6017,8 @@
'attribute' => 'autoplay'
),
'caption' => array(
- 'type' => 'string',
- 'source' => 'html',
+ 'type' => 'rich-text',
+ 'source' => 'rich-text',
'selector' => 'figcaption',
'__experimentalRole' => 'content'
),
@@ -6053,6 +6098,7 @@
'style' => 'wp-block-video'
),
'widget-group' => array(
+ '$schema' => 'https://schemas.wp.org/trunk/block.json',
'apiVersion' => 3,
'name' => 'core/widget-group',
'category' => 'widgets',
diff --git a/src/wp-includes/blocks/button/block.json b/src/wp-includes/blocks/button/block.json
index eec327b4ca48e..f04d4642bb98e 100644
--- a/src/wp-includes/blocks/button/block.json
+++ b/src/wp-includes/blocks/button/block.json
@@ -8,6 +8,7 @@
"description": "Prompt visitors to take action with a button-style link.",
"keywords": [ "link" ],
"textdomain": "default",
+ "usesContext": [ "pattern/overrides" ],
"attributes": {
"tagName": {
"type": "string",
@@ -36,8 +37,8 @@
"__experimentalRole": "content"
},
"text": {
- "type": "string",
- "source": "html",
+ "type": "rich-text",
+ "source": "rich-text",
"selector": "a,button",
"__experimentalRole": "content"
},
diff --git a/src/wp-includes/blocks/calendar.php b/src/wp-includes/blocks/calendar.php
index f1f7967235620..04b888972b1dd 100644
--- a/src/wp-includes/blocks/calendar.php
+++ b/src/wp-includes/blocks/calendar.php
@@ -33,10 +33,8 @@ function render_block_core_calendar( $attributes ) {
str_contains( $permalink_structure, '%monthnum%' ) &&
str_contains( $permalink_structure, '%year%' )
) {
- // phpcs:ignore WordPress.WP.GlobalVariablesOverride.OverrideProhibited
$monthnum = $attributes['month'];
- // phpcs:ignore WordPress.WP.GlobalVariablesOverride.OverrideProhibited
- $year = $attributes['year'];
+ $year = $attributes['year'];
}
}
@@ -70,10 +68,8 @@ function render_block_core_calendar( $attributes ) {
$calendar
);
- // phpcs:ignore WordPress.WP.GlobalVariablesOverride.OverrideProhibited
$monthnum = $previous_monthnum;
- // phpcs:ignore WordPress.WP.GlobalVariablesOverride.OverrideProhibited
- $year = $previous_year;
+ $year = $previous_year;
return $output;
}
diff --git a/src/wp-includes/blocks/categories.php b/src/wp-includes/blocks/categories.php
index 7e3979b7aefe2..c35376505b134 100644
--- a/src/wp-includes/blocks/categories.php
+++ b/src/wp-includes/blocks/categories.php
@@ -70,8 +70,7 @@ function render_block_core_categories( $attributes ) {
function build_dropdown_script_block_core_categories( $dropdown_id ) {
ob_start();
?>
-
', '' ), '', ob_get_clean() ) );
}
/**
diff --git a/src/wp-includes/blocks/code/block.json b/src/wp-includes/blocks/code/block.json
index 80df74b5062b5..bd5db3c918b96 100644
--- a/src/wp-includes/blocks/code/block.json
+++ b/src/wp-includes/blocks/code/block.json
@@ -8,8 +8,8 @@
"textdomain": "default",
"attributes": {
"content": {
- "type": "string",
- "source": "html",
+ "type": "rich-text",
+ "source": "rich-text",
"selector": "code",
"__unstablePreserveWhiteSpace": true
}
diff --git a/src/wp-includes/blocks/comments-title/block.json b/src/wp-includes/blocks/comments-title/block.json
index 12b105afe9a31..4107f5d590cde 100644
--- a/src/wp-includes/blocks/comments-title/block.json
+++ b/src/wp-includes/blocks/comments-title/block.json
@@ -5,7 +5,7 @@
"title": "Comments Title",
"category": "theme",
"ancestor": [ "core/comments" ],
- "description": "Displays a title with the number of comments",
+ "description": "Displays a title with the number of comments.",
"textdomain": "default",
"usesContext": [ "postId", "postType" ],
"attributes": {
diff --git a/src/wp-includes/blocks/cover/block.json b/src/wp-includes/blocks/cover/block.json
index e88dd2d65a372..80562da309899 100644
--- a/src/wp-includes/blocks/cover/block.json
+++ b/src/wp-includes/blocks/cover/block.json
@@ -19,9 +19,6 @@
},
"alt": {
"type": "string",
- "source": "attribute",
- "selector": "img",
- "attribute": "alt",
"default": ""
},
"hasParallax": {
@@ -42,6 +39,9 @@
"customOverlayColor": {
"type": "string"
},
+ "isUserOverlayColor": {
+ "type": "boolean"
+ },
"backgroundType": {
"type": "string",
"default": "image"
@@ -114,6 +114,9 @@
"__experimentalSkipSerialization": [ "gradients" ],
"enableContrastChecker": false
},
+ "dimensions": {
+ "aspectRatio": true
+ },
"typography": {
"fontSize": true,
"lineHeight": true,
diff --git a/src/wp-includes/blocks/details/block.json b/src/wp-includes/blocks/details/block.json
index d449d42e1e10c..a71d3af2a5ed3 100644
--- a/src/wp-includes/blocks/details/block.json
+++ b/src/wp-includes/blocks/details/block.json
@@ -13,8 +13,8 @@
"default": false
},
"summary": {
- "type": "string",
- "source": "html",
+ "type": "rich-text",
+ "source": "rich-text",
"selector": "summary"
}
},
diff --git a/src/wp-includes/blocks/embed/block.json b/src/wp-includes/blocks/embed/block.json
index 9ca54db871db1..5aac8bbd6b8ca 100644
--- a/src/wp-includes/blocks/embed/block.json
+++ b/src/wp-includes/blocks/embed/block.json
@@ -12,8 +12,8 @@
"__experimentalRole": "content"
},
"caption": {
- "type": "string",
- "source": "html",
+ "type": "rich-text",
+ "source": "rich-text",
"selector": "figcaption",
"__experimentalRole": "content"
},
diff --git a/src/wp-includes/blocks/file.php b/src/wp-includes/blocks/file.php
index 042ea89970736..06eb10cf1d895 100644
--- a/src/wp-includes/blocks/file.php
+++ b/src/wp-includes/blocks/file.php
@@ -14,25 +14,8 @@
*
* @return string Returns the block content.
*/
-function render_block_core_file( $attributes, $content, $block ) {
- $should_load_view_script = ! empty( $attributes['displayPreview'] );
- $view_js_file = 'wp-block-file-view';
- // If the script already exists, there is no point in removing it from viewScript.
- if ( ! wp_script_is( $view_js_file ) ) {
- $script_handles = $block->block_type->view_script_handles;
-
- // If the script is not needed, and it is still in the `view_script_handles`, remove it.
- if ( ! $should_load_view_script && in_array( $view_js_file, $script_handles, true ) ) {
- $block->block_type->view_script_handles = array_diff( $script_handles, array( $view_js_file ) );
- }
- // If the script is needed, but it was previously removed, add it again.
- if ( $should_load_view_script && ! in_array( $view_js_file, $script_handles, true ) ) {
- $block->block_type->view_script_handles = array_merge( $script_handles, array( $view_js_file ) );
- }
- }
-
+function render_block_core_file( $attributes, $content ) {
// Update object's aria-label attribute if present in block HTML.
-
// Match an aria-label attribute from an object tag.
$pattern = '@aria-label="(?[^"]+)?")@i';
$content = preg_replace_callback(
@@ -53,13 +36,15 @@ static function ( $matches ) {
$content
);
- // If it uses the Interactivity API, add the directives.
- if ( $should_load_view_script ) {
+ // If it's interactive, enqueue the script module and add the directives.
+ if ( ! empty( $attributes['displayPreview'] ) ) {
+ wp_enqueue_script_module( '@wordpress/block-library/file' );
+
$processor = new WP_HTML_Tag_Processor( $content );
$processor->next_tag();
- $processor->set_attribute( 'data-wp-interactive', '' );
+ $processor->set_attribute( 'data-wp-interactive', '{"namespace":"core/file"}' );
$processor->next_tag( 'object' );
- $processor->set_attribute( 'data-wp-bind--hidden', '!selectors.core.file.hasPdfPreview' );
+ $processor->set_attribute( 'data-wp-bind--hidden', '!state.hasPdfPreview' );
$processor->set_attribute( 'hidden', true );
return $processor->get_updated_html();
}
@@ -67,25 +52,6 @@ static function ( $matches ) {
return $content;
}
-/**
- * Ensure that the view script has the `wp-interactivity` dependency.
- *
- * @since 6.4.0
- *
- * @global WP_Scripts $wp_scripts
- */
-function block_core_file_ensure_interactivity_dependency() {
- global $wp_scripts;
- if (
- isset( $wp_scripts->registered['wp-block-file-view'] ) &&
- ! in_array( 'wp-interactivity', $wp_scripts->registered['wp-block-file-view']->deps, true )
- ) {
- $wp_scripts->registered['wp-block-file-view']->deps[] = 'wp-interactivity';
- }
-}
-
-add_action( 'wp_print_scripts', 'block_core_file_ensure_interactivity_dependency' );
-
/**
* Registers the `core/file` block on server.
*/
@@ -96,5 +62,12 @@ function register_block_core_file() {
'render_callback' => 'render_block_core_file',
)
);
+
+ wp_register_script_module(
+ '@wordpress/block-library/file',
+ defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN ? gutenberg_url( '/build/interactivity/file.min.js' ) : includes_url( 'blocks/file/view.min.js' ),
+ array( '@wordpress/interactivity' ),
+ defined( 'GUTENBERG_VERSION' ) ? GUTENBERG_VERSION : get_bloginfo( 'version' )
+ );
}
add_action( 'init', 'register_block_core_file' );
diff --git a/src/wp-includes/blocks/file/block.json b/src/wp-includes/blocks/file/block.json
index 0cc20b3f501e9..fd5da67d284f4 100644
--- a/src/wp-includes/blocks/file/block.json
+++ b/src/wp-includes/blocks/file/block.json
@@ -21,8 +21,8 @@
"attribute": "id"
},
"fileName": {
- "type": "string",
- "source": "html",
+ "type": "rich-text",
+ "source": "rich-text",
"selector": "a:not([download])"
},
"textLinkHref": {
@@ -42,8 +42,8 @@
"default": true
},
"downloadButtonText": {
- "type": "string",
- "source": "html",
+ "type": "rich-text",
+ "source": "rich-text",
"selector": "a[download]"
},
"displayPreview": {
@@ -72,7 +72,6 @@
},
"interactivity": true
},
- "viewScript": "file:./view.min.js",
"editorStyle": "wp-block-file-editor",
"style": "wp-block-file"
}
diff --git a/src/wp-includes/blocks/file/view.asset.php b/src/wp-includes/blocks/file/view.asset.php
index 31a7a74abccb2..ce536d2611595 100644
--- a/src/wp-includes/blocks/file/view.asset.php
+++ b/src/wp-includes/blocks/file/view.asset.php
@@ -1 +1 @@
- array(), 'version' => '6d205911bc72812dd293');
+ array(), 'version' => '498971a8a9512421f3b5');
diff --git a/src/wp-includes/blocks/file/view.min.asset.php b/src/wp-includes/blocks/file/view.min.asset.php
index 990e381b31921..76f2ca1fbc30c 100644
--- a/src/wp-includes/blocks/file/view.min.asset.php
+++ b/src/wp-includes/blocks/file/view.min.asset.php
@@ -1 +1 @@
- array(), 'version' => '8a0237493a27c0d781aa');
+ array(), 'version' => '9c04187f1796859989c3');
diff --git a/src/wp-includes/blocks/footnotes.php b/src/wp-includes/blocks/footnotes.php
index bc6291dd21c38..0cd2ad73ef3d4 100644
--- a/src/wp-includes/blocks/footnotes.php
+++ b/src/wp-includes/blocks/footnotes.php
@@ -68,17 +68,26 @@ function render_block_core_footnotes( $attributes, $content, $block ) {
* @since 6.3.0
*/
function register_block_core_footnotes() {
- foreach ( array( 'post', 'page' ) as $post_type ) {
- register_post_meta(
- $post_type,
- 'footnotes',
- array(
- 'show_in_rest' => true,
- 'single' => true,
- 'type' => 'string',
- 'revisions_enabled' => true,
- )
- );
+ $post_types = get_post_types(
+ array(
+ 'show_in_rest' => true,
+ 'public' => true,
+ )
+ );
+ foreach ( $post_types as $post_type ) {
+ // Only register the meta field if the post type supports the editor, custom fields, and revisions.
+ if ( post_type_supports( $post_type, 'editor' ) && post_type_supports( $post_type, 'custom-fields' ) && post_type_supports( $post_type, 'revisions' ) ) {
+ register_post_meta(
+ $post_type,
+ 'footnotes',
+ array(
+ 'show_in_rest' => true,
+ 'single' => true,
+ 'type' => 'string',
+ 'revisions_enabled' => true,
+ )
+ );
+ }
}
register_block_type_from_metadata(
__DIR__ . '/footnotes',
diff --git a/src/wp-includes/blocks/footnotes/block.json b/src/wp-includes/blocks/footnotes/block.json
index 28b094f24f916..3192df7796978 100644
--- a/src/wp-includes/blocks/footnotes/block.json
+++ b/src/wp-includes/blocks/footnotes/block.json
@@ -4,7 +4,7 @@
"name": "core/footnotes",
"title": "Footnotes",
"category": "text",
- "description": "",
+ "description": "Display footnotes added to the page.",
"keywords": [ "references" ],
"textdomain": "default",
"usesContext": [ "postId", "postType" ],
@@ -33,6 +33,7 @@
"html": false,
"multiple": false,
"reusable": false,
+ "inserter": false,
"spacing": {
"margin": true,
"padding": true,
diff --git a/src/wp-includes/blocks/gallery.php b/src/wp-includes/blocks/gallery.php
index edde9b4da101a..342264de6fce3 100644
--- a/src/wp-includes/blocks/gallery.php
+++ b/src/wp-includes/blocks/gallery.php
@@ -32,6 +32,21 @@ function block_core_gallery_data_id_backcompatibility( $parsed_block ) {
add_filter( 'render_block_data', 'block_core_gallery_data_id_backcompatibility' );
+/**
+ * Filter to randomize the order of image blocks.
+ *
+ * @param array $parsed_block The block being rendered.
+ * @return array The block object with randomized order of image blocks.
+ */
+function block_core_gallery_random_order( $parsed_block ) {
+ if ( 'core/gallery' === $parsed_block['blockName'] && ! empty( $parsed_block['attrs']['randomOrder'] ) ) {
+ shuffle( $parsed_block['innerBlocks'] );
+ }
+ return $parsed_block;
+}
+
+add_filter( 'render_block_data', 'block_core_gallery_random_order' );
+
/**
* Adds a style tag for the --wp--style--unstable-gallery-gap var.
*
diff --git a/src/wp-includes/blocks/gallery/block.json b/src/wp-includes/blocks/gallery/block.json
index 0867989af4ec7..a5425c55381f9 100644
--- a/src/wp-includes/blocks/gallery/block.json
+++ b/src/wp-includes/blocks/gallery/block.json
@@ -46,8 +46,8 @@
"attribute": "data-id"
},
"caption": {
- "type": "string",
- "source": "html",
+ "type": "rich-text",
+ "source": "rich-text",
"selector": ".blocks-gallery-item__caption"
}
}
@@ -72,14 +72,18 @@
"maximum": 8
},
"caption": {
- "type": "string",
- "source": "html",
+ "type": "rich-text",
+ "source": "rich-text",
"selector": ".blocks-gallery-caption"
},
"imageCrop": {
"type": "boolean",
"default": true
},
+ "randomOrder": {
+ "type": "boolean",
+ "default": false
+ },
"fixedHeight": {
"type": "boolean",
"default": true
diff --git a/src/wp-includes/blocks/group/block.json b/src/wp-includes/blocks/group/block.json
index 4b89d86539117..df59c25a7751f 100644
--- a/src/wp-includes/blocks/group/block.json
+++ b/src/wp-includes/blocks/group/block.json
@@ -24,13 +24,16 @@
"__experimentalOnEnter": true,
"__experimentalOnMerge": true,
"__experimentalSettings": true,
- "__experimentalMetadata": true,
"align": [ "wide", "full" ],
"anchor": true,
"ariaLabel": true,
"html": false,
"background": {
- "backgroundImage": true
+ "backgroundImage": true,
+ "backgroundSize": true,
+ "__experimentalDefaultControls": {
+ "backgroundImage": true
+ }
},
"color": {
"gradients": true,
diff --git a/src/wp-includes/blocks/heading/block.json b/src/wp-includes/blocks/heading/block.json
index 7c018f8472cb4..a1eb3fce32ef1 100644
--- a/src/wp-includes/blocks/heading/block.json
+++ b/src/wp-includes/blocks/heading/block.json
@@ -7,15 +7,15 @@
"description": "Introduce new sections and organize content to help visitors (and search engines) understand the structure of your content.",
"keywords": [ "title", "subtitle" ],
"textdomain": "default",
+ "usesContext": [ "pattern/overrides" ],
"attributes": {
"textAlign": {
"type": "string"
},
"content": {
- "type": "string",
- "source": "html",
+ "type": "rich-text",
+ "source": "rich-text",
"selector": "h1,h2,h3,h4,h5,h6",
- "default": "",
"__experimentalRole": "content"
},
"level": {
@@ -57,9 +57,7 @@
"__experimentalTextDecoration": true,
"__experimentalWritingMode": true,
"__experimentalDefaultControls": {
- "fontSize": true,
- "fontAppearance": true,
- "textTransform": true
+ "fontSize": true
}
},
"__unstablePasteTextInline": true,
diff --git a/src/wp-includes/blocks/image.php b/src/wp-includes/blocks/image.php
index acefd5714bbd4..f926890c1a3fc 100644
--- a/src/wp-includes/blocks/image.php
+++ b/src/wp-includes/blocks/image.php
@@ -37,9 +37,6 @@ function render_block_core_image( $attributes, $content, $block ) {
$link_destination = isset( $attributes['linkDestination'] ) ? $attributes['linkDestination'] : 'none';
$lightbox_settings = block_core_image_get_lightbox_settings( $block->parsed_block );
- $view_js_file_handle = 'wp-block-image-view';
- $script_handles = $block->block_type->view_script_handles;
-
/*
* If the lightbox is enabled and the image is not linked, add the filter
* and the JavaScript view file.
@@ -50,31 +47,22 @@ function render_block_core_image( $attributes, $content, $block ) {
isset( $lightbox_settings['enabled'] ) &&
true === $lightbox_settings['enabled']
) {
- $block->block_type->supports['interactivity'] = true;
-
- if ( ! in_array( $view_js_file_handle, $script_handles, true ) ) {
- $block->block_type->view_script_handles = array_merge( $script_handles, array( $view_js_file_handle ) );
- }
+ wp_enqueue_script_module( '@wordpress/block-library/image' );
/*
- * This render needs to happen in a filter with priority 15 to ensure
- * that it runs after the duotone filter and that duotone styles are
- * applied to the image in the lightbox. We also need to ensure that the
- * lightbox works with any plugins that might use filters as well. We
- * can consider removing this in the future if the way the blocks are
- * rendered changes, or if a new kind of filter is introduced.
+ * This render needs to happen in a filter with priority 15 to ensure that
+ * it runs after the duotone filter and that duotone styles are applied to
+ * the image in the lightbox. Lightbox has to work with any plugins that
+ * might use filters as well. Removing this can be considered in the
+ * future if the way the blocks are rendered changes, or if a
+ * new kind of filter is introduced.
*/
add_filter( 'render_block_core/image', 'block_core_image_render_lightbox', 15, 2 );
} else {
/*
- * Remove the filter and the JavaScript view file if previously added by
- * other Image blocks.
+ * Remove the filter if previously added by other Image blocks.
*/
remove_filter( 'render_block_core/image', 'block_core_image_render_lightbox', 15 );
- // If the script is not needed, and it is still in the `view_script_handles`, remove it.
- if ( in_array( $view_js_file_handle, $script_handles, true ) ) {
- $block->block_type->view_script_handles = array_diff( $script_handles, array( $view_js_file_handle ) );
- }
}
return $processor->get_updated_html();
@@ -93,12 +81,6 @@ function block_core_image_get_lightbox_settings( $block ) {
// Get the lightbox setting from the block attributes.
if ( isset( $block['attrs']['lightbox'] ) ) {
$lightbox_settings = $block['attrs']['lightbox'];
- // If the lightbox setting is not set in the block attributes,
- // check the legacy lightbox settings that are set using the
- // `gutenberg_should_render_lightbox` filter.
- // We can remove this elseif statement when the legacy lightbox settings are removed.
- } elseif ( isset( $block['legacyLightboxSettings'] ) ) {
- $lightbox_settings = $block['legacyLightboxSettings'];
}
if ( ! isset( $lightbox_settings ) ) {
@@ -187,27 +169,23 @@ function block_core_image_render_lightbox( $block_content, $block ) {
$w = new WP_HTML_Tag_Processor( $block_content );
$w->next_tag( 'figure' );
$w->add_class( 'wp-lightbox-container' );
- $w->set_attribute( 'data-wp-interactive', true );
+ $w->set_attribute( 'data-wp-interactive', '{"namespace":"core/image"}' );
$w->set_attribute(
'data-wp-context',
sprintf(
- '{ "core":
- { "image":
- { "imageLoaded": false,
- "initialized": false,
- "lightboxEnabled": false,
- "hideAnimationEnabled": false,
- "preloadInitialized": false,
- "lightboxAnimation": "%s",
- "imageUploadedSrc": "%s",
- "imageCurrentSrc": "",
- "targetWidth": "%s",
- "targetHeight": "%s",
- "scaleAttr": "%s",
- "dialogLabel": "%s"
- }
- }
+ '{ "imageLoaded": false,
+ "initialized": false,
+ "lightboxEnabled": false,
+ "hideAnimationEnabled": false,
+ "preloadInitialized": false,
+ "lightboxAnimation": "%s",
+ "imageUploadedSrc": "%s",
+ "imageCurrentSrc": "",
+ "targetWidth": "%s",
+ "targetHeight": "%s",
+ "scaleAttr": "%s",
+ "dialogLabel": "%s"
}',
$lightbox_animation,
$img_uploaded_src,
@@ -218,14 +196,14 @@ function block_core_image_render_lightbox( $block_content, $block ) {
)
);
$w->next_tag( 'img' );
- $w->set_attribute( 'data-wp-init', 'effects.core.image.initOriginImage' );
- $w->set_attribute( 'data-wp-on--load', 'actions.core.image.handleLoad' );
- $w->set_attribute( 'data-wp-effect', 'effects.core.image.setButtonStyles' );
+ $w->set_attribute( 'data-wp-init', 'callbacks.initOriginImage' );
+ $w->set_attribute( 'data-wp-on--load', 'actions.handleLoad' );
+ $w->set_attribute( 'data-wp-watch', 'callbacks.setButtonStyles' );
// We need to set an event callback on the `img` specifically
// because the `figure` element can also contain a caption, and
// we don't want to trigger the lightbox when the caption is clicked.
- $w->set_attribute( 'data-wp-on--click', 'actions.core.image.showLightbox' );
- $w->set_attribute( 'data-wp-effect--setStylesOnResize', 'effects.core.image.setStylesOnResize' );
+ $w->set_attribute( 'data-wp-on--click', 'actions.showLightbox' );
+ $w->set_attribute( 'data-wp-watch--setStylesOnResize', 'callbacks.setStylesOnResize' );
$body_content = $w->get_updated_html();
// Add a button alongside image in the body content.
@@ -239,9 +217,10 @@ class="lightbox-trigger"
type="button"
aria-haspopup="dialog"
aria-label="' . esc_attr( $aria_label ) . '"
- data-wp-on--click="actions.core.image.showLightbox"
- data-wp-style--right="context.core.image.imageButtonRight"
- data-wp-style--top="context.core.image.imageButtonTop"
+ data-wp-init="callbacks.initTriggerButton"
+ data-wp-on--click="actions.showLightbox"
+ data-wp-style--right="context.imageButtonRight"
+ data-wp-style--top="context.imageButtonTop"
>
+
+HTML;
+ }
+
+ /**
+ * Processes the `data-wp-router-region` directive.
+ *
+ * It renders in the footer a set of HTML elements to notify users about
+ * client-side navigations. More concretely, the elements added are 1) a
+ * top loading bar to visually inform that a navigation is in progress
+ * and 2) an `aria-live` region for accessible navigation announcements.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
+ */
+ private function data_wp_router_region_processor( WP_Interactivity_API_Directives_Processor $p ) {
+ if ( ! $p->is_tag_closer() && ! $this->has_processed_router_region ) {
+ $this->has_processed_router_region = true;
+
+ // Initialize the `core/router` store.
+ $this->state(
+ 'core/router',
+ array(
+ 'navigation' => array(
+ 'texts' => array(
+ 'loading' => __( 'Loading page, please wait.' ),
+ 'loaded' => __( 'Page Loaded.' ),
+ ),
+ ),
+ )
+ );
+
+ // Enqueues as an inline style.
+ wp_register_style( 'wp-interactivity-router-animations', false );
+ wp_add_inline_style( 'wp-interactivity-router-animations', $this->get_router_animation_styles() );
+ wp_enqueue_style( 'wp-interactivity-router-animations' );
+
+ // Adds the necessary markup to the footer.
+ add_action( 'wp_footer', array( $this, 'print_router_loading_and_screen_reader_markup' ) );
+ }
+ }
+
+ /**
+ * Processes the `data-wp-each` directive.
+ *
+ * This directive gets an array passed as reference and iterates over it
+ * generating new content for each item based on the inner markup of the
+ * `template` tag.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
+ * @param array $context_stack The reference to the context stack.
+ * @param array $namespace_stack The reference to the store namespace stack.
+ * @param array $tag_stack The reference to the tag stack.
+ */
+ private function data_wp_each_processor( WP_Interactivity_API_Directives_Processor $p, array &$context_stack, array &$namespace_stack, array &$tag_stack ) {
+ if ( ! $p->is_tag_closer() && 'TEMPLATE' === $p->get_tag() ) {
+ $attribute_name = $p->get_attribute_names_with_prefix( 'data-wp-each' )[0];
+ $extracted_suffix = $this->extract_prefix_and_suffix( $attribute_name );
+ $item_name = isset( $extracted_suffix[1] ) ? $this->kebab_to_camel_case( $extracted_suffix[1] ) : 'item';
+ $attribute_value = $p->get_attribute( $attribute_name );
+ $result = $this->evaluate( $attribute_value, end( $namespace_stack ), end( $context_stack ) );
+
+ // Gets the content between the template tags and leaves the cursor in the closer tag.
+ $inner_content = $p->get_content_between_balanced_template_tags();
+
+ // Checks if there is a manual server-side directive processing.
+ $template_end = 'data-wp-each: template end';
+ $p->set_bookmark( $template_end );
+ $p->next_tag();
+ $manual_sdp = $p->get_attribute( 'data-wp-each-child' );
+ $p->seek( $template_end ); // Rewinds to the template closer tag.
+ $p->release_bookmark( $template_end );
+
+ /*
+ * It doesn't process in these situations:
+ * - Manual server-side directive processing.
+ * - Empty or non-array values.
+ * - Associative arrays because those are deserialized as objects in JS.
+ * - Templates that contain top-level texts because those texts can't be
+ * identified and removed in the client.
+ */
+ if (
+ $manual_sdp ||
+ empty( $result ) ||
+ ! is_array( $result ) ||
+ ! array_is_list( $result ) ||
+ ! str_starts_with( trim( $inner_content ), '<' ) ||
+ ! str_ends_with( trim( $inner_content ), '>' )
+ ) {
+ array_pop( $tag_stack );
+ return;
+ }
+
+ // Extracts the namespace from the directive attribute value.
+ $namespace_value = end( $namespace_stack );
+ list( $namespace_value ) = is_string( $attribute_value ) && ! empty( $attribute_value )
+ ? $this->extract_directive_value( $attribute_value, $namespace_value )
+ : array( $namespace_value, null );
+
+ // Processes the inner content for each item of the array.
+ $processed_content = '';
+ foreach ( $result as $item ) {
+ // Creates a new context that includes the current item of the array.
+ $context_stack[] = array_replace_recursive(
+ end( $context_stack ) !== false ? end( $context_stack ) : array(),
+ array( $namespace_value => array( $item_name => $item ) )
+ );
+
+ // Processes the inner content with the new context.
+ $processed_item = $this->process_directives_args( $inner_content, $context_stack, $namespace_stack );
+
+ if ( null === $processed_item ) {
+ // If the HTML is unbalanced, stop processing it.
+ array_pop( $context_stack );
+ return;
+ }
+
+ // Adds the `data-wp-each-child` to each top-level tag.
+ $i = new WP_Interactivity_API_Directives_Processor( $processed_item );
+ while ( $i->next_tag() ) {
+ $i->set_attribute( 'data-wp-each-child', true );
+ $i->next_balanced_tag_closer_tag();
+ }
+ $processed_content .= $i->get_updated_html();
+
+ // Removes the current context from the stack.
+ array_pop( $context_stack );
+ }
+
+ // Appends the processed content after the tag closer of the template.
+ $p->append_content_after_template_tag_closer( $processed_content );
+
+ // Pops the last tag because it skipped the closing tag of the template tag.
+ array_pop( $tag_stack );
+ }
+ }
+}
diff --git a/src/wp-includes/interactivity-api/interactivity-api.php b/src/wp-includes/interactivity-api/interactivity-api.php
new file mode 100644
index 0000000000000..548fcc3638fb7
--- /dev/null
+++ b/src/wp-includes/interactivity-api/interactivity-api.php
@@ -0,0 +1,166 @@
+get_registered( $block_name );
+
+ if (
+ isset( $block_name ) &&
+ ( ( isset( $block_type->supports['interactivity'] ) && true === $block_type->supports['interactivity'] ) ||
+ ( isset( $block_type->supports['interactivity']['interactive'] ) && true === $block_type->supports['interactivity']['interactive'] ) )
+ ) {
+ // Annotates the root interactive block for processing.
+ $root_interactive_block = array( $block_name, $parsed_block );
+
+ /*
+ * Adds a filter to process the root interactive block once it has
+ * finished rendering.
+ */
+ $process_interactive_blocks = static function ( string $content, array $parsed_block ) use ( &$root_interactive_block, &$process_interactive_blocks ): string {
+ // Checks whether the current block is the root interactive block.
+ list($root_block_name, $root_parsed_block) = $root_interactive_block;
+ if ( $root_block_name === $parsed_block['blockName'] && $parsed_block === $root_parsed_block ) {
+ // The root interactive blocks has finished rendering, process it.
+ $content = wp_interactivity_process_directives( $content );
+ // Removes the filter and reset the root interactive block.
+ remove_filter( 'render_block_' . $parsed_block['blockName'], $process_interactive_blocks );
+ $root_interactive_block = null;
+ }
+ return $content;
+ };
+
+ /*
+ * Uses a priority of 20 to ensure that other filters can add additional
+ * directives before the processing starts.
+ */
+ add_filter( 'render_block_' . $block_name, $process_interactive_blocks, 20, 2 );
+ }
+ }
+
+ return $parsed_block;
+}
+add_filter( 'render_block_data', 'wp_interactivity_process_directives_of_interactive_blocks' );
+
+/**
+ * Retrieves the main WP_Interactivity_API instance.
+ *
+ * It provides access to the WP_Interactivity_API instance, creating one if it
+ * doesn't exist yet.
+ *
+ * @global WP_Interactivity_API $wp_interactivity
+ *
+ * @since 6.5.0
+ *
+ * @return WP_Interactivity_API The main WP_Interactivity_API instance.
+ */
+function wp_interactivity(): WP_Interactivity_API {
+ global $wp_interactivity;
+ if ( ! ( $wp_interactivity instanceof WP_Interactivity_API ) ) {
+ $wp_interactivity = new WP_Interactivity_API();
+ }
+ return $wp_interactivity;
+}
+
+/**
+ * Processes the interactivity directives contained within the HTML content
+ * and updates the markup accordingly.
+ *
+ * @since 6.5.0
+ *
+ * @param string $html The HTML content to process.
+ * @return string The processed HTML content. It returns the original content when the HTML contains unbalanced tags.
+ */
+function wp_interactivity_process_directives( string $html ): string {
+ return wp_interactivity()->process_directives( $html );
+}
+
+/**
+ * Gets and/or sets the initial state of an Interactivity API store for a
+ * given namespace.
+ *
+ * If state for that store namespace already exists, it merges the new
+ * provided state with the existing one.
+ *
+ * @since 6.5.0
+ *
+ * @param string $store_namespace The unique store namespace identifier.
+ * @param array $state Optional. The array that will be merged with the existing state for the specified
+ * store namespace.
+ * @return array The state for the specified store namespace. This will be the updated state if a $state argument was
+ * provided.
+ */
+function wp_interactivity_state( string $store_namespace, array $state = array() ): array {
+ return wp_interactivity()->state( $store_namespace, $state );
+}
+
+/**
+ * Gets and/or sets the configuration of the Interactivity API for a given
+ * store namespace.
+ *
+ * If configuration for that store namespace exists, it merges the new
+ * provided configuration with the existing one.
+ *
+ * @since 6.5.0
+ *
+ * @param string $store_namespace The unique store namespace identifier.
+ * @param array $config Optional. The array that will be merged with the existing configuration for the
+ * specified store namespace.
+ * @return array The configuration for the specified store namespace. This will be the updated configuration if a
+ * $config argument was provided.
+ */
+function wp_interactivity_config( string $store_namespace, array $config = array() ): array {
+ return wp_interactivity()->config( $store_namespace, $config );
+}
+
+/**
+ * Generates a `data-wp-context` directive attribute by encoding a context
+ * array.
+ *
+ * This helper function simplifies the creation of `data-wp-context` directives
+ * by providing a way to pass an array of data, which encodes into a JSON string
+ * safe for direct use as a HTML attribute value.
+ *
+ * Example:
+ *
+ *
true, 'count' => 0 ) ); ?>>
+ *
+ * @since 6.5.0
+ *
+ * @param array $context The array of context data to encode.
+ * @param string $store_namespace Optional. The unique store namespace identifier.
+ * @return string A complete `data-wp-context` directive with a JSON encoded value representing the context array and
+ * the store namespace if specified.
+ */
+function data_wp_context( array $context, string $store_namespace = '' ): string {
+ return 'data-wp-context=\'' .
+ ( $store_namespace ? $store_namespace . '::' : '' ) .
+ ( empty( $context ) ? '{}' : wp_json_encode( $context, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP ) ) .
+ '\'';
+}
diff --git a/src/wp-includes/l10n.php b/src/wp-includes/l10n.php
index 726e3da1a5a56..8191b88cee840 100644
--- a/src/wp-includes/l10n.php
+++ b/src/wp-includes/l10n.php
@@ -789,32 +789,71 @@ function load_textdomain( $domain, $mofile, $locale = null ) {
*/
$mofile = apply_filters( 'load_textdomain_mofile', $mofile, $domain );
- if ( ! is_readable( $mofile ) ) {
- return false;
- }
-
if ( ! $locale ) {
$locale = determine_locale();
}
- $mo = new MO();
- if ( ! $mo->import_from_file( $mofile ) ) {
- $wp_textdomain_registry->set( $domain, $locale, false );
+ $i18n_controller = WP_Translation_Controller::get_instance();
- return false;
+ // Ensures the correct locale is set as the current one, in case it was filtered.
+ $i18n_controller->set_locale( $locale );
+
+ /**
+ * Filters the preferred file format for translation files.
+ *
+ * Can be used to disable the use of PHP files for translations.
+ *
+ * @since 6.5.0
+ *
+ * @param string $preferred_format Preferred file format. Possible values: 'php', 'mo'. Default: 'php'.
+ * @param string $domain The text domain.
+ */
+ $preferred_format = apply_filters( 'translation_file_format', 'php', $domain );
+ if ( ! in_array( $preferred_format, array( 'php', 'mo' ), true ) ) {
+ $preferred_format = 'php';
}
- if ( isset( $l10n[ $domain ] ) ) {
- $mo->merge_with( $l10n[ $domain ] );
+ $translation_files = array();
+
+ if ( 'mo' !== $preferred_format ) {
+ $translation_files[] = substr_replace( $mofile, ".l10n.$preferred_format", - strlen( '.mo' ) );
}
- unset( $l10n_unloaded[ $domain ] );
+ $translation_files[] = $mofile;
- $l10n[ $domain ] = &$mo;
+ foreach ( $translation_files as $file ) {
+ /**
+ * Filters the file path for loading translations for the given text domain.
+ *
+ * Similar to the {@see 'load_textdomain_mofile'} filter with the difference that
+ * the file path could be for an MO or PHP file.
+ *
+ * @since 6.5.0
+ *
+ * @param string $file Path to the translation file to load.
+ * @param string $domain The text domain.
+ */
+ $file = (string) apply_filters( 'load_translation_file', $file, $domain );
- $wp_textdomain_registry->set( $domain, $locale, dirname( $mofile ) );
+ $success = $i18n_controller->load_file( $file, $domain, $locale );
- return true;
+ if ( $success ) {
+ if ( isset( $l10n[ $domain ] ) && $l10n[ $domain ] instanceof MO ) {
+ $i18n_controller->load_file( $l10n[ $domain ]->get_filename(), $domain, $locale );
+ }
+
+ // Unset NOOP_Translations reference in get_translations_for_domain().
+ unset( $l10n[ $domain ] );
+
+ $l10n[ $domain ] = new WP_Translations( $i18n_controller, $domain );
+
+ $wp_textdomain_registry->set( $domain, $locale, dirname( $file ) );
+
+ return true;
+ }
+ }
+
+ return false;
}
/**
@@ -866,6 +905,11 @@ function unload_textdomain( $domain, $reloadable = false ) {
*/
do_action( 'unload_textdomain', $domain, $reloadable );
+ // Since multiple locales are supported, reloadable text domains don't actually need to be unloaded.
+ if ( ! $reloadable ) {
+ WP_Translation_Controller::get_instance()->unload_textdomain( $domain );
+ }
+
if ( isset( $l10n[ $domain ] ) ) {
if ( $l10n[ $domain ] instanceof NOOP_Translations ) {
unset( $l10n[ $domain ] );
@@ -904,7 +948,7 @@ function load_default_textdomain( $locale = null ) {
}
// Unload previously loaded strings so we can switch translations.
- unload_textdomain( 'default' );
+ unload_textdomain( 'default', true );
$return = load_textdomain( 'default', WP_LANG_DIR . "/$locale.mo", $locale );
diff --git a/src/wp-includes/l10n/class-wp-translation-controller.php b/src/wp-includes/l10n/class-wp-translation-controller.php
new file mode 100644
index 0000000000000..b44384c013dcd
--- /dev/null
+++ b/src/wp-includes/l10n/class-wp-translation-controller.php
@@ -0,0 +1,437 @@
+ [ Textdomain => [ ..., ... ] ] ]
+ *
+ * @since 6.5.0
+ * @var array>
+ */
+ protected $loaded_translations = array();
+
+ /**
+ * List of loaded translation files.
+ *
+ * [ Filename => [ Locale => [ Textdomain => WP_Translation_File ] ] ]
+ *
+ * @since 6.5.0
+ * @var array>>
+ */
+ protected $loaded_files = array();
+
+ /**
+ * Container for the main instance of the class.
+ *
+ * @since 6.5.0
+ * @var WP_Translation_Controller|null
+ */
+ private static $instance = null;
+
+ /**
+ * Utility method to retrieve the main instance of the class.
+ *
+ * The instance will be created if it does not exist yet.
+ *
+ * @since 6.5.0
+ *
+ * @return WP_Translation_Controller
+ */
+ public static function get_instance(): WP_Translation_Controller {
+ if ( null === self::$instance ) {
+ self::$instance = new self();
+ }
+
+ return self::$instance;
+ }
+
+ /**
+ * Returns the current locale.
+ *
+ * @since 6.5.0
+ *
+ * @return string Locale.
+ */
+ public function get_locale(): string {
+ return $this->current_locale;
+ }
+
+ /**
+ * Sets the current locale.
+ *
+ * @since 6.5.0
+ *
+ * @param string $locale Locale.
+ */
+ public function set_locale( string $locale ) {
+ $this->current_locale = $locale;
+ }
+
+ /**
+ * Loads a translation file for a given text domain.
+ *
+ * @since 6.5.0
+ *
+ * @param string $translation_file Translation file.
+ * @param string $textdomain Optional. Text domain. Default 'default'.
+ * @param string $locale Optional. Locale. Default current locale.
+ * @return bool True on success, false otherwise.
+ */
+ public function load_file( string $translation_file, string $textdomain = 'default', string $locale = null ): bool {
+ if ( null === $locale ) {
+ $locale = $this->current_locale;
+ }
+
+ $translation_file = realpath( $translation_file );
+
+ if ( false === $translation_file ) {
+ return false;
+ }
+
+ if (
+ isset( $this->loaded_files[ $translation_file ][ $locale ][ $textdomain ] ) &&
+ false !== $this->loaded_files[ $translation_file ][ $locale ][ $textdomain ]
+ ) {
+ return null === $this->loaded_files[ $translation_file ][ $locale ][ $textdomain ]->error();
+ }
+
+ if (
+ isset( $this->loaded_files[ $translation_file ][ $locale ] ) &&
+ array() !== $this->loaded_files[ $translation_file ][ $locale ]
+ ) {
+ $moe = reset( $this->loaded_files[ $translation_file ][ $locale ] );
+ } else {
+ $moe = WP_Translation_File::create( $translation_file );
+ if ( false === $moe || null !== $moe->error() ) {
+ $moe = false;
+ }
+ }
+
+ $this->loaded_files[ $translation_file ][ $locale ][ $textdomain ] = $moe;
+
+ if ( ! $moe instanceof WP_Translation_File ) {
+ return false;
+ }
+
+ if ( ! isset( $this->loaded_translations[ $locale ][ $textdomain ] ) ) {
+ $this->loaded_translations[ $locale ][ $textdomain ] = array();
+ }
+
+ $this->loaded_translations[ $locale ][ $textdomain ][] = $moe;
+
+ return true;
+ }
+
+ /**
+ * Unloads a translation file for a given text domain.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Translation_File|string $file Translation file instance or file name.
+ * @param string $textdomain Optional. Text domain. Default 'default'.
+ * @param string $locale Optional. Locale. Defaults to all locales.
+ * @return bool True on success, false otherwise.
+ */
+ public function unload_file( $file, string $textdomain = 'default', string $locale = null ): bool {
+ if ( is_string( $file ) ) {
+ $file = realpath( $file );
+ }
+
+ if ( null !== $locale ) {
+ if ( isset( $this->loaded_translations[ $locale ][ $textdomain ] ) ) {
+ foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $i => $moe ) {
+ if ( $file === $moe || $file === $moe->get_file() ) {
+ unset( $this->loaded_translations[ $locale ][ $textdomain ][ $i ] );
+ unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );
+ return true;
+ }
+ }
+ }
+
+ return true;
+ }
+
+ foreach ( $this->loaded_translations as $l => $domains ) {
+ if ( ! isset( $domains[ $textdomain ] ) ) {
+ continue;
+ }
+
+ foreach ( $domains[ $textdomain ] as $i => $moe ) {
+ if ( $file === $moe || $file === $moe->get_file() ) {
+ unset( $this->loaded_translations[ $l ][ $textdomain ][ $i ] );
+ unset( $this->loaded_files[ $moe->get_file() ][ $l ][ $textdomain ] );
+ return true;
+ }
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Unloads all translation files for a given text domain.
+ *
+ * @since 6.5.0
+ *
+ * @param string $textdomain Optional. Text domain. Default 'default'.
+ * @param string $locale Optional. Locale. Defaults to all locales.
+ * @return bool True on success, false otherwise.
+ */
+ public function unload_textdomain( string $textdomain = 'default', string $locale = null ): bool {
+ $unloaded = false;
+
+ if ( null !== $locale ) {
+ if ( isset( $this->loaded_translations[ $locale ][ $textdomain ] ) ) {
+ $unloaded = true;
+ foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $moe ) {
+ unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );
+ }
+ }
+
+ unset( $this->loaded_translations[ $locale ][ $textdomain ] );
+
+ return $unloaded;
+ }
+
+ foreach ( $this->loaded_translations as $l => $domains ) {
+ if ( ! isset( $domains[ $textdomain ] ) ) {
+ continue;
+ }
+
+ $unloaded = true;
+
+ foreach ( $domains[ $textdomain ] as $moe ) {
+ unset( $this->loaded_files[ $moe->get_file() ][ $l ][ $textdomain ] );
+ }
+
+ unset( $this->loaded_translations[ $l ][ $textdomain ] );
+ }
+
+ return $unloaded;
+ }
+
+ /**
+ * Determines whether translations are loaded for a given text domain.
+ *
+ * @since 6.5.0
+ *
+ * @param string $textdomain Optional. Text domain. Default 'default'.
+ * @param string $locale Optional. Locale. Default current locale.
+ * @return bool True if there are any loaded translations, false otherwise.
+ */
+ public function is_textdomain_loaded( string $textdomain = 'default', string $locale = null ): bool {
+ if ( null === $locale ) {
+ $locale = $this->current_locale;
+ }
+
+ return isset( $this->loaded_translations[ $locale ][ $textdomain ] ) &&
+ array() !== $this->loaded_translations[ $locale ][ $textdomain ];
+ }
+
+ /**
+ * Translates a singular string.
+ *
+ * @since 6.5.0
+ *
+ * @param string $text Text to translate.
+ * @param string $context Optional. Context for the string. Default empty string.
+ * @param string $textdomain Optional. Text domain. Default 'default'.
+ * @param string $locale Optional. Locale. Default current locale.
+ * @return string|false Translation on success, false otherwise.
+ */
+ public function translate( string $text, string $context = '', string $textdomain = 'default', string $locale = null ) {
+ if ( '' !== $context ) {
+ $context .= "\4";
+ }
+
+ $translation = $this->locate_translation( "{$context}{$text}", $textdomain, $locale );
+
+ if ( false === $translation ) {
+ return false;
+ }
+
+ return $translation['entries'][0];
+ }
+
+ /**
+ * Translates plurals.
+ *
+ * Checks both singular+plural combinations as well as just singulars,
+ * in case the translation file does not store the plural.
+ *
+ * @since 6.5.0
+ *
+ * @param array{0: string, 1: string} $plurals {
+ * Pair of singular and plural translations.
+ *
+ * @type string $0 Singular translation.
+ * @type string $1 Plural translation.
+ * }
+ * @param int $number Number of items.
+ * @param string $context Optional. Context for the string. Default empty string.
+ * @param string $textdomain Optional. Text domain. Default 'default'.
+ * @param string $locale Optional. Locale. Default current locale.
+ * @return string|false Translation on success, false otherwise.
+ */
+ public function translate_plural( array $plurals, int $number, string $context = '', string $textdomain = 'default', string $locale = null ) {
+ if ( '' !== $context ) {
+ $context .= "\4";
+ }
+
+ $text = implode( "\0", $plurals );
+ $translation = $this->locate_translation( "{$context}{$text}", $textdomain, $locale );
+
+ if ( false === $translation ) {
+ $text = $plurals[0];
+ $translation = $this->locate_translation( "{$context}{$text}", $textdomain, $locale );
+
+ if ( false === $translation ) {
+ return false;
+ }
+ }
+
+ /** @var WP_Translation_File $source */
+ $source = $translation['source'];
+ $num = $source->get_plural_form( $number );
+
+ // See \Translations::translate_plural().
+ return $translation['entries'][ $num ] ?? $translation['entries'][0];
+ }
+
+ /**
+ * Returns all existing headers for a given text domain.
+ *
+ * @since 6.5.0
+ *
+ * @param string $textdomain Optional. Text domain. Default 'default'.
+ * @return array Headers.
+ */
+ public function get_headers( string $textdomain = 'default' ): array {
+ if ( array() === $this->loaded_translations ) {
+ return array();
+ }
+
+ $headers = array();
+
+ foreach ( $this->get_files( $textdomain ) as $moe ) {
+ foreach ( $moe->headers() as $header => $value ) {
+ $headers[ $this->normalize_header( $header ) ] = $value;
+ }
+ }
+
+ return $headers;
+ }
+
+ /**
+ * Normalizes header names to be capitalized.
+ *
+ * @since 6.5.0
+ *
+ * @param string $header Header name.
+ * @return string Normalized header name.
+ */
+ protected function normalize_header( string $header ): string {
+ $parts = explode( '-', $header );
+ $parts = array_map( 'ucfirst', $parts );
+ return implode( '-', $parts );
+ }
+
+ /**
+ * Returns all entries for a given text domain.
+ *
+ * @since 6.5.0
+ *
+ * @param string $textdomain Optional. Text domain. Default 'default'.
+ * @return array Entries.
+ */
+ public function get_entries( string $textdomain = 'default' ): array {
+ if ( array() === $this->loaded_translations ) {
+ return array();
+ }
+
+ $entries = array();
+
+ foreach ( $this->get_files( $textdomain ) as $moe ) {
+ $entries = array_merge( $entries, $moe->entries() );
+ }
+
+ return $entries;
+ }
+
+ /**
+ * Locates translation for a given string and text domain.
+ *
+ * @since 6.5.0
+ *
+ * @param string $singular Singular translation.
+ * @param string $textdomain Optional. Text domain. Default 'default'.
+ * @param string $locale Optional. Locale. Default current locale.
+ * @return array{source: WP_Translation_File, entries: string[]}|false {
+ * Translations on success, false otherwise.
+ *
+ * @type WP_Translation_File $source Translation file instance.
+ * @type string[] $entries Array of translation entries.
+ * }
+ */
+ protected function locate_translation( string $singular, string $textdomain = 'default', string $locale = null ) {
+ if ( array() === $this->loaded_translations ) {
+ return false;
+ }
+
+ // Find the translation in all loaded files for this text domain.
+ foreach ( $this->get_files( $textdomain, $locale ) as $moe ) {
+ $translation = $moe->translate( $singular );
+ if ( false !== $translation ) {
+ return array(
+ 'entries' => explode( "\0", $translation ),
+ 'source' => $moe,
+ );
+ }
+ if ( null !== $moe->error() ) {
+ // Unload this file, something is wrong.
+ $this->unload_file( $moe, $textdomain, $locale );
+ }
+ }
+
+ // Nothing could be found.
+ return false;
+ }
+
+ /**
+ * Returns all translation files for a given text domain.
+ *
+ * @since 6.5.0
+ *
+ * @param string $textdomain Optional. Text domain. Default 'default'.
+ * @param string $locale Optional. Locale. Default current locale.
+ * @return WP_Translation_File[] List of translation files.
+ */
+ protected function get_files( string $textdomain = 'default', string $locale = null ): array {
+ if ( null === $locale ) {
+ $locale = $this->current_locale;
+ }
+
+ return $this->loaded_translations[ $locale ][ $textdomain ] ?? array();
+ }
+}
diff --git a/src/wp-includes/l10n/class-wp-translation-file-mo.php b/src/wp-includes/l10n/class-wp-translation-file-mo.php
new file mode 100644
index 0000000000000..bf39cc70ec38b
--- /dev/null
+++ b/src/wp-includes/l10n/class-wp-translation-file-mo.php
@@ -0,0 +1,227 @@
+error = 'Magic marker does not exist';
+ return false;
+ }
+
+ /**
+ * Parses the file.
+ *
+ * @since 6.5.0
+ *
+ * @return bool True on success, false otherwise.
+ */
+ protected function parse_file(): bool {
+ $this->parsed = true;
+
+ $file_contents = file_get_contents( $this->file ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+
+ if ( false === $file_contents ) {
+ return false;
+ }
+
+ $file_length = strlen( $file_contents );
+
+ if ( $file_length < 24 ) {
+ $this->error = 'Invalid data';
+ return false;
+ }
+
+ $this->uint32 = $this->detect_endian_and_validate_file( substr( $file_contents, 0, 4 ) );
+
+ if ( false === $this->uint32 ) {
+ return false;
+ }
+
+ $offsets = substr( $file_contents, 4, 24 );
+
+ if ( false === $offsets ) {
+ return false;
+ }
+
+ $offsets = unpack( "{$this->uint32}rev/{$this->uint32}total/{$this->uint32}originals_addr/{$this->uint32}translations_addr/{$this->uint32}hash_length/{$this->uint32}hash_addr", $offsets );
+
+ if ( false === $offsets ) {
+ return false;
+ }
+
+ $offsets['originals_length'] = $offsets['translations_addr'] - $offsets['originals_addr'];
+ $offsets['translations_length'] = $offsets['hash_addr'] - $offsets['translations_addr'];
+
+ if ( $offsets['rev'] > 0 ) {
+ $this->error = 'Unsupported revision';
+ return false;
+ }
+
+ if ( $offsets['translations_addr'] > $file_length || $offsets['originals_addr'] > $file_length ) {
+ $this->error = 'Invalid data';
+ return false;
+ }
+
+ // Load the Originals.
+ $original_data = str_split( substr( $file_contents, $offsets['originals_addr'], $offsets['originals_length'] ), 8 );
+ $translations_data = str_split( substr( $file_contents, $offsets['translations_addr'], $offsets['translations_length'] ), 8 );
+
+ foreach ( array_keys( $original_data ) as $i ) {
+ $o = unpack( "{$this->uint32}length/{$this->uint32}pos", $original_data[ $i ] );
+ $t = unpack( "{$this->uint32}length/{$this->uint32}pos", $translations_data[ $i ] );
+
+ if ( false === $o || false === $t ) {
+ continue;
+ }
+
+ $original = substr( $file_contents, $o['pos'], $o['length'] );
+ $translation = substr( $file_contents, $t['pos'], $t['length'] );
+ // GlotPress bug.
+ $translation = rtrim( $translation, "\0" );
+
+ // Metadata about the MO file is stored in the first translation entry.
+ if ( '' === $original ) {
+ foreach ( explode( "\n", $translation ) as $meta_line ) {
+ if ( '' === $meta_line ) {
+ continue;
+ }
+
+ list( $name, $value ) = array_map( 'trim', explode( ':', $meta_line, 2 ) );
+
+ $this->headers[ strtolower( $name ) ] = $value;
+ }
+ } else {
+ /*
+ * In MO files, the key normally contains both singular and plural versions.
+ * However, this just adds the singular string for lookup,
+ * which caters for cases where both __( 'Product' ) and _n( 'Product', 'Products' )
+ * are used and the translation is expected to be the same for both.
+ */
+ $parts = explode( "\0", (string) $original );
+
+ $this->entries[ $parts[0] ] = $translation;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Exports translation contents as a string.
+ *
+ * @since 6.5.0
+ *
+ * @return string Translation file contents.
+ */
+ public function export(): string {
+ // Prefix the headers as the first key.
+ $headers_string = '';
+ foreach ( $this->headers as $header => $value ) {
+ $headers_string .= "{$header}: $value\n";
+ }
+ $entries = array_merge( array( '' => $headers_string ), $this->entries );
+ $entry_count = count( $entries );
+
+ if ( false === $this->uint32 ) {
+ $this->uint32 = 'V';
+ }
+
+ $bytes_for_entries = $entry_count * 4 * 2;
+ // Pair of 32bit ints per entry.
+ $originals_addr = 28; /* header */
+ $translations_addr = $originals_addr + $bytes_for_entries;
+ $hash_addr = $translations_addr + $bytes_for_entries;
+ $entry_offsets = $hash_addr;
+
+ $file_header = pack( $this->uint32 . '*', self::MAGIC_MARKER, 0 /* rev */, $entry_count, $originals_addr, $translations_addr, 0 /* hash_length */, $hash_addr );
+
+ $o_entries = '';
+ $t_entries = '';
+ $o_addr = '';
+ $t_addr = '';
+
+ foreach ( array_keys( $entries ) as $original ) {
+ $o_addr .= pack( $this->uint32 . '*', strlen( $original ), $entry_offsets );
+ $entry_offsets += strlen( $original ) + 1;
+ $o_entries .= $original . "\0";
+ }
+
+ foreach ( $entries as $translations ) {
+ $t_addr .= pack( $this->uint32 . '*', strlen( $translations ), $entry_offsets );
+ $entry_offsets += strlen( $translations ) + 1;
+ $t_entries .= $translations . "\0";
+ }
+
+ return $file_header . $o_addr . $t_addr . $o_entries . $t_entries;
+ }
+}
diff --git a/src/wp-includes/l10n/class-wp-translation-file-php.php b/src/wp-includes/l10n/class-wp-translation-file-php.php
new file mode 100644
index 0000000000000..f93dd0163fddc
--- /dev/null
+++ b/src/wp-includes/l10n/class-wp-translation-file-php.php
@@ -0,0 +1,79 @@
+parsed = true;
+
+ $result = include $this->file;
+ if ( ! $result || ! is_array( $result ) ) {
+ $this->error = 'Invalid data';
+ return;
+ }
+
+ if ( isset( $result['messages'] ) && is_array( $result['messages'] ) ) {
+ foreach ( $result['messages'] as $original => $translation ) {
+ $this->entries[ (string) $original ] = $translation;
+ }
+ unset( $result['messages'] );
+ }
+
+ $this->headers = array_change_key_case( $result );
+ }
+
+ /**
+ * Exports translation contents as a string.
+ *
+ * @since 6.5.0
+ *
+ * @return string Translation file contents.
+ */
+ public function export(): string {
+ $data = array_merge( $this->headers, array( 'messages' => $this->entries ) );
+
+ return 'var_export( $data ) . ';' . PHP_EOL;
+ }
+
+ /**
+ * Outputs or returns a parsable string representation of a variable.
+ *
+ * Like {@see var_export()} but "minified", using short array syntax
+ * and no newlines.
+ *
+ * @since 6.5.0
+ *
+ * @param mixed $value The variable you want to export.
+ * @return string The variable representation.
+ */
+ private function var_export( $value ): string {
+ if ( ! is_array( $value ) ) {
+ return var_export( $value, true );
+ }
+
+ $entries = array();
+
+ $is_list = array_is_list( $value );
+
+ foreach ( $value as $key => $val ) {
+ $entries[] = $is_list ? $this->var_export( $val ) : var_export( $key, true ) . '=>' . $this->var_export( $val );
+ }
+
+ return '[' . implode( ',', $entries ) . ']';
+ }
+}
diff --git a/src/wp-includes/l10n/class-wp-translation-file.php b/src/wp-includes/l10n/class-wp-translation-file.php
new file mode 100644
index 0000000000000..e550f9c2f042a
--- /dev/null
+++ b/src/wp-includes/l10n/class-wp-translation-file.php
@@ -0,0 +1,312 @@
+
+ */
+ protected $headers = array();
+
+ /**
+ * Whether file has been parsed.
+ *
+ * @since 6.5.0
+ * @var bool
+ */
+ protected $parsed = false;
+
+ /**
+ * Error information.
+ *
+ * @since 6.5.0
+ * @var string|null Error message or null if no error.
+ */
+ protected $error;
+
+ /**
+ * File name.
+ *
+ * @since 6.5.0
+ * @var string
+ */
+ protected $file = '';
+
+ /**
+ * Translation entries.
+ *
+ * @since 6.5.0
+ * @var array
+ */
+ protected $entries = array();
+
+ /**
+ * Plural forms function.
+ *
+ * @since 6.5.0
+ * @var callable|null Plural forms.
+ */
+ protected $plural_forms = null;
+
+ /**
+ * Constructor.
+ *
+ * @since 6.5.0
+ *
+ * @param string $file File to load.
+ */
+ protected function __construct( string $file ) {
+ $this->file = $file;
+ }
+
+ /**
+ * Creates a new WP_Translation_File instance for a given file.
+ *
+ * @since 6.5.0
+ *
+ * @param string $file File name.
+ * @param string|null $filetype Optional. File type. Default inferred from file name.
+ * @return false|WP_Translation_File
+ */
+ public static function create( string $file, string $filetype = null ) {
+ if ( ! is_readable( $file ) ) {
+ return false;
+ }
+
+ if ( null === $filetype ) {
+ $pos = strrpos( $file, '.' );
+ if ( false !== $pos ) {
+ $filetype = substr( $file, $pos + 1 );
+ }
+ }
+
+ switch ( $filetype ) {
+ case 'mo':
+ return new WP_Translation_File_MO( $file );
+ case 'php':
+ return new WP_Translation_File_PHP( $file );
+ default:
+ return false;
+ }
+ }
+
+ /**
+ * Creates a new WP_Translation_File instance for a given file.
+ *
+ * @since 6.5.0
+ *
+ * @param string $file Source file name.
+ * @param string $filetype Desired target file type.
+ * @return string|false Transformed translation file contents on success, false otherwise.
+ */
+ public static function transform( string $file, string $filetype ) {
+ $source = self::create( $file );
+
+ if ( false === $source ) {
+ return false;
+ }
+
+ switch ( $filetype ) {
+ case 'mo':
+ $destination = new WP_Translation_File_MO( '' );
+ break;
+ case 'php':
+ $destination = new WP_Translation_File_PHP( '' );
+ break;
+ default:
+ return false;
+ }
+
+ $success = $destination->import( $source );
+
+ if ( ! $success ) {
+ return false;
+ }
+
+ return $destination->export();
+ }
+
+ /**
+ * Returns all headers.
+ *
+ * @since 6.5.0
+ *
+ * @return array Headers.
+ */
+ public function headers(): array {
+ if ( ! $this->parsed ) {
+ $this->parse_file();
+ }
+ return $this->headers;
+ }
+
+ /**
+ * Returns all entries.
+ *
+ * @since 6.5.0
+ *
+ * @return array Entries.
+ */
+ public function entries(): array {
+ if ( ! $this->parsed ) {
+ $this->parse_file();
+ }
+
+ return $this->entries;
+ }
+
+ /**
+ * Returns the current error information.
+ *
+ * @since 6.5.0
+ *
+ * @return string|null Error message or null if no error.
+ */
+ public function error() {
+ return $this->error;
+ }
+
+ /**
+ * Returns the file name.
+ *
+ * @since 6.5.0
+ *
+ * @return string File name.
+ */
+ public function get_file(): string {
+ return $this->file;
+ }
+
+ /**
+ * Translates a given string.
+ *
+ * @since 6.5.0
+ *
+ * @param string $text String to translate.
+ * @return false|string Translation(s) on success, false otherwise.
+ */
+ public function translate( string $text ) {
+ if ( ! $this->parsed ) {
+ $this->parse_file();
+ }
+
+ return $this->entries[ $text ] ?? false;
+ }
+
+ /**
+ * Returns the plural form for a given number.
+ *
+ * @since 6.5.0
+ *
+ * @param int $number Count.
+ * @return int Plural form.
+ */
+ public function get_plural_form( int $number ): int {
+ if ( ! $this->parsed ) {
+ $this->parse_file();
+ }
+
+ if ( null === $this->plural_forms && isset( $this->headers['plural-forms'] ) ) {
+ $expression = $this->get_plural_expression_from_header( $this->headers['plural-forms'] );
+ $this->plural_forms = $this->make_plural_form_function( $expression );
+ }
+
+ if ( is_callable( $this->plural_forms ) ) {
+ /**
+ * Plural form.
+ *
+ * @var int $result Plural form.
+ */
+ $result = call_user_func( $this->plural_forms, $number );
+
+ return $result;
+ }
+
+ // Default plural form matches English, only "One" is considered singular.
+ return ( 1 === $number ? 0 : 1 );
+ }
+
+ /**
+ * Returns the plural forms expression as a tuple.
+ *
+ * @since 6.5.0
+ *
+ * @param string $header Plural-Forms header string.
+ * @return string Plural forms expression.
+ */
+ protected function get_plural_expression_from_header( string $header ): string {
+ if ( preg_match( '/^\s*nplurals\s*=\s*(\d+)\s*;\s+plural\s*=\s*(.+)$/', $header, $matches ) ) {
+ return trim( $matches[2] );
+ }
+
+ return 'n != 1';
+ }
+
+ /**
+ * Makes a function, which will return the right translation index, according to the
+ * plural forms header.
+ *
+ * @since 6.5.0
+ *
+ * @param string $expression Plural form expression.
+ * @return callable(int $num): int Plural forms function.
+ */
+ protected function make_plural_form_function( string $expression ): callable {
+ try {
+ $handler = new Plural_Forms( rtrim( $expression, ';' ) );
+ return array( $handler, 'get' );
+ } catch ( Exception $e ) {
+ // Fall back to default plural-form function.
+ return $this->make_plural_form_function( 'n != 1' );
+ }
+ }
+
+ /**
+ * Imports translations from another file.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Translation_File $source Source file.
+ * @return bool True on success, false otherwise.
+ */
+ protected function import( WP_Translation_File $source ): bool {
+ if ( null !== $source->error() ) {
+ return false;
+ }
+
+ $this->headers = $source->headers();
+ $this->entries = $source->entries();
+ $this->error = $source->error();
+
+ return null === $this->error;
+ }
+
+ /**
+ * Parses the file.
+ *
+ * @since 6.5.0
+ */
+ abstract protected function parse_file();
+
+ /**
+ * Exports translation contents as a string.
+ *
+ * @since 6.5.0
+ *
+ * @return string Translation file contents.
+ */
+ abstract public function export();
+}
diff --git a/src/wp-includes/l10n/class-wp-translations.php b/src/wp-includes/l10n/class-wp-translations.php
new file mode 100644
index 0000000000000..e177e1d8c536b
--- /dev/null
+++ b/src/wp-includes/l10n/class-wp-translations.php
@@ -0,0 +1,152 @@
+ $headers
+ * @property-read array $entries
+ */
+class WP_Translations {
+ /**
+ * Text domain.
+ *
+ * @since 6.5.0
+ * @var string
+ */
+ protected $textdomain = 'default';
+
+ /**
+ * Translation controller instance.
+ *
+ * @since 6.5.0
+ * @var WP_Translation_Controller
+ */
+ protected $controller;
+
+ /**
+ * Constructor.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Translation_Controller $controller I18N controller.
+ * @param string $textdomain Optional. Text domain. Default 'default'.
+ */
+ public function __construct( WP_Translation_Controller $controller, string $textdomain = 'default' ) {
+ $this->controller = $controller;
+ $this->textdomain = $textdomain;
+ }
+
+ /**
+ * Magic getter for backward compatibility.
+ *
+ * @since 6.5.0
+ *
+ * @param string $name Property name.
+ * @return mixed
+ */
+ public function __get( string $name ) {
+ if ( 'entries' === $name ) {
+ $entries = $this->controller->get_entries( $this->textdomain );
+
+ $result = array();
+
+ foreach ( $entries as $original => $translations ) {
+ $result[] = $this->make_entry( $original, $translations );
+ }
+
+ return $result;
+ }
+
+ if ( 'headers' === $name ) {
+ return $this->controller->get_headers( $this->textdomain );
+ }
+
+ return null;
+ }
+
+ /**
+ * Builds a Translation_Entry from original string and translation strings.
+ *
+ * @see MO::make_entry()
+ *
+ * @since 6.5.0
+ *
+ * @param string $original Original string to translate from MO file. Might contain
+ * 0x04 as context separator or 0x00 as singular/plural separator.
+ * @param string $translations Translation strings from MO file.
+ * @return Translation_Entry Entry instance.
+ */
+ private function make_entry( $original, $translations ): Translation_Entry {
+ $entry = new Translation_Entry();
+
+ // Look for context, separated by \4.
+ $parts = explode( "\4", $original );
+ if ( isset( $parts[1] ) ) {
+ $original = $parts[1];
+ $entry->context = $parts[0];
+ }
+
+ $entry->singular = $original;
+ $entry->translations = explode( "\0", $translations );
+ $entry->is_plural = count( $entry->translations ) > 1;
+
+ return $entry;
+ }
+
+ /**
+ * Translates a plural string.
+ *
+ * @since 6.5.0
+ *
+ * @param string|null $singular Singular string.
+ * @param string|null $plural Plural string.
+ * @param int|float $count Count. Should be an integer, but some plugins pass floats.
+ * @param string|null $context Context.
+ * @return string|null Translation if it exists, or the unchanged singular string.
+ */
+ public function translate_plural( $singular, $plural, $count = 1, $context = '' ) {
+ if ( null === $singular || null === $plural ) {
+ return $singular;
+ }
+
+ $translation = $this->controller->translate_plural( array( $singular, $plural ), (int) $count, (string) $context, $this->textdomain );
+ if ( false !== $translation ) {
+ return $translation;
+ }
+
+ // Fall back to the original with English grammar rules.
+ return ( 1 === $count ? $singular : $plural );
+ }
+
+ /**
+ * Translates a singular string.
+ *
+ * @since 6.5.0
+ *
+ * @param string|null $singular Singular string.
+ * @param string|null $context Context.
+ * @return string|null Translation if it exists, or the unchanged singular string
+ */
+ public function translate( $singular, $context = '' ) {
+ if ( null === $singular ) {
+ return null;
+ }
+
+ $translation = $this->controller->translate( $singular, (string) $context, $this->textdomain );
+ if ( false !== $translation ) {
+ return $translation;
+ }
+
+ // Fall back to the original.
+ return $singular;
+ }
+}
diff --git a/src/wp-includes/link-template.php b/src/wp-includes/link-template.php
index 9f3d9a97ee440..a782edfb85548 100644
--- a/src/wp-includes/link-template.php
+++ b/src/wp-includes/link-template.php
@@ -4768,7 +4768,7 @@ function get_the_privacy_policy_link( $before = '', $after = '' ) {
* By default the list of internal hosts is comprised of the host name of
* the site's home_url() (as parsed by wp_parse_url()).
*
- * This list is used when determining if a specificed URL is a link to a page on
+ * This list is used when determining if a specified URL is a link to a page on
* the site itself or a link offsite (to an external host). This is used, for
* example, when determining if the "nofollow" attribute should be applied to a
* link.
diff --git a/src/wp-includes/load.php b/src/wp-includes/load.php
index 520902cdd64ba..78961bccec9e2 100644
--- a/src/wp-includes/load.php
+++ b/src/wp-includes/load.php
@@ -598,6 +598,10 @@ function wp_debug_mode() {
error_reporting( E_CORE_ERROR | E_CORE_WARNING | E_COMPILE_ERROR | E_ERROR | E_WARNING | E_PARSE | E_USER_ERROR | E_USER_WARNING | E_RECOVERABLE_ERROR );
}
+ /*
+ * The 'REST_REQUEST' check here is optimistic as the constant is most
+ * likely not set at this point even if it is in fact a REST request.
+ */
if ( defined( 'XMLRPC_REQUEST' ) || defined( 'REST_REQUEST' ) || defined( 'MS_FILES_REQUEST' )
|| ( defined( 'WP_INSTALLING' ) && WP_INSTALLING )
|| wp_doing_ajax() || wp_is_json_request()
@@ -982,6 +986,7 @@ function wp_get_active_and_valid_plugins() {
$network_plugins = is_multisite() ? wp_get_active_network_plugins() : false;
+ $invalid_plugins = array();
foreach ( $active_plugins as $plugin ) {
if ( ! validate_file( $plugin ) // $plugin must validate as file.
&& str_ends_with( $plugin, '.php' ) // $plugin must end with '.php'.
@@ -990,6 +995,20 @@ function wp_get_active_and_valid_plugins() {
&& ( ! $network_plugins || ! in_array( WP_PLUGIN_DIR . '/' . $plugin, $network_plugins, true ) )
) {
$plugins[] = WP_PLUGIN_DIR . '/' . $plugin;
+ } else {
+ $invalid_plugins[] = $plugin;
+ }
+ }
+
+ if ( ! empty( $invalid_plugins ) ) {
+ $all_plugin_data = get_option( 'plugin_data', array() );
+
+ if ( ! empty( $all_plugin_data ) ) {
+ foreach ( $invalid_plugins as $invalid_plugin ) {
+ unset( $all_plugin_data[ $invalid_plugin ] );
+ }
+
+ update_option( 'plugin_data', $all_plugin_data );
}
}
@@ -1186,6 +1205,7 @@ function is_protected_ajax_action() {
'search-install-plugins', // Searching for a plugin in the plugin install screen.
'update-plugin', // Update an existing plugin.
'update-theme', // Update an existing theme.
+ 'activate-plugin', // Activating an existing plugin.
);
/**
@@ -1480,6 +1500,11 @@ function wp_load_translations_early() {
// Translation and localization.
require_once ABSPATH . WPINC . '/pomo/mo.php';
+ require_once ABSPATH . WPINC . '/l10n/class-wp-translation-controller.php';
+ require_once ABSPATH . WPINC . '/l10n/class-wp-translations.php';
+ require_once ABSPATH . WPINC . '/l10n/class-wp-translation-file.php';
+ require_once ABSPATH . WPINC . '/l10n/class-wp-translation-file-mo.php';
+ require_once ABSPATH . WPINC . '/l10n/class-wp-translation-file-php.php';
require_once ABSPATH . WPINC . '/l10n.php';
require_once ABSPATH . WPINC . '/class-wp-textdomain-registry.php';
require_once ABSPATH . WPINC . '/class-wp-locale.php';
diff --git a/src/wp-includes/media.php b/src/wp-includes/media.php
index 38ec2213b7506..69a6d53299cab 100644
--- a/src/wp-includes/media.php
+++ b/src/wp-includes/media.php
@@ -4100,6 +4100,7 @@ function _wp_image_editor_choose( $args = array() ) {
require_once ABSPATH . WPINC . '/class-wp-image-editor.php';
require_once ABSPATH . WPINC . '/class-wp-image-editor-gd.php';
require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php';
+ require_once ABSPATH . WPINC . '/class-avif-info.php';
/**
* Filters the list of image editing library classes.
*
@@ -4204,6 +4205,11 @@ function wp_plupload_default_settings() {
$defaults['webp_upload_error'] = true;
}
+ // Check if AVIF images can be edited.
+ if ( ! wp_image_editor_supports( array( 'mime_type' => 'image/avif' ) ) ) {
+ $defaults['avif_upload_error'] = true;
+ }
+
/**
* Filters the Plupload default settings.
*
@@ -5480,6 +5486,7 @@ function wp_show_heic_upload_error( $plupload_settings ) {
*
* @since 5.7.0
* @since 5.8.0 Added support for WebP images.
+ * @since 6.5.0 Added support for AVIF images.
*
* @param string $filename The file path.
* @param array $image_info Optional. Extended image information (passed by reference).
@@ -5512,7 +5519,11 @@ function wp_getimagesize( $filename, array &$image_info = null ) {
}
}
- if ( false !== $info ) {
+ if (
+ ! empty( $info ) &&
+ // Some PHP versions return 0x0 sizes from `getimagesize` for unrecognized image formats, including AVIFs.
+ ! ( empty( $info[0] ) && empty( $info[1] ) )
+ ) {
return $info;
}
@@ -5541,10 +5552,75 @@ function wp_getimagesize( $filename, array &$image_info = null ) {
}
}
+ // For PHP versions that don't support AVIF images, extract the image size info from the file headers.
+ if ( 'image/avif' === wp_get_image_mime( $filename ) ) {
+ $avif_info = wp_get_avif_info( $filename );
+
+ $width = $avif_info['width'];
+ $height = $avif_info['height'];
+
+ // Mimic the native return format.
+ if ( $width && $height ) {
+ return array(
+ $width,
+ $height,
+ IMAGETYPE_AVIF,
+ sprintf(
+ 'width="%d" height="%d"',
+ $width,
+ $height
+ ),
+ 'mime' => 'image/avif',
+ );
+ }
+ }
+
// The image could not be parsed.
return false;
}
+/**
+ * Extracts meta information about an AVIF file: width, height, bit depth, and number of channels.
+ *
+ * @since 6.5.0
+ *
+ * @param string $filename Path to an AVIF file.
+ * @return array {
+ * An array of AVIF image information.
+ *
+ * @type int|false $width Image width on success, false on failure.
+ * @type int|false $height Image height on success, false on failure.
+ * @type int|false $bit_depth Image bit depth on success, false on failure.
+ * @type int|false $num_channels Image number of channels on success, false on failure.
+ * }
+ */
+function wp_get_avif_info( $filename ) {
+ $results = array(
+ 'width' => false,
+ 'height' => false,
+ 'bit_depth' => false,
+ 'num_channels' => false,
+ );
+
+ if ( 'image/avif' !== wp_get_image_mime( $filename ) ) {
+ return $results;
+ }
+
+ // Parse the file using libavifinfo's PHP implementation.
+ require_once ABSPATH . WPINC . '/class-avif-info.php';
+
+ $handle = fopen( $filename, 'rb' );
+ if ( $handle ) {
+ $parser = new Avifinfo\Parser( $handle );
+ $success = $parser->parse_ftyp() && $parser->parse_file();
+ fclose( $handle );
+ if ( $success ) {
+ $results = $parser->features->primary_item_features;
+ }
+ }
+ return $results;
+}
+
/**
* Extracts meta information about a WebP file: width, height, and type.
*
diff --git a/src/wp-includes/pomo/po.php b/src/wp-includes/pomo/po.php
index 7b9ec0b88bb2c..a4e3cab4ef17a 100644
--- a/src/wp-includes/pomo/po.php
+++ b/src/wp-includes/pomo/po.php
@@ -53,7 +53,7 @@ public function export_headers() {
/**
* Exports all entries to PO format
*
- * @return string sequence of mgsgid/msgstr PO strings, doesn't containt newline at the end
+ * @return string sequence of msgid/msgstr PO strings, doesn't contain a newline at the end
*/
public function export_entries() {
// TODO: Sorting.
@@ -64,7 +64,7 @@ public function export_entries() {
* Exports the whole PO file as a string
*
* @param bool $include_headers whether to include the headers in the export
- * @return string ready for inclusion in PO file string for headers and all the enrtries
+ * @return string ready for inclusion in PO file string for headers and all the entries
*/
public function export( $include_headers = true ) {
$res = '';
@@ -127,7 +127,7 @@ public static function poify( $input_string ) {
$input_string = str_replace( array_keys( $replaces ), array_values( $replaces ), $input_string );
$po = $quote . implode( "{$slash}n{$quote}{$newline}{$quote}", explode( $newline, $input_string ) ) . $quote;
- // Add empty string on first line for readbility.
+ // Add empty string on first line for readability.
if ( str_contains( $input_string, $newline ) &&
( substr_count( $input_string, $newline ) > 1 || substr( $input_string, -strlen( $newline ) ) !== $newline ) ) {
$po = "$quote$quote$newline$po";
@@ -141,7 +141,7 @@ public static function poify( $input_string ) {
* Gives back the original string from a PO-formatted string
*
* @param string $input_string PO-formatted string
- * @return string enascaped string
+ * @return string unescaped string
*/
public static function unpoify( $input_string ) {
$escapes = array(
diff --git a/src/wp-includes/post.php b/src/wp-includes/post.php
index 69a63625524d1..5fa058363af9b 100644
--- a/src/wp-includes/post.php
+++ b/src/wp-includes/post.php
@@ -564,6 +564,72 @@ function create_initial_post_types() {
)
);
+ register_post_type(
+ 'wp_font_family',
+ array(
+ 'labels' => array(
+ 'name' => __( 'Font Families' ),
+ 'singular_name' => __( 'Font Family' ),
+ ),
+ 'public' => false,
+ '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
+ 'hierarchical' => false,
+ 'capabilities' => array(
+ 'read' => 'edit_theme_options',
+ 'read_private_posts' => 'edit_theme_options',
+ 'create_posts' => 'edit_theme_options',
+ 'publish_posts' => 'edit_theme_options',
+ 'edit_posts' => 'edit_theme_options',
+ 'edit_others_posts' => 'edit_theme_options',
+ 'edit_published_posts' => 'edit_theme_options',
+ 'delete_posts' => 'edit_theme_options',
+ 'delete_others_posts' => 'edit_theme_options',
+ 'delete_published_posts' => 'edit_theme_options',
+ ),
+ 'map_meta_cap' => true,
+ 'query_var' => false,
+ 'rewrite' => false,
+ 'show_in_rest' => true,
+ 'rest_base' => 'font-families',
+ 'rest_controller_class' => 'WP_REST_Font_Families_Controller',
+ // Disable autosave endpoints for font families.
+ 'autosave_rest_controller_class' => 'stdClass',
+ )
+ );
+
+ register_post_type(
+ 'wp_font_face',
+ array(
+ 'labels' => array(
+ 'name' => __( 'Font Faces' ),
+ 'singular_name' => __( 'Font Face' ),
+ ),
+ 'public' => false,
+ '_builtin' => true, /* internal use only. don't use this when registering your own post type. */
+ 'hierarchical' => false,
+ 'capabilities' => array(
+ 'read' => 'edit_theme_options',
+ 'read_private_posts' => 'edit_theme_options',
+ 'create_posts' => 'edit_theme_options',
+ 'publish_posts' => 'edit_theme_options',
+ 'edit_posts' => 'edit_theme_options',
+ 'edit_others_posts' => 'edit_theme_options',
+ 'edit_published_posts' => 'edit_theme_options',
+ 'delete_posts' => 'edit_theme_options',
+ 'delete_others_posts' => 'edit_theme_options',
+ 'delete_published_posts' => 'edit_theme_options',
+ ),
+ 'map_meta_cap' => true,
+ 'query_var' => false,
+ 'rewrite' => false,
+ 'show_in_rest' => true,
+ 'rest_base' => 'font-families/(?P[\d]+)/font-faces',
+ 'rest_controller_class' => 'WP_REST_Font_Faces_Controller',
+ // Disable autosave endpoints for font faces.
+ 'autosave_rest_controller_class' => 'stdClass',
+ )
+ );
+
register_post_status(
'publish',
array(
@@ -6700,7 +6766,7 @@ function wp_attachment_is( $type, $post = null ) {
switch ( $type ) {
case 'image':
- $image_exts = array( 'jpg', 'jpeg', 'jpe', 'gif', 'png', 'webp' );
+ $image_exts = array( 'jpg', 'jpeg', 'jpe', 'gif', 'png', 'webp', 'avif' );
return in_array( $ext, $image_exts, true );
case 'audio':
diff --git a/src/wp-includes/rest-api.php b/src/wp-includes/rest-api.php
index 61e324e801445..b44b205afb6ef 100644
--- a/src/wp-includes/rest-api.php
+++ b/src/wp-includes/rest-api.php
@@ -209,7 +209,7 @@ function rest_api_register_rewrites() {
* @since 4.4.0
*/
function rest_api_default_filters() {
- if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
+ if ( wp_is_serving_rest_request() ) {
// Deprecated reporting.
add_action( 'deprecated_function_run', 'rest_handle_deprecated_function', 10, 3 );
add_filter( 'deprecated_function_trigger_error', '__return_false' );
@@ -391,6 +391,10 @@ function create_initial_rest_routes() {
// Navigation Fallback.
$controller = new WP_REST_Navigation_Fallback_Controller();
$controller->register_routes();
+
+ // Font Collections.
+ $font_collections_controller = new WP_REST_Font_Collections_Controller();
+ $font_collections_controller->register_routes();
}
/**
@@ -3389,3 +3393,38 @@ static function ( $status, $error_data ) {
return new WP_REST_Response( $data, $status );
}
+
+/**
+ * Checks whether a REST API endpoint request is currently being handled.
+ *
+ * This may be a standalone REST API request, or an internal request dispatched from within a regular page load.
+ *
+ * @since 6.5.0
+ *
+ * @global WP_REST_Server $wp_rest_server REST server instance.
+ *
+ * @return bool True if a REST endpoint request is currently being handled, false otherwise.
+ */
+function wp_is_rest_endpoint() {
+ /* @var WP_REST_Server $wp_rest_server */
+ global $wp_rest_server;
+
+ // Check whether this is a standalone REST request.
+ $is_rest_endpoint = wp_is_serving_rest_request();
+ if ( ! $is_rest_endpoint ) {
+ // Otherwise, check whether an internal REST request is currently being handled.
+ $is_rest_endpoint = isset( $wp_rest_server )
+ && $wp_rest_server->is_dispatching();
+ }
+
+ /**
+ * Filters whether a REST endpoint request is currently being handled.
+ *
+ * This may be a standalone REST API request, or an internal request dispatched from within a regular page load.
+ *
+ * @since 6.5.0
+ *
+ * @param bool $is_request_endpoint Whether a REST endpoint request is currently being handled.
+ */
+ return (bool) apply_filters( 'wp_is_rest_endpoint', $is_rest_endpoint );
+}
diff --git a/src/wp-includes/rest-api/class-wp-rest-server.php b/src/wp-includes/rest-api/class-wp-rest-server.php
index 6838579ce8609..861f5115e6ae9 100644
--- a/src/wp-includes/rest-api/class-wp-rest-server.php
+++ b/src/wp-includes/rest-api/class-wp-rest-server.php
@@ -87,6 +87,14 @@ class WP_REST_Server {
*/
protected $embed_cache = array();
+ /**
+ * Stores request objects that are currently being handled.
+ *
+ * @since 6.5.0
+ * @var array
+ */
+ protected $dispatching_requests = array();
+
/**
* Instantiates the REST server.
*
@@ -983,6 +991,8 @@ public function get_route_options( $route ) {
* @return WP_REST_Response Response returned by the callback.
*/
public function dispatch( $request ) {
+ $this->dispatching_requests[] = $request;
+
/**
* Filters the pre-calculated result of a REST API dispatch request.
*
@@ -1008,6 +1018,7 @@ public function dispatch( $request ) {
$result = $this->error_to_response( $result );
}
+ array_pop( $this->dispatching_requests );
return $result;
}
@@ -1015,7 +1026,9 @@ public function dispatch( $request ) {
$matched = $this->match_request_to_handler( $request );
if ( is_wp_error( $matched ) ) {
- return $this->error_to_response( $matched );
+ $response = $this->error_to_response( $matched );
+ array_pop( $this->dispatching_requests );
+ return $response;
}
list( $route, $handler ) = $matched;
@@ -1040,7 +1053,22 @@ public function dispatch( $request ) {
}
}
- return $this->respond_to_request( $request, $route, $handler, $error );
+ $response = $this->respond_to_request( $request, $route, $handler, $error );
+ array_pop( $this->dispatching_requests );
+ return $response;
+ }
+
+ /**
+ * Returns whether the REST server is currently dispatching / responding to a request.
+ *
+ * This may be a standalone REST API request, or an internal request dispatched from within a regular page load.
+ *
+ * @since 6.5.0
+ *
+ * @return bool Whether the REST server is currently handling a request.
+ */
+ public function is_dispatching() {
+ return (bool) $this->dispatching_requests;
}
/**
diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php
index 7367c0fc57a07..8a26a79a67932 100644
--- a/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php
+++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php
@@ -186,6 +186,12 @@ public function create_item( $request ) {
return $fields_update;
}
+ $terms_update = $this->handle_terms( $attachment_id, $request );
+
+ if ( is_wp_error( $terms_update ) ) {
+ return $terms_update;
+ }
+
$request->set_param( 'context', 'edit' );
/**
@@ -201,7 +207,7 @@ public function create_item( $request ) {
wp_after_insert_post( $attachment, false, null );
- if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
+ if ( wp_is_serving_rest_request() ) {
/*
* Set a custom header with the attachment_id.
* Used by the browser/client to resume creating image sub-sizes after a PHP fatal error.
@@ -450,7 +456,7 @@ public function edit_media_item( $request ) {
);
}
- $supported_types = array( 'image/jpeg', 'image/png', 'image/gif', 'image/webp' );
+ $supported_types = array( 'image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif' );
$mime_type = get_post_mime_type( $attachment_id );
if ( ! in_array( $mime_type, $supported_types, true ) ) {
return new WP_Error(
@@ -630,7 +636,7 @@ public function edit_media_item( $request ) {
update_post_meta( $new_attachment_id, '_wp_attachment_image_alt', wp_slash( $image_alt ) );
}
- if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
+ if ( wp_is_serving_rest_request() ) {
/*
* Set a custom header with the attachment_id.
* Used by the browser/client to resume creating image sub-sizes after a PHP fatal error.
diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php
index 852143d96ec35..7bf2f6af4af2e 100644
--- a/src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php
+++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php
@@ -280,6 +280,7 @@ public function prepare_item_for_response( $item, $request ) {
'keywords',
'parent',
'ancestor',
+ 'allowed_blocks',
'provides_context',
'uses_context',
'selectors',
@@ -292,6 +293,7 @@ public function prepare_item_for_response( $item, $request ) {
'view_script_handles',
'editor_style_handles',
'style_handles',
+ 'view_style_handles',
'variations',
'block_hooks',
),
@@ -602,6 +604,16 @@ public function get_item_schema() {
'context' => array( 'embed', 'view', 'edit' ),
'readonly' => true,
),
+ 'view_style_handles' => array(
+ 'description' => __( 'Public facing style handles.' ),
+ 'type' => array( 'array' ),
+ 'default' => array(),
+ 'items' => array(
+ 'type' => 'string',
+ ),
+ 'context' => array( 'embed', 'view', 'edit' ),
+ 'readonly' => true,
+ ),
'styles' => array(
'description' => __( 'Block style variations.' ),
'type' => 'array',
@@ -712,6 +724,17 @@ public function get_item_schema() {
'context' => array( 'embed', 'view', 'edit' ),
'readonly' => true,
),
+ 'allowed_blocks' => array(
+ 'description' => __( 'Allowed child block types.' ),
+ 'type' => array( 'array', 'null' ),
+ 'items' => array(
+ 'type' => 'string',
+ 'pattern' => self::NAME_PATTERN,
+ ),
+ 'default' => null,
+ 'context' => array( 'embed', 'view', 'edit' ),
+ 'readonly' => true,
+ ),
'keywords' => $keywords_definition,
'example' => $example_definition,
'block_hooks' => array(
diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-font-collections-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-font-collections-controller.php
new file mode 100644
index 0000000000000..05ef0c7b11b64
--- /dev/null
+++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-font-collections-controller.php
@@ -0,0 +1,322 @@
+rest_base = 'font-collections';
+ $this->namespace = 'wp/v2';
+ }
+
+ /**
+ * Registers the routes for the objects of the controller.
+ *
+ * @since 6.5.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(),
+
+ ),
+ 'schema' => array( $this, 'get_public_item_schema' ),
+ )
+ );
+
+ register_rest_route(
+ $this->namespace,
+ '/' . $this->rest_base . '/(?P[\/\w-]+)',
+ array(
+ array(
+ 'methods' => WP_REST_Server::READABLE,
+ 'callback' => array( $this, 'get_item' ),
+ 'permission_callback' => array( $this, 'get_items_permissions_check' ),
+ 'args' => array(
+ 'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+ ),
+ ),
+ 'schema' => array( $this, 'get_public_item_schema' ),
+ )
+ );
+ }
+
+ /**
+ * Gets the font collections available.
+ *
+ * @since 6.5.0
+ *
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function get_items( $request ) {
+ $collections_all = WP_Font_Library::get_instance()->get_font_collections();
+
+ $page = $request['page'];
+ $per_page = $request['per_page'];
+ $total_items = count( $collections_all );
+ $max_pages = ceil( $total_items / $per_page );
+
+ 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.' ),
+ array( 'status' => 400 )
+ );
+ }
+
+ $collections_page = array_slice( $collections_all, ( $page - 1 ) * $per_page, $per_page );
+
+ $items = array();
+ foreach ( $collections_page as $collection ) {
+ $item = $this->prepare_item_for_response( $collection, $request );
+
+ // If there's an error loading a collection, skip it and continue loading valid collections.
+ if ( is_wp_error( $item ) ) {
+ continue;
+ }
+ $item = $this->prepare_response_for_collection( $item );
+ $items[] = $item;
+ }
+
+ $response = rest_ensure_response( $items );
+
+ $response->header( 'X-WP-Total', (int) $total_items );
+ $response->header( 'X-WP-TotalPages', (int) $max_pages );
+
+ $request_params = $request->get_query_params();
+ $collection_url = rest_url( $this->namespace . '/' . $this->rest_base );
+ $base = add_query_arg( urlencode_deep( $request_params ), $collection_url );
+
+ if ( $page > 1 ) {
+ $prev_page = $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 > $page ) {
+ $next_page = $page + 1;
+ $next_link = add_query_arg( 'page', $next_page, $base );
+
+ $response->link_header( 'next', $next_link );
+ }
+
+ return $response;
+ }
+
+ /**
+ * Gets a font collection.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function get_item( $request ) {
+ $slug = $request->get_param( 'slug' );
+ $collection = WP_Font_Library::get_instance()->get_font_collection( $slug );
+
+ if ( ! $collection ) {
+ return new WP_Error( 'rest_font_collection_not_found', __( 'Font collection not found.' ), array( 'status' => 404 ) );
+ }
+
+ return $this->prepare_item_for_response( $collection, $request );
+ }
+
+ /**
+ * Prepare a single collection output for response.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Font_Collection $item Font collection object.
+ * @param WP_REST_Request $request Request object.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function prepare_item_for_response( $item, $request ) {
+ $fields = $this->get_fields_for_response( $request );
+ $data = array();
+
+ if ( rest_is_field_included( 'slug', $fields ) ) {
+ $data['slug'] = $item->slug;
+ }
+
+ // If any data fields are requested, get the collection data.
+ $data_fields = array( 'name', 'description', 'font_families', 'categories' );
+ if ( ! empty( array_intersect( $fields, $data_fields ) ) ) {
+ $collection_data = $item->get_data();
+ if ( is_wp_error( $collection_data ) ) {
+ $collection_data->add_data( array( 'status' => 500 ) );
+ return $collection_data;
+ }
+
+ foreach ( $data_fields as $field ) {
+ if ( rest_is_field_included( $field, $fields ) ) {
+ $data[ $field ] = $collection_data[ $field ];
+ }
+ }
+ }
+
+ $response = rest_ensure_response( $data );
+
+ if ( rest_is_field_included( '_links', $fields ) ) {
+ $links = $this->prepare_links( $item );
+ $response->add_links( $links );
+ }
+
+ $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+ $response->data = $this->add_additional_fields_to_object( $response->data, $request );
+ $response->data = $this->filter_response_by_context( $response->data, $context );
+
+ /**
+ * Filters the font collection data for a REST API response.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Response $response The response object.
+ * @param WP_Font_Collection $item The font collection object.
+ * @param WP_REST_Request $request Request used to generate the response.
+ */
+ return apply_filters( 'rest_prepare_font_collection', $response, $item, $request );
+ }
+
+ /**
+ * Retrieves the font collection's schema, conforming to JSON Schema.
+ *
+ * @since 6.5.0
+ *
+ * @return array Item schema data.
+ */
+ public function get_item_schema() {
+ if ( $this->schema ) {
+ return $this->add_additional_fields_schema( $this->schema );
+ }
+
+ $schema = array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'title' => 'font-collection',
+ 'type' => 'object',
+ 'properties' => array(
+ 'slug' => array(
+ 'description' => __( 'Unique identifier for the font collection.' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ 'readonly' => true,
+ ),
+ 'name' => array(
+ 'description' => __( 'The name for the font collection.' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ ),
+ 'description' => array(
+ 'description' => __( 'The description for the font collection.' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ ),
+ 'font_families' => array(
+ 'description' => __( 'The font families for the font collection.' ),
+ 'type' => 'array',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ ),
+ 'categories' => array(
+ 'description' => __( 'The categories for the font collection.' ),
+ 'type' => 'array',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ ),
+ ),
+ );
+
+ $this->schema = $schema;
+
+ return $this->add_additional_fields_schema( $this->schema );
+ }
+
+ /**
+ * Prepares links for the request.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Font_Collection $collection Font collection data
+ * @return array Links for the given font collection.
+ */
+ protected function prepare_links( $collection ) {
+ 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 ) ),
+ ),
+ );
+ }
+
+ /**
+ * Retrieves the search params for the font collections.
+ *
+ * @since 6.5.0
+ *
+ * @return array Collection parameters.
+ */
+ public function get_collection_params() {
+ $query_params = parent::get_collection_params();
+
+ $query_params['context'] = $this->get_context_param( array( 'default' => 'view' ) );
+
+ unset( $query_params['search'] );
+
+ /**
+ * Filters REST API collection parameters for the font collections controller.
+ *
+ * @since 6.5.0
+ *
+ * @param array $query_params JSON Schema-formatted collection parameters.
+ */
+ return apply_filters( 'rest_font_collections_collection_params', $query_params );
+ }
+
+ /**
+ * Checks whether the user has permissions to use the Fonts Collections.
+ *
+ * @since 6.5.0
+ *
+ * @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 true;
+ }
+
+ return new WP_Error(
+ 'rest_cannot_read',
+ __( 'Sorry, you are not allowed to access font collections.' ),
+ array(
+ 'status' => rest_authorization_required_code(),
+ )
+ );
+ }
+}
diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-font-faces-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-font-faces-controller.php
new file mode 100644
index 0000000000000..0a870b8c705ce
--- /dev/null
+++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-font-faces-controller.php
@@ -0,0 +1,950 @@
+namespace,
+ '/' . $this->rest_base,
+ array(
+ 'args' => array(
+ 'font_family_id' => array(
+ 'description' => __( 'The ID for the parent font family of the font face.' ),
+ 'type' => 'integer',
+ 'required' => true,
+ ),
+ ),
+ 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_create_params(),
+ ),
+ 'schema' => array( $this, 'get_public_item_schema' ),
+ )
+ );
+
+ register_rest_route(
+ $this->namespace,
+ '/' . $this->rest_base . '/(?P[\d]+)',
+ array(
+ 'args' => array(
+ 'font_family_id' => array(
+ 'description' => __( 'The ID for the parent font family of the font face.' ),
+ 'type' => 'integer',
+ 'required' => true,
+ ),
+ 'id' => array(
+ 'description' => __( 'Unique identifier for the font face.' ),
+ 'type' => 'integer',
+ 'required' => true,
+ ),
+ ),
+ 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' ) ),
+ ),
+ ),
+ 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.', 'default' ),
+ ),
+ ),
+ ),
+ 'schema' => array( $this, 'get_public_item_schema' ),
+ )
+ );
+ }
+
+ /**
+ * Checks if a given request has access to font faces.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
+ */
+ public function get_items_permissions_check( $request ) {
+ $post_type = get_post_type_object( $this->post_type );
+
+ if ( ! current_user_can( $post_type->cap->read ) ) {
+ return new WP_Error(
+ 'rest_cannot_read',
+ __( 'Sorry, you are not allowed to access font faces.' ),
+ array( 'status' => rest_authorization_required_code() )
+ );
+ }
+
+ return true;
+ }
+
+ /**
+ * Checks if a given request has access to a font face.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
+ */
+ public function get_item_permissions_check( $request ) {
+ $post = $this->get_post( $request['id'] );
+ if ( is_wp_error( $post ) ) {
+ return $post;
+ }
+
+ if ( ! current_user_can( 'read_post', $post->ID ) ) {
+ return new WP_Error(
+ 'rest_cannot_read',
+ __( 'Sorry, you are not allowed to access this font face.' ),
+ array( 'status' => rest_authorization_required_code() )
+ );
+ }
+
+ return true;
+ }
+
+ /**
+ * Validates settings when creating a font face.
+ *
+ * @since 6.5.0
+ *
+ * @param string $value Encoded JSON string of font face settings.
+ * @param WP_REST_Request $request Request 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 );
+
+ // Check settings string is valid JSON.
+ if ( null === $settings ) {
+ return new WP_Error(
+ 'rest_invalid_param',
+ __( 'font_face_settings parameter must be a valid JSON string.' ),
+ array( 'status' => 400 )
+ );
+ }
+
+ // Check that the font face settings match the theme.json schema.
+ $schema = $this->get_item_schema()['properties']['font_face_settings'];
+ $has_valid_settings = rest_validate_value_from_schema( $settings, $schema, 'font_face_settings' );
+
+ if ( is_wp_error( $has_valid_settings ) ) {
+ $has_valid_settings->add_data( array( 'status' => 400 ) );
+ return $has_valid_settings;
+ }
+
+ // Check that none of the required settings are empty values.
+ $required = $schema['required'];
+ foreach ( $required as $key ) {
+ if ( isset( $settings[ $key ] ) && ! $settings[ $key ] ) {
+ return new WP_Error(
+ 'rest_invalid_param',
+ /* translators: %s: Name of the missing font face settings parameter, e.g. "font_face_settings[src]". */
+ sprintf( __( '%s cannot be empty.' ), "font_face_setting[ $key ]" ),
+ array( 'status' => 400 )
+ );
+ }
+ }
+
+ $srcs = is_array( $settings['src'] ) ? $settings['src'] : array( $settings['src'] );
+ $files = $request->get_file_params();
+
+ foreach ( $srcs as $src ) {
+ // Check that each src is a non-empty string.
+ $src = ltrim( $src );
+ if ( empty( $src ) ) {
+ return new WP_Error(
+ 'rest_invalid_param',
+ /* translators: %s: Font face source parameter name: "font_face_settings[src]". */
+ sprintf( __( '%s values must be non-empty strings.' ), 'font_face_settings[src]' ),
+ array( 'status' => 400 )
+ );
+ }
+
+ // Check that srcs are valid URLs or file references.
+ if ( false === wp_http_validate_url( $src ) && ! isset( $files[ $src ] ) ) {
+ return new WP_Error(
+ 'rest_invalid_param',
+ /* translators: 1: Font face source parameter name: "font_face_settings[src]", 2: The invalid src value. */
+ sprintf( __( '%1$s value "%2$s" must be a valid URL or file reference.' ), 'font_face_settings[src]', $src ),
+ array( 'status' => 400 )
+ );
+ }
+ }
+
+ // Check that each file in the request references a src in the settings.
+ foreach ( array_keys( $files ) as $file ) {
+ if ( ! in_array( $file, $srcs, true ) ) {
+ return new WP_Error(
+ 'rest_invalid_param',
+ /* translators: 1: File key (e.g. "file-0") in the request data, 2: Font face source parameter name: "font_face_settings[src]". */
+ sprintf( __( 'File %1$s must be used in %2$s.' ), $file, 'font_face_settings[src]' ),
+ array( 'status' => 400 )
+ );
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Sanitizes the font face settings when creating a font face.
+ *
+ * @since 6.5.0
+ *
+ * @param string $value Encoded JSON string of font face settings.
+ * @return array Decoded and sanitized array of font face settings.
+ */
+ public function sanitize_font_face_settings( $value ) {
+ // Settings arrive as stringified JSON, since this is a multipart/form-data request.
+ $settings = json_decode( $value, true );
+ $schema = $this->get_item_schema()['properties']['font_face_settings']['properties'];
+
+ // Sanitize settings based on callbacks in the schema.
+ foreach ( $settings as $key => $value ) {
+ $sanitize_callback = $schema[ $key ]['arg_options']['sanitize_callback'];
+ $settings[ $key ] = call_user_func( $sanitize_callback, $value );
+ }
+
+ return $settings;
+ }
+
+ /**
+ * Retrieves a collection of font faces within the parent font family.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function get_items( $request ) {
+ $font_family = $this->get_parent_font_family_post( $request['font_family_id'] );
+ if ( is_wp_error( $font_family ) ) {
+ return $font_family;
+ }
+
+ return parent::get_items( $request );
+ }
+
+ /**
+ * Retrieves a single font face within the parent font family.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function get_item( $request ) {
+ $post = $this->get_post( $request['id'] );
+ if ( is_wp_error( $post ) ) {
+ return $post;
+ }
+
+ // Check that the font face has a valid parent font family.
+ $font_family = $this->get_parent_font_family_post( $request['font_family_id'] );
+ if ( is_wp_error( $font_family ) ) {
+ return $font_family;
+ }
+
+ if ( (int) $font_family->ID !== (int) $post->post_parent ) {
+ return new WP_Error(
+ 'rest_font_face_parent_id_mismatch',
+ /* translators: %d: A post id. */
+ sprintf( __( 'The font face does not belong to the specified font family with id of "%d".' ), $font_family->ID ),
+ array( 'status' => 404 )
+ );
+ }
+
+ return parent::get_item( $request );
+ }
+
+ /**
+ * Creates a font face for the parent font family.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function create_item( $request ) {
+ $font_family = $this->get_parent_font_family_post( $request['font_family_id'] );
+ if ( is_wp_error( $font_family ) ) {
+ return $font_family;
+ }
+
+ // Settings have already been decoded by ::sanitize_font_face_settings().
+ $settings = $request->get_param( 'font_face_settings' );
+ $file_params = $request->get_file_params();
+
+ // Check that the necessary font face properties are unique.
+ $query = new WP_Query(
+ array(
+ 'post_type' => $this->post_type,
+ 'posts_per_page' => 1,
+ 'title' => WP_Font_Utils::get_font_face_slug( $settings ),
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ )
+ );
+ if ( ! empty( $query->posts ) ) {
+ return new WP_Error(
+ 'rest_duplicate_font_face',
+ __( 'A font face matching those settings already exists.' ),
+ array( 'status' => 400 )
+ );
+ }
+
+ // Move the uploaded font asset from the temp folder to the fonts directory.
+ if ( ! function_exists( 'wp_handle_upload' ) ) {
+ require_once ABSPATH . 'wp-admin/includes/file.php';
+ }
+
+ $srcs = is_string( $settings['src'] ) ? array( $settings['src'] ) : $settings['src'];
+ $processed_srcs = array();
+ $font_file_meta = array();
+
+ foreach ( $srcs as $src ) {
+ // If src not a file reference, use it as is.
+ if ( ! isset( $file_params[ $src ] ) ) {
+ $processed_srcs[] = $src;
+ continue;
+ }
+
+ $file = $file_params[ $src ];
+ $font_file = $this->handle_font_file_upload( $file );
+ if ( is_wp_error( $font_file ) ) {
+ return $font_file;
+ }
+
+ $processed_srcs[] = $font_file['url'];
+ $font_file_meta[] = $this->relative_fonts_path( $font_file['file'] );
+ }
+
+ // Store the updated settings for prepare_item_for_database to use.
+ $settings['src'] = count( $processed_srcs ) === 1 ? $processed_srcs[0] : $processed_srcs;
+ $request->set_param( 'font_face_settings', $settings );
+
+ // Ensure that $settings data is slashed, so values with quotes are escaped.
+ // WP_REST_Posts_Controller::create_item uses wp_slash() on the post_content.
+ $font_face_post = parent::create_item( $request );
+
+ if ( is_wp_error( $font_face_post ) ) {
+ return $font_face_post;
+ }
+
+ $font_face_id = $font_face_post->data['id'];
+
+ foreach ( $font_file_meta as $font_file_path ) {
+ add_post_meta( $font_face_id, '_wp_font_face_file', $font_file_path );
+ }
+
+ return $font_face_post;
+ }
+
+ /**
+ * Deletes a single font face.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function delete_item( $request ) {
+ $post = $this->get_post( $request['id'] );
+ if ( is_wp_error( $post ) ) {
+ return $post;
+ }
+
+ $font_family = $this->get_parent_font_family_post( $request['font_family_id'] );
+ if ( is_wp_error( $font_family ) ) {
+ return $font_family;
+ }
+
+ if ( (int) $font_family->ID !== (int) $post->post_parent ) {
+ return new WP_Error(
+ 'rest_font_face_parent_id_mismatch',
+ /* translators: %d: A post id. */
+ sprintf( __( 'The font face does not belong to the specified font family with id of "%d".' ), $font_family->ID ),
+ array( 'status' => 404 )
+ );
+ }
+
+ $force = isset( $request['force'] ) ? (bool) $request['force'] : false;
+
+ // We don't support trashing for font faces.
+ if ( ! $force ) {
+ return new WP_Error(
+ 'rest_trash_not_supported',
+ /* translators: %s: force=true */
+ sprintf( __( 'Font faces do not support trashing. Set "%s" to delete.' ), 'force=true' ),
+ array( 'status' => 501 )
+ );
+ }
+
+ return parent::delete_item( $request );
+ }
+
+ /**
+ * Prepares a single font face output for response.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Post $item Post object.
+ * @param WP_REST_Request $request Request object.
+ * @return WP_REST_Response Response object.
+ */
+ public function prepare_item_for_response( $item, $request ) {
+ $fields = $this->get_fields_for_response( $request );
+ $data = array();
+
+ if ( rest_is_field_included( 'id', $fields ) ) {
+ $data['id'] = $item->ID;
+ }
+ if ( rest_is_field_included( 'theme_json_version', $fields ) ) {
+ $data['theme_json_version'] = static::LATEST_THEME_JSON_VERSION_SUPPORTED;
+ }
+
+ if ( rest_is_field_included( 'parent', $fields ) ) {
+ $data['parent'] = $item->post_parent;
+ }
+
+ if ( rest_is_field_included( 'font_face_settings', $fields ) ) {
+ $data['font_face_settings'] = $this->get_settings_from_post( $item );
+ }
+
+ $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+ $data = $this->add_additional_fields_to_object( $data, $request );
+ $data = $this->filter_response_by_context( $data, $context );
+
+ $response = rest_ensure_response( $data );
+
+ if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {
+ $links = $this->prepare_links( $item );
+ $response->add_links( $links );
+ }
+
+ /**
+ * Filters the font face data for a REST API response.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Response $response The response object.
+ * @param WP_Post $post Font face post object.
+ * @param WP_REST_Request $request Request object.
+ */
+ return apply_filters( 'rest_prepare_wp_font_face', $response, $item, $request );
+ }
+
+ /**
+ * Retrieves the post's schema, conforming to JSON Schema.
+ *
+ * @since 6.5.0
+ *
+ * @return array Item schema data.
+ */
+ public function get_item_schema() {
+ if ( $this->schema ) {
+ return $this->add_additional_fields_schema( $this->schema );
+ }
+
+ $schema = array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'title' => $this->post_type,
+ 'type' => 'object',
+ // Base properties for every Post.
+ 'properties' => array(
+ 'id' => array(
+ 'description' => __( 'Unique identifier for the post.', 'default' ),
+ 'type' => 'integer',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ 'readonly' => true,
+ ),
+ 'theme_json_version' => array(
+ 'description' => __( 'Version of the theme.json schema used for the typography settings.' ),
+ 'type' => 'integer',
+ 'default' => static::LATEST_THEME_JSON_VERSION_SUPPORTED,
+ 'minimum' => 2,
+ 'maximum' => static::LATEST_THEME_JSON_VERSION_SUPPORTED,
+ 'context' => array( 'view', 'edit', 'embed' ),
+ ),
+ 'parent' => array(
+ 'description' => __( 'The ID for the parent font family of the font face.' ),
+ 'type' => 'integer',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ ),
+ // Font face settings come directly from theme.json schema
+ // See https://schemas.wp.org/trunk/theme.json
+ 'font_face_settings' => array(
+ 'description' => __( 'font-face declaration in theme.json format.' ),
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ 'properties' => array(
+ 'fontFamily' => array(
+ 'description' => __( 'CSS font-family value.' ),
+ 'type' => 'string',
+ 'default' => '',
+ 'arg_options' => array(
+ 'sanitize_callback' => array( 'WP_Font_Utils', 'sanitize_font_family' ),
+ ),
+ ),
+ 'fontStyle' => array(
+ 'description' => __( 'CSS font-style value.' ),
+ 'type' => 'string',
+ 'default' => 'normal',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'fontWeight' => array(
+ 'description' => __( 'List of available font weights, separated by a space.' ),
+ 'default' => '400',
+ // Changed from `oneOf` to avoid errors from loose type checking.
+ // e.g. a fontWeight of "400" validates as both a string and an integer due to is_numeric check.
+ 'type' => array( 'string', 'integer' ),
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'fontDisplay' => array(
+ 'description' => __( 'CSS font-display value.' ),
+ 'type' => 'string',
+ 'default' => 'fallback',
+ 'enum' => array(
+ 'auto',
+ 'block',
+ 'fallback',
+ 'swap',
+ 'optional',
+ ),
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'src' => array(
+ 'description' => __( 'Paths or URLs to the font files.' ),
+ // Changed from `oneOf` to `anyOf` due to rest_sanitize_array converting a string into an array,
+ // and causing a "matches more than one of the expected formats" error.
+ 'anyOf' => array(
+ array(
+ 'type' => 'string',
+ ),
+ array(
+ 'type' => 'array',
+ 'items' => array(
+ 'type' => 'string',
+ ),
+ ),
+ ),
+ 'default' => array(),
+ 'arg_options' => array(
+ 'sanitize_callback' => function ( $value ) {
+ return is_array( $value ) ? array_map( array( $this, 'sanitize_src' ), $value ) : $this->sanitize_src( $value );
+ },
+ ),
+ ),
+ 'fontStretch' => array(
+ 'description' => __( 'CSS font-stretch value.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'ascentOverride' => array(
+ 'description' => __( 'CSS ascent-override value.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'descentOverride' => array(
+ 'description' => __( 'CSS descent-override value.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'fontVariant' => array(
+ 'description' => __( 'CSS font-variant value.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'fontFeatureSettings' => array(
+ 'description' => __( 'CSS font-feature-settings value.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'fontVariationSettings' => array(
+ 'description' => __( 'CSS font-variation-settings value.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'lineGapOverride' => array(
+ 'description' => __( 'CSS line-gap-override value.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'sizeAdjust' => array(
+ 'description' => __( 'CSS size-adjust value.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'unicodeRange' => array(
+ 'description' => __( 'CSS unicode-range value.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'preview' => array(
+ 'description' => __( 'URL to a preview image of the font face.' ),
+ 'type' => 'string',
+ 'format' => 'uri',
+ 'default' => '',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_url',
+ ),
+ ),
+ ),
+ 'required' => array( 'fontFamily', 'src' ),
+ 'additionalProperties' => false,
+ ),
+ ),
+ );
+
+ $this->schema = $schema;
+
+ return $this->add_additional_fields_schema( $this->schema );
+ }
+
+ /**
+ * Retrieves the item's schema for display / public consumption purposes.
+ *
+ * @since 6.5.0
+ *
+ * @return array Public item schema data.
+ */
+ public function get_public_item_schema() {
+
+ $schema = parent::get_public_item_schema();
+
+ // Also remove `arg_options' from child font_family_settings properties, since the parent
+ // controller only handles the top level properties.
+ foreach ( $schema['properties']['font_face_settings']['properties'] as &$property ) {
+ unset( $property['arg_options'] );
+ }
+
+ return $schema;
+ }
+
+ /**
+ * Retrieves the query params for the font face collection.
+ *
+ * @since 6.5.0
+ *
+ * @return array Collection parameters.
+ */
+ public function get_collection_params() {
+ $query_params = parent::get_collection_params();
+
+ // Remove unneeded params.
+ unset(
+ $query_params['after'],
+ $query_params['modified_after'],
+ $query_params['before'],
+ $query_params['modified_before'],
+ $query_params['search'],
+ $query_params['search_columns'],
+ $query_params['slug'],
+ $query_params['status']
+ );
+
+ $query_params['orderby']['default'] = 'id';
+ $query_params['orderby']['enum'] = array( 'id', 'include' );
+
+ /**
+ * Filters collection parameters for the font face controller.
+ *
+ * @since 6.5.0
+ *
+ * @param array $query_params JSON Schema-formatted collection parameters.
+ */
+ return apply_filters( 'rest_wp_font_face_collection_params', $query_params );
+ }
+
+ /**
+ * Get the params used when creating a new font face.
+ *
+ * @since 6.5.0
+ *
+ * @return array Font face create arguments.
+ */
+ public function get_create_params() {
+ $properties = $this->get_item_schema()['properties'];
+ return array(
+ 'theme_json_version' => $properties['theme_json_version'],
+ // When creating, font_face_settings is stringified JSON, to work with multipart/form-data used
+ // when uploading font files.
+ 'font_face_settings' => array(
+ 'description' => __( 'font-face declaration in theme.json format, encoded as a string.' ),
+ 'type' => 'string',
+ 'required' => true,
+ 'validate_callback' => array( $this, 'validate_create_font_face_settings' ),
+ 'sanitize_callback' => array( $this, 'sanitize_font_face_settings' ),
+ ),
+ );
+ }
+
+ /**
+ * Get the parent font family, if the ID is valid.
+ *
+ * @since 6.5.0
+ *
+ * @param int $font_family_id Supplied ID.
+ * @return WP_Post|WP_Error Post object if ID is valid, WP_Error otherwise.
+ */
+ protected function get_parent_font_family_post( $font_family_id ) {
+ $error = new WP_Error(
+ 'rest_post_invalid_parent',
+ __( 'Invalid post parent ID.', 'default' ),
+ array( 'status' => 404 )
+ );
+
+ if ( (int) $font_family_id <= 0 ) {
+ return $error;
+ }
+
+ $font_family_post = get_post( (int) $font_family_id );
+
+ if ( empty( $font_family_post ) || empty( $font_family_post->ID )
+ || 'wp_font_family' !== $font_family_post->post_type
+ ) {
+ return $error;
+ }
+
+ return $font_family_post;
+ }
+
+ /**
+ * Prepares links for the request.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Post $post Post object.
+ * @return array Links for the given post.
+ */
+ protected function prepare_links( $post ) {
+ // Entity meta.
+ return array(
+ 'self' => array(
+ 'href' => rest_url( $this->namespace . '/font-families/' . $post->post_parent . '/font-faces/' . $post->ID ),
+ ),
+ 'collection' => array(
+ 'href' => rest_url( $this->namespace . '/font-families/' . $post->post_parent . '/font-faces' ),
+ ),
+ 'parent' => array(
+ 'href' => rest_url( $this->namespace . '/font-families/' . $post->post_parent ),
+ ),
+ );
+ }
+
+ /**
+ * Prepares a single font face post for creation.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Request object.
+ * @return stdClass Post object.
+ */
+ protected function prepare_item_for_database( $request ) {
+ $prepared_post = new stdClass();
+
+ // Settings have already been decoded by ::sanitize_font_face_settings().
+ $settings = $request->get_param( 'font_face_settings' );
+
+ // Store this "slug" as the post_title rather than post_name, since it uses the fontFamily setting,
+ // which may contain multibyte characters.
+ $title = WP_Font_Utils::get_font_face_slug( $settings );
+
+ $prepared_post->post_type = $this->post_type;
+ $prepared_post->post_parent = $request['font_family_id'];
+ $prepared_post->post_status = 'publish';
+ $prepared_post->post_title = $title;
+ $prepared_post->post_name = sanitize_title( $title );
+ $prepared_post->post_content = wp_json_encode( $settings );
+
+ return $prepared_post;
+ }
+
+ /**
+ * Sanitizes a single src value for a font face.
+ *
+ * @since 6.5.0
+ *
+ * @param string $value Font face src that is a URL or the key for a $_FILES array item.
+ * @return string Sanitized value.
+ */
+ protected function sanitize_src( $value ) {
+ $value = ltrim( $value );
+ return false === wp_http_validate_url( $value ) ? (string) $value : sanitize_url( $value );
+ }
+
+ /**
+ * Handles the upload of a font file using wp_handle_upload().
+ *
+ * @since 6.5.0
+ *
+ * @param array $file Single file item from $_FILES.
+ * @return array|WP_Error Array containing uploaded file attributes on success, or WP_Error object on failure.
+ */
+ protected function handle_font_file_upload( $file ) {
+ add_filter( 'upload_mimes', array( 'WP_Font_Utils', 'get_allowed_font_mime_types' ) );
+ add_filter( 'upload_dir', 'wp_get_font_dir' );
+
+ $overrides = array(
+ 'upload_error_handler' => array( $this, 'handle_font_file_upload_error' ),
+ // Arbitrary string to avoid the is_uploaded_file() check applied
+ // when using 'wp_handle_upload'.
+ 'action' => 'wp_handle_font_upload',
+ // Not testing a form submission.
+ 'test_form' => false,
+ // Seems mime type for files that are not images cannot be tested.
+ // See wp_check_filetype_and_ext().
+ 'test_type' => true,
+ // Only allow uploading font files for this request.
+ 'mimes' => WP_Font_Utils::get_allowed_font_mime_types(),
+ );
+
+ $uploaded_file = wp_handle_upload( $file, $overrides );
+
+ remove_filter( 'upload_dir', 'wp_get_font_dir' );
+ remove_filter( 'upload_mimes', array( 'WP_Font_Utils', 'get_allowed_font_mime_types' ) );
+
+ return $uploaded_file;
+ }
+
+ /**
+ * Handles file upload error.
+ *
+ * @since 6.5.0
+ *
+ * @param array $file File upload data.
+ * @param string $message Error message from wp_handle_upload().
+ * @return WP_Error WP_Error object.
+ */
+ 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.' ) === $message ) {
+ $status = 400;
+ $code = 'rest_font_upload_invalid_file_type';
+ }
+
+ return new WP_Error( $code, $message, array( 'status' => $status ) );
+ }
+
+ /**
+ * Returns relative path to an uploaded font file.
+ *
+ * The path is relative to the current fonts directory.
+ *
+ * @since 6.5.0
+ * @access private
+ *
+ * @param string $path Full path to the file.
+ * @return string Relative path on success, unchanged path on failure.
+ */
+ protected function relative_fonts_path( $path ) {
+ $new_path = $path;
+
+ $fonts_dir = wp_get_font_dir();
+ if ( str_starts_with( $new_path, $fonts_dir['path'] ) ) {
+ $new_path = str_replace( $fonts_dir, '', $new_path );
+ $new_path = ltrim( $new_path, '/' );
+ }
+
+ return $new_path;
+ }
+
+ /**
+ * Gets the font face's settings from the post.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Post $post Font face post object.
+ * @return array Font face settings array.
+ */
+ protected function get_settings_from_post( $post ) {
+ $settings = json_decode( $post->post_content, true );
+ $properties = $this->get_item_schema()['properties']['font_face_settings']['properties'];
+
+ // Provide required, empty settings if needed.
+ if ( null === $settings ) {
+ $settings = array(
+ 'fontFamily' => '',
+ 'src' => array(),
+ );
+ }
+
+ // Only return the properties defined in the schema.
+ return array_intersect_key( $settings, $properties );
+ }
+}
diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-font-families-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-font-families-controller.php
new file mode 100644
index 0000000000000..184b42d141dd3
--- /dev/null
+++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-font-families-controller.php
@@ -0,0 +1,564 @@
+post_type );
+
+ if ( ! current_user_can( $post_type->cap->read ) ) {
+ return new WP_Error(
+ 'rest_cannot_read',
+ __( 'Sorry, you are not allowed to access font families.' ),
+ array( 'status' => rest_authorization_required_code() )
+ );
+ }
+
+ return true;
+ }
+
+ /**
+ * Checks if a given request has access to a font family.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
+ */
+ public function get_item_permissions_check( $request ) {
+ $post = $this->get_post( $request['id'] );
+ if ( is_wp_error( $post ) ) {
+ return $post;
+ }
+
+ if ( ! current_user_can( 'read_post', $post->ID ) ) {
+ return new WP_Error(
+ 'rest_cannot_read',
+ __( 'Sorry, you are not allowed to access this font family.' ),
+ array( 'status' => rest_authorization_required_code() )
+ );
+ }
+
+ return true;
+ }
+
+ /**
+ * Validates settings when creating or updating a font family.
+ *
+ * @since 6.5.0
+ *
+ * @param string $value Encoded JSON string of font family settings.
+ * @param WP_REST_Request $request Request object.
+ * @return true|WP_Error True if the settings are valid, otherwise a WP_Error object.
+ */
+ public function validate_font_family_settings( $value, $request ) {
+ $settings = json_decode( $value, true );
+
+ // Check settings string is valid JSON.
+ if ( null === $settings ) {
+ return new WP_Error(
+ 'rest_invalid_param',
+ /* translators: %s: Parameter name: "font_family_settings". */
+ sprintf( __( '%s parameter must be a valid JSON string.' ), 'font_family_settings' ),
+ array( 'status' => 400 )
+ );
+ }
+
+ $schema = $this->get_item_schema()['properties']['font_family_settings'];
+ $required = $schema['required'];
+
+ if ( isset( $request['id'] ) ) {
+ // Allow sending individual properties if we are updating an existing font family.
+ unset( $schema['required'] );
+
+ // But don't allow updating the slug, since it is used as a unique identifier.
+ if ( isset( $settings['slug'] ) ) {
+ return new WP_Error(
+ 'rest_invalid_param',
+ /* translators: %s: Name of parameter being updated: font_family_settings[slug]". */
+ sprintf( __( '%s cannot be updated.' ), 'font_family_settings[slug]' ),
+ array( 'status' => 400 )
+ );
+ }
+ }
+
+ // Check that the font face settings match the theme.json schema.
+ $has_valid_settings = rest_validate_value_from_schema( $settings, $schema, 'font_family_settings' );
+
+ if ( is_wp_error( $has_valid_settings ) ) {
+ $has_valid_settings->add_data( array( 'status' => 400 ) );
+ return $has_valid_settings;
+ }
+
+ // Check that none of the required settings are empty values.
+ foreach ( $required as $key ) {
+ if ( isset( $settings[ $key ] ) && ! $settings[ $key ] ) {
+ return new WP_Error(
+ 'rest_invalid_param',
+ /* translators: %s: Name of the empty font family setting parameter, e.g. "font_family_settings[slug]". */
+ sprintf( __( '%s cannot be empty.' ), "font_family_settings[ $key ]" ),
+ array( 'status' => 400 )
+ );
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Sanitizes the font family settings when creating or updating a font family.
+ *
+ * @since 6.5.0
+ *
+ * @param string $value Encoded JSON string of font family settings.
+ * @return array Decoded array of font family settings.
+ */
+ public function sanitize_font_family_settings( $value ) {
+ // Settings arrive as stringified JSON, since this is a multipart/form-data request.
+ $settings = json_decode( $value, true );
+ $schema = $this->get_item_schema()['properties']['font_family_settings']['properties'];
+
+ // Sanitize settings based on callbacks in the schema.
+ foreach ( $settings as $key => $value ) {
+ $sanitize_callback = $schema[ $key ]['arg_options']['sanitize_callback'];
+ $settings[ $key ] = call_user_func( $sanitize_callback, $value );
+ }
+
+ return $settings;
+ }
+
+ /**
+ * Creates a single font family.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function create_item( $request ) {
+ $settings = $request->get_param( 'font_family_settings' );
+
+ // Check that the font family slug is unique.
+ $query = new WP_Query(
+ array(
+ 'post_type' => $this->post_type,
+ 'posts_per_page' => 1,
+ 'name' => $settings['slug'],
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ )
+ );
+ if ( ! empty( $query->posts ) ) {
+ return new WP_Error(
+ 'rest_duplicate_font_family',
+ /* translators: %s: Font family slug. */
+ sprintf( __( 'A font family with slug "%s" already exists.' ), $settings['slug'] ),
+ array( 'status' => 400 )
+ );
+ }
+
+ return parent::create_item( $request );
+ }
+
+ /**
+ * Deletes a single font family.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function delete_item( $request ) {
+ $force = isset( $request['force'] ) ? (bool) $request['force'] : false;
+
+ // We don't support trashing for font families.
+ if ( ! $force ) {
+ return new WP_Error(
+ 'rest_trash_not_supported',
+ /* translators: %s: force=true */
+ sprintf( __( 'Font faces do not support trashing. Set "%s" to delete.' ), 'force=true' ),
+ array( 'status' => 501 )
+ );
+ }
+
+ return parent::delete_item( $request );
+ }
+
+ /**
+ * Prepares a single font family output for response.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Post $item Post object.
+ * @param WP_REST_Request $request Request object.
+ * @return WP_REST_Response Response object.
+ */
+ public function prepare_item_for_response( $item, $request ) {
+ $fields = $this->get_fields_for_response( $request );
+ $data = array();
+
+ if ( rest_is_field_included( 'id', $fields ) ) {
+ $data['id'] = $item->ID;
+ }
+
+ if ( rest_is_field_included( 'theme_json_version', $fields ) ) {
+ $data['theme_json_version'] = static::LATEST_THEME_JSON_VERSION_SUPPORTED;
+ }
+
+ if ( rest_is_field_included( 'font_faces', $fields ) ) {
+ $data['font_faces'] = $this->get_font_face_ids( $item->ID );
+ }
+
+ if ( rest_is_field_included( 'font_family_settings', $fields ) ) {
+ $data['font_family_settings'] = $this->get_settings_from_post( $item );
+ }
+
+ $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
+ $data = $this->add_additional_fields_to_object( $data, $request );
+ $data = $this->filter_response_by_context( $data, $context );
+
+ $response = rest_ensure_response( $data );
+
+ if ( rest_is_field_included( '_links', $fields ) ) {
+ $links = $this->prepare_links( $item );
+ $response->add_links( $links );
+ }
+
+ /**
+ * Filters the font family data for a REST API response.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Response $response The response object.
+ * @param WP_Post $post Font family post object.
+ * @param WP_REST_Request $request Request object.
+ */
+ return apply_filters( 'rest_prepare_wp_font_family', $response, $item, $request );
+ }
+
+ /**
+ * Retrieves the post's schema, conforming to JSON Schema.
+ *
+ * @since 6.5.0
+ *
+ * @return array Item schema data.
+ */
+ public function get_item_schema() {
+ if ( $this->schema ) {
+ return $this->add_additional_fields_schema( $this->schema );
+ }
+
+ $schema = array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'title' => $this->post_type,
+ 'type' => 'object',
+ // Base properties for every Post.
+ 'properties' => array(
+ 'id' => array(
+ 'description' => __( 'Unique identifier for the post.', 'default' ),
+ 'type' => 'integer',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ 'readonly' => true,
+ ),
+ 'theme_json_version' => array(
+ 'description' => __( 'Version of the theme.json schema used for the typography settings.' ),
+ 'type' => 'integer',
+ 'default' => static::LATEST_THEME_JSON_VERSION_SUPPORTED,
+ 'minimum' => 2,
+ 'maximum' => static::LATEST_THEME_JSON_VERSION_SUPPORTED,
+ 'context' => array( 'view', 'edit', 'embed' ),
+ ),
+ 'font_faces' => array(
+ 'description' => __( 'The IDs of the child font faces in the font family.' ),
+ 'type' => 'array',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ 'items' => array(
+ 'type' => 'integer',
+ ),
+ ),
+ // Font family settings come directly from theme.json schema
+ // See https://schemas.wp.org/trunk/theme.json
+ 'font_family_settings' => array(
+ 'description' => __( 'font-face definition in theme.json format.' ),
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ 'properties' => array(
+ 'name' => array(
+ 'description' => __( 'Name of the font family preset, translatable.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_text_field',
+ ),
+ ),
+ 'slug' => array(
+ 'description' => __( 'Kebab-case unique identifier for the font family preset.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_title',
+ ),
+ ),
+ 'fontFamily' => array(
+ 'description' => __( 'CSS font-family value.' ),
+ 'type' => 'string',
+ 'arg_options' => array(
+ 'sanitize_callback' => array( 'WP_Font_Utils', 'sanitize_font_family' ),
+ ),
+ ),
+ 'preview' => array(
+ 'description' => __( 'URL to a preview image of the font family.' ),
+ 'type' => 'string',
+ 'format' => 'uri',
+ 'default' => '',
+ 'arg_options' => array(
+ 'sanitize_callback' => 'sanitize_url',
+ ),
+ ),
+ ),
+ 'required' => array( 'name', 'slug', 'fontFamily' ),
+ 'additionalProperties' => false,
+ ),
+ ),
+ );
+
+ $this->schema = $schema;
+
+ return $this->add_additional_fields_schema( $this->schema );
+ }
+
+ /**
+ * Retrieves the item's schema for display / public consumption purposes.
+ *
+ * @since 6.5.0
+ *
+ * @return array Public item schema data.
+ */
+ public function get_public_item_schema() {
+
+ $schema = parent::get_public_item_schema();
+
+ // Also remove `arg_options' from child font_family_settings properties, since the parent
+ // controller only handles the top level properties.
+ foreach ( $schema['properties']['font_family_settings']['properties'] as &$property ) {
+ unset( $property['arg_options'] );
+ }
+
+ return $schema;
+ }
+
+ /**
+ * Retrieves the query params for the font family collection.
+ *
+ * @since 6.5.0
+ *
+ * @return array Collection parameters.
+ */
+ public function get_collection_params() {
+ $query_params = parent::get_collection_params();
+
+ // Remove unneeded params.
+ unset(
+ $query_params['after'],
+ $query_params['modified_after'],
+ $query_params['before'],
+ $query_params['modified_before'],
+ $query_params['search'],
+ $query_params['search_columns'],
+ $query_params['status']
+ );
+
+ $query_params['orderby']['default'] = 'id';
+ $query_params['orderby']['enum'] = array( 'id', 'include' );
+
+ /**
+ * Filters collection parameters for the font family controller.
+ *
+ * @since 6.5.0
+ *
+ * @param array $query_params JSON Schema-formatted collection parameters.
+ */
+ return apply_filters( 'rest_wp_font_family_collection_params', $query_params );
+ }
+
+ /**
+ * Get the arguments used when creating or updating a font family.
+ *
+ * @since 6.5.0
+ *
+ * @return array Font family create/edit arguments.
+ */
+ public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ) {
+ if ( WP_REST_Server::CREATABLE === $method || WP_REST_Server::EDITABLE === $method ) {
+ $properties = $this->get_item_schema()['properties'];
+ return array(
+ 'theme_json_version' => $properties['theme_json_version'],
+ // When creating or updating, font_family_settings is stringified JSON, to work with multipart/form-data.
+ // Font families don't currently support file uploads, but may accept preview files in the future.
+ 'font_family_settings' => array(
+ 'description' => __( 'font-family declaration in theme.json format, encoded as a string.' ),
+ 'type' => 'string',
+ 'required' => true,
+ 'validate_callback' => array( $this, 'validate_font_family_settings' ),
+ 'sanitize_callback' => array( $this, 'sanitize_font_family_settings' ),
+ ),
+ );
+ }
+
+ return parent::get_endpoint_args_for_item_schema( $method );
+ }
+
+ /**
+ * Get the child font face post IDs.
+ *
+ * @since 6.5.0
+ *
+ * @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(
+ array(
+ 'fields' => 'ids',
+ 'post_parent' => $font_family_id,
+ 'post_type' => 'wp_font_face',
+ 'posts_per_page' => 99,
+ 'order' => 'ASC',
+ 'orderby' => 'id',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ )
+ );
+
+ return $query->posts;
+ }
+
+ /**
+ * Prepares font family links for the request.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Post $post Post object.
+ * @return array Links for the given post.
+ */
+ protected function prepare_links( $post ) {
+ // Entity meta.
+ $links = parent::prepare_links( $post );
+
+ return array(
+ 'self' => $links['self'],
+ 'collection' => $links['collection'],
+ 'font_faces' => $this->prepare_font_face_links( $post->ID ),
+ );
+ }
+
+ /**
+ * Prepares child font face links for the request.
+ *
+ * @param int $font_family_id Font family post ID.
+ * @return array Links for the child font face posts.
+ */
+ protected function prepare_font_face_links( $font_family_id ) {
+ $font_face_ids = $this->get_font_face_ids( $font_family_id );
+ $links = array();
+ foreach ( $font_face_ids as $font_face_id ) {
+ $links[] = array(
+ 'embeddable' => true,
+ 'href' => rest_url( sprintf( '%s/%s/%s/font-faces/%s', $this->namespace, $this->rest_base, $font_family_id, $font_face_id ) ),
+ );
+ }
+ return $links;
+ }
+
+ /**
+ * Prepares a single font family post for create or update.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Request object.
+ * @return stdClass|WP_Error Post object or WP_Error.
+ */
+ protected function prepare_item_for_database( $request ) {
+ $prepared_post = new stdClass();
+ // Settings have already been decoded by ::sanitize_font_family_settings().
+ $settings = $request->get_param( 'font_family_settings' );
+
+ // This is an update and we merge with the existing font family.
+ if ( isset( $request['id'] ) ) {
+ $existing_post = $this->get_post( $request['id'] );
+ if ( is_wp_error( $existing_post ) ) {
+ return $existing_post;
+ }
+
+ $prepared_post->ID = $existing_post->ID;
+ $existing_settings = $this->get_settings_from_post( $existing_post );
+ $settings = array_merge( $existing_settings, $settings );
+ }
+
+ $prepared_post->post_type = $this->post_type;
+ $prepared_post->post_status = 'publish';
+ $prepared_post->post_title = $settings['name'];
+ $prepared_post->post_name = sanitize_title( $settings['slug'] );
+
+ // Remove duplicate information from settings.
+ unset( $settings['name'] );
+ unset( $settings['slug'] );
+
+ $prepared_post->post_content = wp_json_encode( $settings );
+
+ return $prepared_post;
+ }
+
+ /**
+ * Gets the font family's settings from the post.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Post $post Font family post object.
+ * @return array Font family settings array.
+ */
+ protected function get_settings_from_post( $post ) {
+ $settings_json = json_decode( $post->post_content, true );
+
+ // Default to empty strings if the settings are missing.
+ return array(
+ 'name' => isset( $post->post_title ) && $post->post_title ? $post->post_title : '',
+ 'slug' => isset( $post->post_name ) && $post->post_name ? $post->post_name : '',
+ 'fontFamily' => isset( $settings_json['fontFamily'] ) && $settings_json['fontFamily'] ? $settings_json['fontFamily'] : '',
+ 'preview' => isset( $settings_json['preview'] ) && $settings_json['preview'] ? $settings_json['preview'] : '',
+ );
+ }
+}
diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-revisions-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-revisions-controller.php
index 9ce7e2b3df66a..db1be197e5ab4 100644
--- a/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-revisions-controller.php
+++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-revisions-controller.php
@@ -47,6 +47,7 @@ public function __construct() {
* Registers the controller's routes.
*
* @since 6.3.0
+ * @since 6.5.0 Added route to fetch individual global styles revisions.
*/
public function register_routes() {
register_rest_route(
@@ -68,6 +69,32 @@ public function register_routes() {
'schema' => array( $this, 'get_public_item_schema' ),
)
);
+
+ register_rest_route(
+ $this->namespace,
+ '/' . $this->parent_base . '/(?P[\d]+)/' . $this->rest_base . '/(?P[\d]+)',
+ array(
+ 'args' => array(
+ 'parent' => array(
+ 'description' => __( 'The ID for the parent of the global styles revision.' ),
+ 'type' => 'integer',
+ ),
+ 'id' => array(
+ 'description' => __( 'Unique identifier for the global styles revision.' ),
+ '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' ) ),
+ ),
+ ),
+ 'schema' => array( $this, 'get_public_item_schema' ),
+ )
+ );
}
/**
@@ -241,6 +268,56 @@ public function get_items( $request ) {
return $response;
}
+ /**
+ * Retrieves one global styles revision from the collection.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+ */
+ public function get_item( $request ) {
+ $parent = $this->get_parent( $request['parent'] );
+ if ( is_wp_error( $parent ) ) {
+ return $parent;
+ }
+
+ $revision = $this->get_revision( $request['id'] );
+ if ( is_wp_error( $revision ) ) {
+ return $revision;
+ }
+
+ $response = $this->prepare_item_for_response( $revision, $request );
+ return rest_ensure_response( $response );
+ }
+
+ /**
+ * Gets the global styles revision, if the ID is valid.
+ *
+ * @since 6.5.0
+ *
+ * @param int $id Supplied ID.
+ * @return WP_Post|WP_Error Revision post object if ID is valid, WP_Error otherwise.
+ */
+ protected function get_revision( $id ) {
+ $error = new WP_Error(
+ 'rest_post_invalid_id',
+ __( 'Invalid global styles revision ID.' ),
+ array( 'status' => 404 )
+ );
+
+ if ( (int) $id <= 0 ) {
+ return $error;
+ }
+
+ $revision = get_post( (int) $id );
+ if ( empty( $revision ) || empty( $revision->ID ) || 'revision' !== $revision->post_type ) {
+ return $error;
+ }
+
+ return $revision;
+ }
+
/**
* Checks the post_date_gmt or modified_gmt and prepare any post or
* modified date for single post output.
diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php
index 53f8faa75595b..1549fd4295561 100644
--- a/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php
+++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php
@@ -726,6 +726,14 @@ public function prepare_item_for_response( $item, $request ) {
$data['modified'] = mysql_to_rfc3339( $template->modified );
}
+ if ( rest_is_field_included( 'author_text', $fields ) ) {
+ $data['author_text'] = self::get_wp_templates_author_text_field( $template );
+ }
+
+ if ( rest_is_field_included( 'original_source', $fields ) ) {
+ $data['original_source'] = self::get_wp_templates_original_source_field( $template );
+ }
+
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request );
$data = $this->filter_response_by_context( $data, $context );
@@ -748,6 +756,83 @@ public function prepare_item_for_response( $item, $request ) {
return $response;
}
+ /**
+ * Returns the source from where the template originally comes from.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Block_Template $template_object Template instance.
+ * @return string Original source of the template one of theme, plugin, site, or user.
+ */
+ private static function get_wp_templates_original_source_field( $template_object ) {
+ if ( 'wp_template' === $template_object->type || 'wp_template_part' === $template_object->type ) {
+ // Added by theme.
+ // Template originally provided by a theme, but customized by a user.
+ // Templates originally didn't have the 'origin' field so identify
+ // older customized templates by checking for no origin and a 'theme'
+ // or 'custom' source.
+ if ( $template_object->has_theme_file &&
+ ( 'theme' === $template_object->origin || (
+ empty( $template_object->origin ) && in_array(
+ $template_object->source,
+ array(
+ 'theme',
+ 'custom',
+ ),
+ true
+ ) )
+ )
+ ) {
+ return 'theme';
+ }
+
+ // Added by plugin.
+ if ( $template_object->has_theme_file && 'plugin' === $template_object->origin ) {
+ return 'plugin';
+ }
+
+ // Added by site.
+ // Template was created from scratch, but has no author. Author support
+ // was only added to templates in WordPress 5.9. Fallback to showing the
+ // site logo and title.
+ if ( empty( $template_object->has_theme_file ) && 'custom' === $template_object->source && empty( $template_object->author ) ) {
+ return 'site';
+ }
+ }
+
+ // Added by user.
+ return 'user';
+ }
+
+ /**
+ * Returns a human readable text for the author of the template.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Block_Template $template_object Template instance.
+ * @return string Human readable text for the author.
+ */
+ private static function get_wp_templates_author_text_field( $template_object ) {
+ $original_source = self::get_wp_templates_original_source_field( $template_object );
+ switch ( $original_source ) {
+ case 'theme':
+ $theme_name = wp_get_theme( $template_object->theme )->get( 'Name' );
+ return empty( $theme_name ) ? $template_object->theme : $theme_name;
+ case 'plugin':
+ $plugins = get_plugins();
+ $plugin = $plugins[ plugin_basename( sanitize_text_field( $template_object->theme . '.php' ) ) ];
+ return empty( $plugin['Name'] ) ? $template_object->theme : $plugin['Name'];
+ case 'site':
+ return get_bloginfo( 'name' );
+ case 'user':
+ $author = get_user_by( 'id', $template_object->author );
+ if ( ! $author ) {
+ return __( 'Unknown author' );
+ }
+ return $author->get( 'display_name' );
+ }
+ }
+
/**
* Prepares links for the request.
@@ -861,13 +946,13 @@ public function get_item_schema() {
'title' => $this->post_type,
'type' => 'object',
'properties' => array(
- 'id' => array(
+ 'id' => array(
'description' => __( 'ID of template.' ),
'type' => 'string',
'context' => array( 'embed', 'view', 'edit' ),
'readonly' => true,
),
- 'slug' => array(
+ 'slug' => array(
'description' => __( 'Unique slug identifying the template.' ),
'type' => 'string',
'context' => array( 'embed', 'view', 'edit' ),
@@ -875,29 +960,29 @@ public function get_item_schema() {
'minLength' => 1,
'pattern' => '[a-zA-Z0-9_\%-]+',
),
- 'theme' => array(
+ 'theme' => array(
'description' => __( 'Theme identifier for the template.' ),
'type' => 'string',
'context' => array( 'embed', 'view', 'edit' ),
),
- 'type' => array(
+ 'type' => array(
'description' => __( 'Type of template.' ),
'type' => 'string',
'context' => array( 'embed', 'view', 'edit' ),
),
- 'source' => array(
+ 'source' => array(
'description' => __( 'Source of template' ),
'type' => 'string',
'context' => array( 'embed', 'view', 'edit' ),
'readonly' => true,
),
- 'origin' => array(
+ 'origin' => array(
'description' => __( 'Source of a customized template' ),
'type' => 'string',
'context' => array( 'embed', 'view', 'edit' ),
'readonly' => true,
),
- 'content' => array(
+ 'content' => array(
'description' => __( 'Content of template.' ),
'type' => array( 'object', 'string' ),
'default' => '',
@@ -916,7 +1001,7 @@ public function get_item_schema() {
),
),
),
- 'title' => array(
+ 'title' => array(
'description' => __( 'Title of template.' ),
'type' => array( 'object', 'string' ),
'default' => '',
@@ -935,43 +1020,61 @@ public function get_item_schema() {
),
),
),
- 'description' => array(
+ 'description' => array(
'description' => __( 'Description of template.' ),
'type' => 'string',
'default' => '',
'context' => array( 'embed', 'view', 'edit' ),
),
- 'status' => array(
+ 'status' => array(
'description' => __( 'Status of template.' ),
'type' => 'string',
'enum' => array_keys( get_post_stati( array( 'internal' => false ) ) ),
'default' => 'publish',
'context' => array( 'embed', 'view', 'edit' ),
),
- 'wp_id' => array(
+ 'wp_id' => array(
'description' => __( 'Post ID.' ),
'type' => 'integer',
'context' => array( 'embed', 'view', 'edit' ),
'readonly' => true,
),
- 'has_theme_file' => array(
+ 'has_theme_file' => array(
'description' => __( 'Theme file exists.' ),
'type' => 'bool',
'context' => array( 'embed', 'view', 'edit' ),
'readonly' => true,
),
- 'author' => array(
+ 'author' => array(
'description' => __( 'The ID for the author of the template.' ),
'type' => 'integer',
'context' => array( 'view', 'edit', 'embed' ),
),
- 'modified' => array(
+ 'modified' => array(
'description' => __( "The date the template was last modified, in the site's timezone." ),
'type' => 'string',
'format' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
+ 'author_text' => array(
+ 'type' => 'string',
+ 'description' => __( 'Human readable text for the author.' ),
+ 'readonly' => true,
+ 'context' => array( 'view', 'edit', 'embed' ),
+ ),
+ 'original_source' => array(
+ 'description' => __( 'Where the template originally comes from e.g. \'theme\'' ),
+ 'type' => 'string',
+ 'readonly' => true,
+ 'context' => array( 'view', 'edit', 'embed' ),
+ 'enum' => array(
+ 'theme',
+ 'plugin',
+ 'site',
+ 'user',
+ ),
+ ),
),
);
diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php
index c9ac6675d093f..7dcc4d79236a1 100644
--- a/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php
+++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php
@@ -128,7 +128,7 @@ public function get_item_schema() {
*
* @since 5.9.0
*
- * @param WP_REST_REQUEST $request Full details about the request.
+ * @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error The parsed details as a response object. WP_Error if there are errors.
*/
public function parse_url_details( $request ) {
diff --git a/src/wp-includes/rss.php b/src/wp-includes/rss.php
index 6d8941ab3856d..4d3f35e5cb547 100644
--- a/src/wp-includes/rss.php
+++ b/src/wp-includes/rss.php
@@ -631,6 +631,9 @@ function _response_to_rss ($resp) {
* Set up constants with default values, unless user overrides.
*
* @since 1.5.0
+ *
+ * @global string $wp_version The WordPress version string.
+ *
* @package External
* @subpackage MagpieRSS
*/
diff --git a/src/wp-includes/script-loader.php b/src/wp-includes/script-loader.php
index 8886cb587b170..932fcfc06c6c0 100644
--- a/src/wp-includes/script-loader.php
+++ b/src/wp-includes/script-loader.php
@@ -96,6 +96,7 @@ function wp_default_packages_vendor( $scripts ) {
'lodash',
'wp-polyfill-fetch',
'wp-polyfill-formdata',
+ 'wp-polyfill-importmap',
'wp-polyfill-node-contains',
'wp-polyfill-url',
'wp-polyfill-dom-rect',
@@ -120,6 +121,7 @@ function wp_default_packages_vendor( $scripts ) {
'wp-polyfill-object-fit' => '2.3.5',
'wp-polyfill-inert' => '3.1.2',
'wp-polyfill' => '3.15.0',
+ 'wp-polyfill-importmap' => '1.8.2',
);
foreach ( $vendor_scripts as $handle => $dependencies ) {
@@ -417,6 +419,8 @@ function wp_default_packages_inline_scripts( $scripts ) {
$timezone_abbr = $timezone_date->format( 'T' );
}
+ $gmt_offset = get_option( 'gmt_offset', 0 );
+
$scripts->add_inline_script(
'wp-date',
sprintf(
@@ -437,27 +441,27 @@ function wp_default_packages_inline_scripts( $scripts ) {
'past' => __( '%s ago' ),
/* translators: One second from or to a particular datetime, e.g., "a second ago" or "a second from now". */
's' => __( 'a second' ),
- /* translators: %s: Duration in seconds from or to a particular datetime, e.g., "4 seconds ago" or "4 seconds from now". */
+ /* translators: %d: Duration in seconds from or to a particular datetime, e.g., "4 seconds ago" or "4 seconds from now". */
'ss' => __( '%d seconds' ),
/* translators: One minute from or to a particular datetime, e.g., "a minute ago" or "a minute from now". */
'm' => __( 'a minute' ),
- /* translators: %s: Duration in minutes from or to a particular datetime, e.g., "4 minutes ago" or "4 minutes from now". */
+ /* translators: %d: Duration in minutes from or to a particular datetime, e.g., "4 minutes ago" or "4 minutes from now". */
'mm' => __( '%d minutes' ),
- /* translators: %s: One hour from or to a particular datetime, e.g., "an hour ago" or "an hour from now". */
+ /* translators: One hour from or to a particular datetime, e.g., "an hour ago" or "an hour from now". */
'h' => __( 'an hour' ),
- /* translators: %s: Duration in hours from or to a particular datetime, e.g., "4 hours ago" or "4 hours from now". */
+ /* translators: %d: Duration in hours from or to a particular datetime, e.g., "4 hours ago" or "4 hours from now". */
'hh' => __( '%d hours' ),
- /* translators: %s: One day from or to a particular datetime, e.g., "a day ago" or "a day from now". */
+ /* translators: One day from or to a particular datetime, e.g., "a day ago" or "a day from now". */
'd' => __( 'a day' ),
- /* translators: %s: Duration in days from or to a particular datetime, e.g., "4 days ago" or "4 days from now". */
+ /* translators: %d: Duration in days from or to a particular datetime, e.g., "4 days ago" or "4 days from now". */
'dd' => __( '%d days' ),
- /* translators: %s: One month from or to a particular datetime, e.g., "a month ago" or "a month from now". */
+ /* translators: One month from or to a particular datetime, e.g., "a month ago" or "a month from now". */
'M' => __( 'a month' ),
- /* translators: %s: Duration in months from or to a particular datetime, e.g., "4 months ago" or "4 months from now". */
+ /* translators: %d: Duration in months from or to a particular datetime, e.g., "4 months ago" or "4 months from now". */
'MM' => __( '%d months' ),
- /* translators: %s: One year from or to a particular datetime, e.g., "a year ago" or "a year from now". */
+ /* translators: One year from or to a particular datetime, e.g., "a year ago" or "a year from now". */
'y' => __( 'a year' ),
- /* translators: %s: Duration in years from or to a particular datetime, e.g., "4 years ago" or "4 years from now". */
+ /* translators: %d: Duration in years from or to a particular datetime, e.g., "4 years ago" or "4 years from now". */
'yy' => __( '%d years' ),
),
'startOfWeek' => (int) get_option( 'start_of_week', 0 ),
@@ -473,9 +477,10 @@ function wp_default_packages_inline_scripts( $scripts ) {
'datetimeAbbreviated' => __( 'M j, Y g:i a' ),
),
'timezone' => array(
- 'offset' => (float) get_option( 'gmt_offset', 0 ),
- 'string' => $timezone_string,
- 'abbr' => $timezone_abbr,
+ 'offset' => (float) $gmt_offset,
+ 'offsetFormatted' => str_replace( array( '.25', '.5', '.75' ), array( ':15', ':30', ':45' ), (string) $gmt_offset ),
+ 'string' => $timezone_string,
+ 'abbr' => $timezone_abbr,
),
)
)
@@ -1714,7 +1719,7 @@ function wp_default_styles( $styles ) {
);
$package_styles = array(
- 'block-editor' => array( 'wp-components' ),
+ 'block-editor' => array( 'wp-components', 'wp-preferences' ),
'block-library' => array(),
'block-directory' => array(),
'components' => array(),
@@ -1726,17 +1731,20 @@ function wp_default_styles( $styles ) {
'wp-edit-blocks',
'wp-block-library',
'wp-commands',
+ 'wp-preferences',
),
'editor' => array(
'wp-components',
'wp-block-editor',
'wp-reusable-blocks',
'wp-patterns',
+ 'wp-preferences',
),
'format-library' => array(),
'list-reusable-blocks' => array( 'wp-components' ),
'reusable-blocks' => array( 'wp-components' ),
'patterns' => array( 'wp-components' ),
+ 'preferences' => array( 'wp-components' ),
'nux' => array( 'wp-components' ),
'widgets' => array(
'wp-components',
@@ -1748,6 +1756,7 @@ function wp_default_styles( $styles ) {
'wp-block-library',
'wp-reusable-blocks',
'wp-patterns',
+ 'wp-preferences',
),
'customize-widgets' => array(
'wp-widgets',
@@ -1756,12 +1765,14 @@ function wp_default_styles( $styles ) {
'wp-block-library',
'wp-reusable-blocks',
'wp-patterns',
+ 'wp-preferences',
),
'edit-site' => array(
'wp-components',
'wp-block-editor',
'wp-edit-blocks',
'wp-commands',
+ 'wp-preferences',
),
);
@@ -2586,7 +2597,7 @@ function wp_should_load_block_editor_scripts_and_styles() {
* @return bool Whether separate assets will be loaded.
*/
function wp_should_load_separate_core_block_assets() {
- if ( is_admin() || is_feed() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) {
+ if ( is_admin() || is_feed() || wp_is_rest_endpoint() ) {
return false;
}
@@ -2834,18 +2845,18 @@ function wp_print_script_tag( $attributes ) {
}
/**
- * Wraps inline JavaScript in `\n", wp_sanitize_script_attributes( $attributes ), $javascript );
+ return sprintf( "%s\n", wp_sanitize_script_attributes( $attributes ), $data );
}
/**
- * Prints inline JavaScript wrapped in `',
+ 'description' => 'My collection description',
+ 'font_families' => array(
+ array(
+ 'font_family_settings' => array(
+ 'fontFamily' => 'Open Sans, sans-serif',
+ 'slug' => 'open-sans',
+ 'name' => 'Open Sans',
+ 'fontFace' => array(
+ array(
+ 'fontFamily' => 'Open Sans',
+ 'fontStyle' => 'normal',
+ 'fontWeight' => '400',
+ 'src' => 'https://example.com/src-as-string.ttf?a=',
+ ),
+ array(
+ 'fontFamily' => 'Open Sans',
+ 'fontStyle' => 'normal',
+ 'fontWeight' => '400',
+ 'src' => array(
+ 'https://example.com/src-as-array.woff2?a=',
+ 'https://example.com/src-as-array.ttf',
+ ),
+ ),
+ ),
+ 'unwanted_property' => 'potentially evil value',
+ ),
+ 'categories' => array( 'sans-serif' ),
+ ),
+ ),
+ 'categories' => array(
+ array(
+ 'name' => 'Mock col',
+ 'slug' => 'mock-col',
+ 'unwanted_property' => 'potentially evil value',
+ ),
+ ),
+ 'unwanted_property' => 'potentially evil value',
+ ),
+ 'expected_data' => array(
+ 'description' => 'My collection description',
+ 'categories' => array(
+ array(
+ 'name' => 'Mock col',
+ 'slug' => 'mock-colalertxss',
+ ),
+ ),
+ 'name' => 'My Collection',
+ 'font_families' => array(
+ array(
+ 'font_family_settings' => array(
+ 'fontFamily' => 'Open Sans, sans-serif',
+ 'slug' => 'open-sans',
+ 'name' => 'Open Sans',
+ 'fontFace' => array(
+ array(
+ 'fontFamily' => 'Open Sans',
+ 'fontStyle' => 'normal',
+ 'fontWeight' => '400',
+ 'src' => 'https://example.com/src-as-string.ttf?a=',
+ ),
+ array(
+ 'fontFamily' => 'Open Sans',
+ 'fontStyle' => 'normal',
+ 'fontWeight' => '400',
+ 'src' => array(
+ 'https://example.com/src-as-array.woff2?a=',
+ 'https://example.com/src-as-array.ttf',
+ ),
+ ),
+ ),
+ ),
+ 'categories' => array( 'sans-serifalertxss' ),
+ ),
+ ),
+ ),
+ ),
+
+ );
+ }
+
+ /**
+ * @dataProvider data_should_error_when_missing_properties
+ *
+ * @param array $config Font collection config.
+ */
+ public function test_should_error_when_missing_properties( $config ) {
+ $this->setExpectedIncorrectUsage( 'WP_Font_Collection::sanitize_and_validate_data' );
+
+ $collection = new WP_Font_Collection( 'my-collection', $config );
+ $data = $collection->get_data();
+
+ $this->assertWPError( $data, 'Error is not returned when property is missing or invalid.' );
+ $this->assertSame(
+ $data->get_error_code(),
+ 'font_collection_missing_property',
+ 'Incorrect error code when property is missing or invalid.'
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_should_error_when_missing_properties() {
+ return array(
+ 'missing name' => array(
+ 'config' => array(
+ 'font_families' => array( 'mock' ),
+ ),
+ ),
+ 'empty name' => array(
+ 'config' => array(
+ 'name' => '',
+ 'font_families' => array( 'mock' ),
+ ),
+ ),
+ 'missing font_families' => array(
+ 'config' => array(
+ 'name' => 'My Collection',
+ ),
+ ),
+ 'empty font_families' => array(
+ 'config' => array(
+ 'name' => 'My Collection',
+ 'font_families' => array(),
+ ),
+ ),
+ );
+ }
+
+ public function test_should_error_with_invalid_json_file_path() {
+ $this->setExpectedIncorrectUsage( 'WP_Font_Collection::load_from_json' );
+
+ $collection = new WP_Font_Collection( 'my-collection', 'non-existing.json' );
+ $data = $collection->get_data();
+
+ $this->assertWPError( $data, 'Error is not returned when invalid file path is provided.' );
+ $this->assertSame(
+ $data->get_error_code(),
+ 'font_collection_json_missing',
+ 'Incorrect error code when invalid file path is provided.'
+ );
+ }
+
+ public function test_should_error_with_invalid_json_from_file() {
+ $mock_file = wp_tempnam( 'my-collection-data-' );
+ file_put_contents( $mock_file, 'invalid-json' );
+
+ $collection = new WP_Font_Collection( 'my-collection', $mock_file );
+
+ // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged -- Testing error response returned by `load_from_json`, not the underlying error from `wp_json_file_decode`.
+ $data = @$collection->get_data();
+
+ $this->assertWPError( $data, 'Error is not returned with invalid json file contents.' );
+ $this->assertSame(
+ $data->get_error_code(),
+ 'font_collection_decode_error',
+ 'Incorrect error code with invalid json file contents.'
+ );
+ }
+
+ public function test_should_error_with_invalid_url() {
+ $this->setExpectedIncorrectUsage( 'WP_Font_Collection::load_from_json' );
+
+ $collection = new WP_Font_Collection( 'my-collection', 'not-a-url' );
+ $data = $collection->get_data();
+
+ $this->assertWPError( $data, 'Error is not returned when invalid url is provided.' );
+ $this->assertSame(
+ $data->get_error_code(),
+ 'font_collection_json_missing',
+ 'Incorrect error code when invalid url is provided.'
+ );
+ }
+
+ public function test_should_error_with_unsuccessful_response_status() {
+ add_filter( 'pre_http_request', array( $this, 'mock_request_unsuccessful_response' ), 10, 3 );
+
+ $collection = new WP_Font_Collection( 'my-collection', 'https://example.com/fonts/missing-collection.json' );
+ $data = $collection->get_data();
+
+ remove_filter( 'pre_http_request', array( $this, 'mock_request_unsuccessful_response' ) );
+
+ $this->assertWPError( $data, 'Error is not returned when response is unsuccessful.' );
+ $this->assertSame(
+ $data->get_error_code(),
+ 'font_collection_request_error',
+ 'Incorrect error code when response is unsuccussful.'
+ );
+ }
+
+ public function test_should_error_with_invalid_json_from_url() {
+ add_filter( 'pre_http_request', array( $this, 'mock_request_invalid_json' ), 10, 3 );
+
+ $collection = new WP_Font_Collection( 'my-collection', 'https://example.com/fonts/invalid-collection.json' );
+ $data = $collection->get_data();
+
+ remove_filter( 'pre_http_request', array( $this, 'mock_request_invalid_json' ) );
+
+ $this->assertWPError( $data, 'Error is not returned when response is invalid json.' );
+ $this->assertSame(
+ $data->get_error_code(),
+ 'font_collection_decode_error',
+ 'Incorrect error code when response is invalid json.'
+ );
+ }
+
+ public function mock_request( $preempt, $args, $url ) {
+ if ( 'https://example.com/fonts/mock-font-collection.json' !== $url ) {
+ return false;
+ }
+
+ return array(
+ 'body' => wp_json_encode( self::$mock_collection_data ),
+ 'response' => array(
+ 'code' => 200,
+ ),
+ );
+ }
+
+ public function mock_request_unsuccessful_response( $preempt, $args, $url ) {
+ if ( 'https://example.com/fonts/missing-collection.json' !== $url ) {
+ return false;
+ }
+
+ return array(
+ 'body' => '',
+ 'response' => array(
+ 'code' => 404,
+ ),
+ );
+ }
+
+ public function mock_request_invalid_json( $preempt, $args, $url ) {
+ if ( 'https://example.com/fonts/invalid-collection.json' !== $url ) {
+ return false;
+ }
+
+ return array(
+ 'body' => 'invalid',
+ 'response' => array(
+ 'code' => 200,
+ ),
+ );
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpFontLibrary/base.php b/tests/phpunit/tests/fonts/font-library/wpFontLibrary/base.php
new file mode 100644
index 0000000000000..135329e5add73
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpFontLibrary/base.php
@@ -0,0 +1,25 @@
+get_font_collections();
+ foreach ( $collections as $slug => $collection ) {
+ WP_Font_Library::get_instance()->unregister_font_collection( $slug );
+ }
+ }
+
+ public function set_up() {
+ parent::set_up();
+ $this->reset_font_collections();
+ }
+
+ public function tear_down() {
+ parent::tear_down();
+ $this->reset_font_collections();
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpFontLibrary/getFontCollection.php b/tests/phpunit/tests/fonts/font-library/wpFontLibrary/getFontCollection.php
new file mode 100644
index 0000000000000..e01cc2c1a105a
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpFontLibrary/getFontCollection.php
@@ -0,0 +1,30 @@
+ 'Test Collection',
+ 'font_families' => array( 'mock' ),
+ );
+
+ wp_register_font_collection( 'my-font-collection', $mock_collection_data );
+ $font_collection = WP_Font_Library::get_instance()->get_font_collection( 'my-font-collection' );
+ $this->assertInstanceOf( 'WP_Font_Collection', $font_collection );
+ }
+
+ public function test_should_get_no_font_collection_if_the_slug_is_not_registered() {
+ $font_collection = WP_Font_Library::get_instance()->get_font_collection( 'not-registered-font-collection' );
+ $this->assertNull( $font_collection );
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpFontLibrary/getFontCollections.php b/tests/phpunit/tests/fonts/font-library/wpFontLibrary/getFontCollections.php
new file mode 100644
index 0000000000000..f5ca6389b8ff5
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpFontLibrary/getFontCollections.php
@@ -0,0 +1,34 @@
+get_font_collections();
+ $this->assertEmpty( $font_collections, 'Should return an empty array.' );
+ }
+
+ public function test_should_get_mock_font_collection() {
+ $my_font_collection_config = array(
+ 'name' => 'My Font Collection',
+ 'description' => 'Demo about how to a font collection to your WordPress Font Library.',
+ 'font_families' => array( 'mock' ),
+ );
+
+ WP_Font_Library::get_instance()->register_font_collection( 'my-font-collection', $my_font_collection_config );
+
+ $font_collections = WP_Font_Library::get_instance()->get_font_collections();
+ $this->assertNotEmpty( $font_collections, 'Should return an array of font collections.' );
+ $this->assertCount( 1, $font_collections, 'Should return an array with one font collection.' );
+ $this->assertArrayHasKey( 'my-font-collection', $font_collections, 'The array should have the key of the registered font collection id.' );
+ $this->assertInstanceOf( 'WP_Font_Collection', $font_collections['my-font-collection'], 'The value of the array $font_collections[id] should be an instance of WP_Font_Collection class.' );
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpFontLibrary/registerFontCollection.php b/tests/phpunit/tests/fonts/font-library/wpFontLibrary/registerFontCollection.php
new file mode 100644
index 0000000000000..d3b0f126e2e7e
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpFontLibrary/registerFontCollection.php
@@ -0,0 +1,40 @@
+ 'My Collection',
+ 'font_families' => array( 'mock' ),
+ );
+
+ $collection = WP_Font_Library::get_instance()->register_font_collection( 'my-collection', $config );
+ $this->assertInstanceOf( 'WP_Font_Collection', $collection );
+ }
+
+ public function test_should_return_error_if_slug_is_repeated() {
+ $mock_collection_data = array(
+ 'name' => 'Test Collection',
+ 'font_families' => array( 'mock' ),
+ );
+
+ // Register first collection.
+ $collection1 = WP_Font_Library::get_instance()->register_font_collection( 'my-collection-1', $mock_collection_data );
+ $this->assertInstanceOf( 'WP_Font_Collection', $collection1, 'A collection should be registered.' );
+
+ // Expects a _doing_it_wrong notice.
+ $this->setExpectedIncorrectUsage( 'WP_Font_Library::register_font_collection' );
+
+ // Try to register a second collection with same slug.
+ WP_Font_Library::get_instance()->register_font_collection( 'my-collection-1', $mock_collection_data );
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpFontLibrary/unregisterFontCollection.php b/tests/phpunit/tests/fonts/font-library/wpFontLibrary/unregisterFontCollection.php
new file mode 100644
index 0000000000000..ddb0fa91c1d60
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpFontLibrary/unregisterFontCollection.php
@@ -0,0 +1,46 @@
+ 'Test Collection',
+ 'font_families' => array( 'mock' ),
+ );
+
+ // Registers two mock font collections.
+ WP_Font_Library::get_instance()->register_font_collection( 'mock-font-collection-1', $mock_collection_data );
+ WP_Font_Library::get_instance()->register_font_collection( 'mock-font-collection-2', $mock_collection_data );
+
+ // Unregister mock font collection.
+ WP_Font_Library::get_instance()->unregister_font_collection( 'mock-font-collection-1' );
+ $collections = WP_Font_Library::get_instance()->get_font_collections();
+ $this->assertArrayNotHasKey( 'mock-font-collection-1', $collections, 'Font collection was not unregistered.' );
+ $this->assertArrayHasKey( 'mock-font-collection-2', $collections, 'Font collection was unregistered by mistake.' );
+
+ // Unregisters remaining mock font collection.
+ WP_Font_Library::get_instance()->unregister_font_collection( 'mock-font-collection-2' );
+ $collections = WP_Font_Library::get_instance()->get_font_collections();
+ $this->assertArrayNotHasKey( 'mock-font-collection-2', $collections, 'Mock font collection was not unregistered.' );
+
+ // Checks that all font collections were unregistered.
+ $this->assertEmpty( $collections, 'Font collections were not unregistered.' );
+ }
+
+ public function unregister_non_existing_collection() {
+ // Unregisters non-existing font collection.
+ WP_Font_Library::get_instance()->unregister_font_collection( 'non-existing-collection' );
+ $collections = WP_Font_Library::get_instance()->get_font_collections();
+ $this->assertEmpty( $collections, 'No collections should be registered.' );
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpFontUtils/getFontFaceSlug.php b/tests/phpunit/tests/fonts/font-library/wpFontUtils/getFontFaceSlug.php
new file mode 100644
index 0000000000000..de0b02e63185e
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpFontUtils/getFontFaceSlug.php
@@ -0,0 +1,92 @@
+assertSame( $expected_slug, $slug );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_get_font_face_slug_normalizes_values() {
+ return array(
+ 'Sets defaults' => array(
+ 'settings' => array(
+ 'fontFamily' => 'Open Sans',
+ ),
+ 'expected_slug' => 'open sans;normal;400;100%;U+0-10FFFF',
+ ),
+ 'Converts normal weight to 400' => array(
+ 'settings' => array(
+ 'fontFamily' => 'Open Sans',
+ 'fontWeight' => 'normal',
+ ),
+ 'expected_slug' => 'open sans;normal;400;100%;U+0-10FFFF',
+ ),
+ 'Converts bold weight to 700' => array(
+ 'settings' => array(
+ 'fontFamily' => 'Open Sans',
+ 'fontWeight' => 'bold',
+ ),
+ 'expected_slug' => 'open sans;normal;700;100%;U+0-10FFFF',
+ ),
+ 'Converts normal font-stretch to 100%' => array(
+ 'settings' => array(
+ 'fontFamily' => 'Open Sans',
+ 'fontStretch' => 'normal',
+ ),
+ 'expected_slug' => 'open sans;normal;400;100%;U+0-10FFFF',
+ ),
+ 'Removes double quotes from fontFamilies' => array(
+ 'settings' => array(
+ 'fontFamily' => '"Open Sans"',
+ ),
+ 'expected_slug' => 'open sans;normal;400;100%;U+0-10FFFF',
+ ),
+ 'Removes single quotes from fontFamilies' => array(
+ 'settings' => array(
+ 'fontFamily' => "'Open Sans'",
+ ),
+ 'expected_slug' => 'open sans;normal;400;100%;U+0-10FFFF',
+ ),
+ 'Removes spaces between comma separated font families' => array(
+ 'settings' => array(
+ 'fontFamily' => 'Open Sans, serif',
+ ),
+ 'expected_slug' => 'open sans,serif;normal;400;100%;U+0-10FFFF',
+ ),
+ 'Removes tabs between comma separated font families' => array(
+ 'settings' => array(
+ 'fontFamily' => "Open Sans,\tserif",
+ ),
+ 'expected_slug' => 'open sans,serif;normal;400;100%;U+0-10FFFF',
+ ),
+ 'Removes new lines between comma separated font families' => array(
+ 'settings' => array(
+ 'fontFamily' => "Open Sans,\nserif",
+ ),
+ 'expected_slug' => 'open sans,serif;normal;400;100%;U+0-10FFFF',
+ ),
+ );
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpFontUtils/sanitizeFontFamily.php b/tests/phpunit/tests/fonts/font-library/wpFontUtils/sanitizeFontFamily.php
new file mode 100644
index 0000000000000..71511331c65dc
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpFontUtils/sanitizeFontFamily.php
@@ -0,0 +1,63 @@
+assertSame(
+ $expected,
+ WP_Font_Utils::sanitize_font_family(
+ $font_family
+ )
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_should_sanitize_font_family() {
+ return array(
+ 'data_families_with_spaces_and_numbers' => array(
+ 'font_family' => 'Rock 3D , Open Sans,serif',
+ 'expected' => '"Rock 3D", "Open Sans", serif',
+ ),
+ 'data_single_font_family' => array(
+ 'font_family' => 'Rock 3D',
+ 'expected' => '"Rock 3D"',
+ ),
+ 'data_no_spaces' => array(
+ 'font_family' => 'Rock3D',
+ 'expected' => 'Rock3D',
+ ),
+ 'data_many_spaces_and_existing_quotes' => array(
+ 'font_family' => 'Rock 3D serif, serif,sans-serif, "Open Sans"',
+ 'expected' => '"Rock 3D serif", serif, sans-serif, "Open Sans"',
+ ),
+ 'data_empty_family' => array(
+ 'font_family' => ' ',
+ 'expected' => '',
+ ),
+ 'data_font_family_with_whitespace_tags_new_lines' => array(
+ 'font_family' => " Rock 3D\n ",
+ 'expected' => '"Rock 3D"',
+ ),
+ );
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpFontUtils/sanitizeFromSchema.php b/tests/phpunit/tests/fonts/font-library/wpFontUtils/sanitizeFromSchema.php
new file mode 100644
index 0000000000000..88983fe15a14e
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpFontUtils/sanitizeFromSchema.php
@@ -0,0 +1,310 @@
+assertSame( $result, $expected );
+ }
+
+ public function data_sanitize_from_schema() {
+ return array(
+ 'One level associative array' => array(
+ 'data' => array(
+ 'slug' => 'open - sans',
+ 'fontFamily' => 'Open Sans, sans-serif',
+ 'src' => 'https://wordpress.org/example.json',
+ ),
+ 'schema' => array(
+ 'slug' => 'sanitize_title',
+ 'fontFamily' => 'sanitize_text_field',
+ 'src' => 'sanitize_url',
+ ),
+ 'expected' => array(
+ 'slug' => 'open-sansalertxss',
+ 'fontFamily' => 'Open Sans, sans-serif',
+ 'src' => 'https://wordpress.org/example.json/stylescriptalert(xss)/script',
+ ),
+ ),
+
+ 'Nested associative arrays' => array(
+ 'data' => array(
+ 'slug' => 'open - sans',
+ 'fontFamily' => 'Open Sans, sans-serif',
+ 'src' => 'https://wordpress.org/example.json',
+ 'nested' => array(
+ 'key1' => 'value1',
+ 'key2' => 'value2',
+ 'nested2' => array(
+ 'key3' => 'value3',
+ 'key4' => 'value4',
+ ),
+ ),
+ ),
+ 'schema' => array(
+ 'slug' => 'sanitize_title',
+ 'fontFamily' => 'sanitize_text_field',
+ 'src' => 'sanitize_url',
+ 'nested' => array(
+ 'key1' => 'sanitize_text_field',
+ 'key2' => 'sanitize_text_field',
+ 'nested2' => array(
+ 'key3' => 'sanitize_text_field',
+ 'key4' => 'sanitize_text_field',
+ ),
+ ),
+ ),
+ 'expected' => array(
+ 'slug' => 'open-sansalertxss',
+ 'fontFamily' => 'Open Sans, sans-serif',
+ 'src' => 'https://wordpress.org/example.json/stylescriptalert(xss)/script',
+ 'nested' => array(
+ 'key1' => 'value1',
+ 'key2' => 'value2',
+ 'nested2' => array(
+ 'key3' => 'value3',
+ 'key4' => 'value4',
+ ),
+ ),
+ ),
+ ),
+
+ 'Indexed arrays' => array(
+ 'data' => array(
+ 'slug' => 'oPeN SaNs',
+ 'enum' => array(
+ 'value1',
+ 'value2',
+ 'value3',
+ ),
+ ),
+ 'schema' => array(
+ 'slug' => 'sanitize_title',
+ 'enum' => array( 'sanitize_text_field' ),
+ ),
+ 'expected' => array(
+ 'slug' => 'open-sans',
+ 'enum' => array( 'value1', 'value2', 'value3' ),
+ ),
+ ),
+
+ 'Nested indexed arrays' => array(
+ 'data' => array(
+ 'slug' => 'OPEN-SANS',
+ 'name' => 'Open Sans',
+ 'fontFace' => array(
+ array(
+ 'fontFamily' => 'Open Sans, sans-serif',
+ 'src' => 'https://wordpress.org/example.json/stylescriptalert(xss)/script',
+ ),
+ array(
+ 'fontFamily' => 'Open Sans, sans-serif',
+ 'src' => 'https://wordpress.org/example.json/stylescriptalert(xss)/script',
+ ),
+ ),
+ ),
+ 'schema' => array(
+ 'slug' => 'sanitize_title',
+ 'name' => 'sanitize_text_field',
+ 'fontFace' => array(
+ array(
+ 'fontFamily' => 'sanitize_text_field',
+ 'src' => 'sanitize_url',
+ ),
+ ),
+ ),
+ 'expected' => array(
+ 'slug' => 'open-sans',
+ 'name' => 'Open Sans',
+ 'fontFace' => array(
+ array(
+ 'fontFamily' => 'Open Sans, sans-serif',
+ 'src' => 'https://wordpress.org/example.json/stylescriptalert(xss)/script',
+ ),
+ array(
+ 'fontFamily' => 'Open Sans, sans-serif',
+ 'src' => 'https://wordpress.org/example.json/stylescriptalert(xss)/script',
+ ),
+ ),
+ ),
+ ),
+
+ 'Custom sanitization function' => array(
+ 'data' => array(
+ 'key1' => 'abc123edf456ghi789',
+ 'key2' => 'value2',
+ ),
+ 'schema' => array(
+ 'key1' => function ( $value ) {
+ // Remove the six first character.
+ return substr( $value, 6 );
+ },
+ 'key2' => function ( $value ) {
+ // Capitalize the value.
+ return strtoupper( $value );
+ },
+ ),
+ 'expected' => array(
+ 'key1' => 'edf456ghi789',
+ 'key2' => 'VALUE2',
+ ),
+ ),
+
+ 'Null as schema value' => array(
+ 'data' => array(
+ 'key1' => 'value1',
+ 'key2' => 'value2',
+ 'nested' => array(
+ 'key3' => 'value3',
+ 'key4' => 'value4',
+ ),
+ ),
+ 'schema' => array(
+ 'key1' => null,
+ 'key2' => 'sanitize_text_field',
+ 'nested' => null,
+ ),
+ 'expected' => array(
+ 'key1' => 'value1',
+ 'key2' => 'value2',
+ 'nested' => array(
+ 'key3' => 'value3',
+ 'key4' => 'value4',
+ ),
+ ),
+ ),
+
+ 'Keys to remove' => array(
+ 'data' => array(
+ 'key1' => 'value1',
+ 'key2' => 'value2',
+ 'unwanted1' => 'value',
+ 'unwanted2' => 'value',
+ 'nestedAssociative' => array(
+ 'key5' => 'value5',
+ 'unwanted3' => 'value',
+ ),
+ 'nestedIndexed' => array(
+ array(
+ 'key6' => 'value7',
+ 'unwanted4' => 'value',
+ ),
+ array(
+ 'key6' => 'value7',
+ 'unwanted5' => 'value',
+ ),
+ ),
+
+ ),
+ 'schema' => array(
+ 'key1' => 'sanitize_text_field',
+ 'key2' => 'sanitize_text_field',
+ 'nestedAssociative' => array(
+ 'key5' => 'sanitize_text_field',
+ ),
+ 'nestedIndexed' => array(
+ array(
+ 'key6' => 'sanitize_text_field',
+ ),
+ ),
+ ),
+ 'expected' => array(
+ 'key1' => 'value1',
+ 'key2' => 'value2',
+ 'nestedAssociative' => array(
+ 'key5' => 'value5',
+ ),
+ 'nestedIndexed' => array(
+ array(
+ 'key6' => 'value7',
+ ),
+ array(
+ 'key6' => 'value7',
+ ),
+ ),
+ ),
+ ),
+
+ 'With empty structure' => array(
+ 'data' => array(
+ 'slug' => 'open-sans',
+ 'nested' => array(
+ 'key1' => 'value',
+ 'nested2' => array(
+ 'key2' => 'value',
+ 'nested3' => array(
+ 'nested4' => array(),
+ ),
+ ),
+ ),
+ ),
+ 'schema' => array(
+ 'slug' => 'sanitize_title',
+ 'nested' => array(
+ 'key1' => 'sanitize_text_field',
+ 'nested2' => array(
+ 'key2' => 'sanitize_text_field',
+ 'nested3' => array(
+ 'key3' => 'sanitize_text_field',
+ 'nested4' => array(
+ 'key4' => 'sanitize_text_field',
+ ),
+ ),
+ ),
+ ),
+ ),
+ 'expected' => array(
+ 'slug' => 'open-sans',
+ 'nested' => array(
+ 'key1' => 'value',
+ 'nested2' => array(
+ 'key2' => 'value',
+ ),
+ ),
+ ),
+ ),
+ );
+ }
+
+ public function test_sanitize_from_schema_with_invalid_data() {
+ $data = 'invalid data';
+ $schema = array(
+ 'key1' => 'sanitize_text_field',
+ 'key2' => 'sanitize_text_field',
+ );
+
+ $result = WP_Font_Utils::sanitize_from_schema( $data, $schema );
+
+ $this->assertSame( $result, array() );
+ }
+
+
+ public function test_sanitize_from_schema_with_invalid_schema() {
+ $data = array(
+ 'key1' => 'value1',
+ 'key2' => 'value2',
+ );
+ $schema = 'invalid schema';
+
+ $result = WP_Font_Utils::sanitize_from_schema( $data, $schema );
+
+ $this->assertSame( $result, array() );
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpFontsDir.php b/tests/phpunit/tests/fonts/font-library/wpFontsDir.php
new file mode 100644
index 0000000000000..a8f79888315bd
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpFontsDir.php
@@ -0,0 +1,72 @@
+ path_join( WP_CONTENT_DIR, 'fonts' ),
+ 'url' => content_url( 'fonts' ),
+ 'subdir' => '',
+ 'basedir' => path_join( WP_CONTENT_DIR, 'fonts' ),
+ 'baseurl' => content_url( 'fonts' ),
+ 'error' => false,
+ );
+ }
+
+ public function test_fonts_dir() {
+ $font_dir = wp_get_font_dir();
+
+ $this->assertSame( $font_dir, static::$dir_defaults );
+ }
+
+ public function test_fonts_dir_with_filter() {
+ // Define a callback function to pass to the filter.
+ function set_new_values( $defaults ) {
+ $defaults['path'] = '/custom-path/fonts/my-custom-subdir';
+ $defaults['url'] = 'http://example.com/custom-path/fonts/my-custom-subdir';
+ $defaults['subdir'] = 'my-custom-subdir';
+ $defaults['basedir'] = '/custom-path/fonts';
+ $defaults['baseurl'] = 'http://example.com/custom-path/fonts';
+ $defaults['error'] = false;
+ return $defaults;
+ }
+
+ // Add the filter.
+ add_filter( 'font_dir', 'set_new_values' );
+
+ // Gets the fonts dir.
+ $font_dir = wp_get_font_dir();
+
+ $expected = array(
+ 'path' => '/custom-path/fonts/my-custom-subdir',
+ 'url' => 'http://example.com/custom-path/fonts/my-custom-subdir',
+ 'subdir' => 'my-custom-subdir',
+ 'basedir' => '/custom-path/fonts',
+ 'baseurl' => 'http://example.com/custom-path/fonts',
+ 'error' => false,
+ );
+
+ // Remove the filter.
+ remove_filter( 'font_dir', 'set_new_values' );
+
+ $this->assertSame( $expected, $font_dir, 'The wp_get_font_dir() method should return the expected values.' );
+
+ // Gets the fonts dir.
+ $font_dir = wp_get_font_dir();
+
+ $this->assertSame( static::$dir_defaults, $font_dir, 'The wp_get_font_dir() method should return the default values.' );
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpRestFontCollectionsController.php b/tests/phpunit/tests/fonts/font-library/wpRestFontCollectionsController.php
new file mode 100644
index 0000000000000..0f7fe8f9c662b
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpRestFontCollectionsController.php
@@ -0,0 +1,209 @@
+get_font_collections();
+ foreach ( $collections as $slug => $collection ) {
+ WP_Font_Library::get_instance()->unregister_font_collection( $slug );
+ }
+
+ self::$admin_id = $factory->user->create(
+ array(
+ 'role' => 'administrator',
+ )
+ );
+ self::$editor_id = $factory->user->create(
+ array(
+ 'role' => 'editor',
+ )
+ );
+ $mock_file = wp_tempnam( 'my-collection-data-' );
+ file_put_contents( $mock_file, '{"name": "Mock Collection", "font_families": [ "mock" ], "categories": [ "mock" ] }' );
+
+ wp_register_font_collection( 'mock-col-slug', $mock_file );
+ }
+
+ public static function wpTearDownAfterClass() {
+ self::delete_user( self::$admin_id );
+ self::delete_user( self::$editor_id );
+ wp_unregister_font_collection( 'mock-col-slug' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Collections_Controller::register_routes
+ */
+ public function test_register_routes() {
+ $routes = rest_get_server()->get_routes();
+ $this->assertCount( 1, $routes['/wp/v2/font-collections'], 'Rest server has not the collections path initialized.' );
+ $this->assertCount( 1, $routes['/wp/v2/font-collections/(?P[\/\w-]+)'], 'Rest server has not the collection path initialized.' );
+
+ $this->assertArrayHasKey( 'GET', $routes['/wp/v2/font-collections'][0]['methods'], 'Rest server has not the GET method for collections initialized.' );
+ $this->assertArrayHasKey( 'GET', $routes['/wp/v2/font-collections/(?P[\/\w-]+)'][0]['methods'], 'Rest server has not the GET method for collection initialized.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Collections_Controller::get_items
+ */
+ public function test_get_items() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-collections' );
+ $response = rest_get_server()->dispatch( $request );
+ $content = $response->get_data();
+ $this->assertIsArray( $content );
+ $this->assertSame( 200, $response->get_status() );
+ }
+
+ /**
+ * @covers WP_REST_Font_Collections_Controller::get_items
+ */
+ public function test_get_items_should_only_return_valid_collections() {
+ $this->setExpectedIncorrectUsage( 'WP_Font_Collection::load_from_json' );
+
+ wp_set_current_user( self::$admin_id );
+ wp_register_font_collection( 'invalid-collection', 'invalid-collection-file' );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-collections' );
+ $response = rest_get_server()->dispatch( $request );
+ $content = $response->get_data();
+
+ wp_unregister_font_collection( 'invalid-collection' );
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->assertCount( 1, $content, 'The response should only contain valid collections.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Collections_Controller::get_item
+ */
+ public function test_get_item() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-collections/mock-col-slug' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+
+ $response_data = $response->get_data();
+ $this->assertArrayHasKey( 'name', $response_data, 'Response data does not have the name key.' );
+ $this->assertArrayHasKey( 'slug', $response_data, 'Response data does not have the slug key.' );
+ $this->assertArrayHasKey( 'description', $response_data, 'Response data does not have the description key.' );
+ $this->assertArrayHasKey( 'font_families', $response_data, 'Response data does not have the font_families key.' );
+ $this->assertArrayHasKey( 'categories', $response_data, 'Response data does not have the categories key.' );
+
+ $this->assertIsString( $response_data['name'], 'name is not a string.' );
+ $this->assertIsString( $response_data['slug'], 'slug is not a string.' );
+ $this->assertIsString( $response_data['description'], 'description is not a string.' );
+
+ $this->assertIsArray( $response_data['font_families'], 'font_families is not an array.' );
+ $this->assertIsArray( $response_data['categories'], 'categories is not an array.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Collections_Controller::get_item
+ */
+ public function test_get_item_invalid_slug() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-collections/non-existing-collection' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_font_collection_not_found', $response, 404 );
+ }
+
+ /**
+ * @covers WP_REST_Font_Collections_Controller::get_item
+ */
+ public function test_get_item_invalid_collection() {
+ $this->setExpectedIncorrectUsage( 'WP_Font_Collection::load_from_json' );
+
+ wp_set_current_user( self::$admin_id );
+ $slug = 'invalid-collection';
+ wp_register_font_collection( $slug, 'invalid-collection-file' );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-collections/' . $slug );
+ $response = rest_get_server()->dispatch( $request );
+
+ wp_unregister_font_collection( $slug );
+
+ $this->assertErrorResponse( 'font_collection_json_missing', $response, 500, 'When the collection json file is invalid, the response should return an error for "font_collection_json_missing" with 500 status.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Collections_Controller::get_item
+ */
+ public function test_get_item_invalid_id_permission() {
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-collections/mock-col-slug' );
+
+ wp_set_current_user( 0 );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_read', $response, 401, 'The response status should be 401 for non-authenticated users.' );
+
+ wp_set_current_user( self::$editor_id );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_read', $response, 403, 'The response status should be 403 for users without the right permissions.' );
+ }
+
+ /**
+ * @doesNotPerformAssertions
+ */
+ public function test_context_param() {
+ // Controller does not use get_context_param().
+ }
+
+ /**
+ * @doesNotPerformAssertions
+ */
+ public function test_create_item() {
+ // Controller does not use test_create_item().
+ }
+
+ /**
+ * @doesNotPerformAssertions
+ */
+ public function test_update_item() {
+ // Controller does not use test_update_item().
+ }
+
+ /**
+ * @doesNotPerformAssertions
+ */
+ public function test_delete_item() {
+ // Controller does not use test_delete_item().
+ }
+
+ /**
+ * @doesNotPerformAssertions
+ */
+ public function test_prepare_item() {
+ // Controller does not use test_prepare_item().
+ }
+
+ public function test_get_item_schema() {
+ $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/font-collections' );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $properties = $data['schema']['properties'];
+ $this->assertCount( 5, $properties, 'There should be 5 properties in the response data schema.' );
+ $this->assertArrayHasKey( 'slug', $properties, 'The slug property should exist in the response data schema.' );
+ $this->assertArrayHasKey( 'name', $properties, 'The name property should exist in the response data schema.' );
+ $this->assertArrayHasKey( 'description', $properties, 'The description property should exist in the response data schema.' );
+ $this->assertArrayHasKey( 'font_families', $properties, 'The slug font_families should exist in the response data schema.' );
+ $this->assertArrayHasKey( 'categories', $properties, 'The categories property should exist in the response data schema.' );
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpRestFontFacesController.php b/tests/phpunit/tests/fonts/font-library/wpRestFontFacesController.php
new file mode 100644
index 0000000000000..3e74b23b7cb20
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpRestFontFacesController.php
@@ -0,0 +1,1076 @@
+ '"Open Sans"',
+ 'fontWeight' => '400',
+ 'fontStyle' => 'normal',
+ 'src' => 'https://fonts.gstatic.com/s/open-sans/v30/KFOkCnqEu92Fr1MmgWxPKTM1K9nz.ttf',
+ );
+
+ public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+ self::$font_family_id = Tests_REST_WpRestFontFamiliesController::create_font_family_post();
+ self::$other_font_family_id = Tests_REST_WpRestFontFamiliesController::create_font_family_post();
+
+ self::$font_face_id1 = self::create_font_face_post(
+ self::$font_family_id,
+ array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontWeight' => '400',
+ 'fontStyle' => 'normal',
+ 'src' => home_url( '/wp-content/fonts/open-sans-medium.ttf' ),
+ )
+ );
+ self::$font_face_id2 = self::create_font_face_post(
+ self::$font_family_id,
+ array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontWeight' => '900',
+ 'fontStyle' => 'normal',
+ 'src' => home_url( '/wp-content/fonts/open-sans-bold.ttf' ),
+ )
+ );
+
+ self::$admin_id = $factory->user->create(
+ array(
+ 'role' => 'administrator',
+ )
+ );
+ self::$editor_id = $factory->user->create(
+ array(
+ 'role' => 'editor',
+ )
+ );
+
+ self::$post_ids_for_cleanup = array();
+ }
+
+ public static function wpTearDownAfterClass() {
+ self::delete_user( self::$admin_id );
+ self::delete_user( self::$editor_id );
+
+ wp_delete_post( self::$font_family_id, true );
+ wp_delete_post( self::$other_font_family_id, true );
+ wp_delete_post( self::$font_face_id1, true );
+ wp_delete_post( self::$font_face_id2, true );
+ }
+
+ public function tear_down() {
+ foreach ( self::$post_ids_for_cleanup as $post_id ) {
+ wp_delete_post( $post_id, true );
+ }
+ self::$post_ids_for_cleanup = array();
+ parent::tear_down();
+ }
+
+ public static function create_font_face_post( $parent_id, $settings = array() ) {
+ $settings = array_merge( self::$default_settings, $settings );
+ $title = WP_Font_Utils::get_font_face_slug( $settings );
+ $post_id = self::factory()->post->create(
+ wp_slash(
+ array(
+ 'post_type' => 'wp_font_face',
+ 'post_status' => 'publish',
+ 'post_title' => $title,
+ 'post_name' => sanitize_title( $title ),
+ 'post_content' => wp_json_encode( $settings ),
+ 'post_parent' => $parent_id,
+ )
+ )
+ );
+
+ self::$post_ids_for_cleanup[] = $post_id;
+
+ return $post_id;
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::register_routes
+ */
+ public function test_register_routes() {
+ $routes = rest_get_server()->get_routes();
+ $this->assertArrayHasKey(
+ '/wp/v2/font-families/(?P[\d]+)/font-faces',
+ $routes,
+ 'Font faces collection for the given font family does not exist'
+ );
+ $this->assertCount(
+ 2,
+ $routes['/wp/v2/font-families/(?P[\d]+)/font-faces'],
+ 'Font faces collection for the given font family does not have exactly two elements'
+ );
+ $this->assertArrayHasKey(
+ '/wp/v2/font-families/(?P[\d]+)/font-faces/(?P[\d]+)',
+ $routes,
+ 'Single font face route for the given font family does not exist'
+ );
+ $this->assertCount(
+ 2,
+ $routes['/wp/v2/font-families/(?P[\d]+)/font-faces/(?P[\d]+)'],
+ 'Font faces collection for the given font family does not have exactly two elements'
+ );
+ }
+
+ public function test_font_faces_no_autosave_routes() {
+ $routes = rest_get_server()->get_routes();
+ $this->assertArrayNotHasKey(
+ '/wp/v2/font-families/(?P[\d]+)/font-faces/(?P[\d]+)/autosaves',
+ $routes,
+ 'Font faces autosaves route exists.'
+ );
+ $this->assertArrayNotHasKey(
+ '/wp/v2/font-families/(?P[\d]+)/font-faces/(?P[\d]+)/autosaves/(?P[\d]+)',
+ $routes,
+ 'Font faces autosaves by id route exists.'
+ );
+ }
+
+ /**
+ * @doesNotPerformAssertions
+ */
+ public function test_context_param() {
+ // See test_get_context_param().
+ }
+
+ /**
+ * @dataProvider data_get_context_param
+ *
+ * @covers WP_REST_Font_Faces_Controller::get_context_param
+ *
+ * @param bool $single_route Whether to test a single route.
+ */
+ public function test_get_context_param( $single_route ) {
+ $route = '/wp/v2/font-families/' . self::$font_family_id . '/font-faces';
+ if ( $single_route ) {
+ $route .= '/' . self::$font_face_id1;
+ }
+
+ $request = new WP_REST_Request( 'OPTIONS', $route );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $endpoint_data = $data['endpoints'][0];
+ $this->assertArrayNotHasKey( 'allow_batch', $endpoint_data, 'The allow_batch property should not exist in the endpoint data.' );
+ $this->assertSame( 'view', $endpoint_data['args']['context']['default'], 'The endpoint\'s args::context::default should be set to view.' );
+ $this->assertSame( array( 'view', 'embed', 'edit' ), $endpoint_data['args']['context']['enum'], 'The endpoint\'s args::context::enum should be set to [ view, embed, edit ].' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_get_context_param() {
+ return array(
+ 'Collection' => array( false ),
+ 'Single' => array( true ),
+ );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_items
+ */
+ public function test_get_items() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200' );
+ $this->assertCount( 2, $data, 'There should be 2 properties in the response data.' );
+ $this->assertArrayHasKey( '_links', $data[0], 'The _links property should exist in the response data 0.' );
+ $this->check_font_face_data( $data[0], self::$font_face_id2, $data[0]['_links'] );
+ $this->assertArrayHasKey( '_links', $data[1], 'The _links property should exist in the response data 1.' );
+ $this->check_font_face_data( $data[1], self::$font_face_id1, $data[1]['_links'] );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_items
+ */
+ public function test_get_items_no_permission() {
+ wp_set_current_user( 0 );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_read', $response, 401, 'The response should return an error with a "rest_cannot_read" code and 401 status.' );
+
+ wp_set_current_user( self::$editor_id );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_read', $response, 403, 'The response should return an error with a "rest_cannot_read" code and 403 status.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_items
+ */
+ public function test_get_items_missing_parent() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER . '/font-faces' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_post_invalid_parent', $response, 404 );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_item
+ */
+ public function test_get_item() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . self::$font_face_id1 );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->check_font_face_data( $data, self::$font_face_id1, $response->get_links() );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::prepare_item_for_response
+ */
+ public function test_get_item_removes_extra_settings() {
+ $font_face_id = self::create_font_face_post( self::$font_family_id, array( 'extra' => array() ) );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . $font_face_id );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->assertArrayHasKey( 'font_face_settings', $data, 'The font_face_settings property should exist in the response data.' );
+ $this->assertArrayNotHasKey( 'extra', $data['font_face_settings'], 'The extra property should exist in the font_face_settings data.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::prepare_item_for_response
+ */
+ public function test_get_item_malformed_post_content_returns_empty_settings() {
+ $font_face_id = wp_insert_post(
+ array(
+ 'post_type' => 'wp_font_face',
+ 'post_parent' => self::$font_family_id,
+ 'post_status' => 'publish',
+ 'post_content' => 'invalid',
+ )
+ );
+
+ self::$post_ids_for_cleanup[] = $font_face_id;
+
+ $empty_settings = array(
+ 'fontFamily' => '',
+ 'src' => array(),
+ );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . $font_face_id );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->assertArrayHasKey( 'font_face_settings', $data, 'The font_face_settings property should exist in the response data.' );
+ $this->assertSame( $empty_settings, $data['font_face_settings'], 'The empty settings should exist in the font_face_settings data.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_item
+ */
+ public function test_get_item_invalid_font_face_id() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_post_invalid_id', $response, 404 );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_item
+ */
+ public function test_get_item_no_permission() {
+ wp_set_current_user( 0 );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . self::$font_face_id1 );
+
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_read', $response, 401, 'The response should return an error with a "rest_cannot_read" code and 401 status.' );
+
+ wp_set_current_user( self::$editor_id );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_read', $response, 403, 'The response should return an error with a "rest_cannot_read" code and 403 status.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_item
+ */
+ public function test_get_item_missing_parent() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER . '/font-faces/' . self::$font_face_id1 );
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_post_invalid_parent', $response, 404 );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_item
+ */
+ public function test_get_item_valid_parent_id() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . self::$font_face_id1 );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->assertSame( self::$font_family_id, $data['parent'], 'The returned parent id should match the font family id.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_item
+ */
+ public function test_get_item_invalid_parent_id() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$other_font_family_id . '/font-faces/' . self::$font_face_id1 );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_font_face_parent_id_mismatch', $response, 404 );
+
+ $expected_message = 'The font face does not belong to the specified font family with id of "' . self::$other_font_family_id . '".';
+ $this->assertSame( $expected_message, $response->as_error()->get_error_messages()[0], 'The message must contain the correct parent ID.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::create_item
+ */
+ public function test_create_item() {
+ wp_set_current_user( self::$admin_id );
+ $files = $this->setup_font_file_upload( array( 'woff2' ) );
+
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param(
+ 'font_face_settings',
+ wp_json_encode(
+ array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontWeight' => '200',
+ 'fontStyle' => 'normal',
+ 'src' => array_keys( $files )[0],
+ )
+ )
+ );
+ $request->set_file_params( $files );
+
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 201, $response->get_status(), 'The response status should be 201.' );
+ $this->check_font_face_data( $data, $data['id'], $response->get_links() );
+ $this->check_file_meta( $data['id'], array( $data['font_face_settings']['src'] ) );
+
+ $settings = $data['font_face_settings'];
+ unset( $settings['src'] );
+ $this->assertSame(
+ array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontWeight' => '200',
+ 'fontStyle' => 'normal',
+ ),
+ $settings,
+ 'The font_face_settings data should match the expected data.'
+ );
+
+ $this->assertSame( self::$font_family_id, $data['parent'], 'The returned parent id should match the font family id.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::create_item
+ */
+ public function test_create_item_with_multiple_font_files() {
+ wp_set_current_user( self::$admin_id );
+ $files = $this->setup_font_file_upload( array( 'ttf', 'otf', 'woff', 'woff2' ) );
+
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param(
+ 'font_face_settings',
+ wp_json_encode(
+ array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontWeight' => '200',
+ 'fontStyle' => 'normal',
+ 'src' => array_keys( $files ),
+ )
+ )
+ );
+ $request->set_file_params( $files );
+
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 201, $response->get_status(), 'The response status should be 201.' );
+ $this->check_font_face_data( $data, $data['id'], $response->get_links() );
+ $this->check_file_meta( $data['id'], $data['font_face_settings']['src'] );
+
+ $settings = $data['font_face_settings'];
+ $this->assertCount( 4, $settings['src'], 'There should be 4 items in the font_face_settings::src data.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::create_item
+ */
+ public function test_create_item_invalid_file_type() {
+ $image_file = DIR_TESTDATA . '/images/canola.jpg';
+ $image_path = wp_tempnam( 'canola.jpg' );
+ copy( $image_file, $image_path );
+
+ $files = array(
+ 'file-0' => array(
+ 'name' => 'canola.jpg',
+ 'full_path' => 'canola.jpg',
+ 'type' => 'font/woff2',
+ 'tmp_name' => $image_path,
+ 'error' => 0,
+ 'size' => filesize( $image_path ),
+ ),
+ );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param(
+ 'font_face_settings',
+ wp_json_encode(
+ array_merge(
+ self::$default_settings,
+ array(
+ 'fontWeight' => '200',
+ 'src' => array_keys( $files )[0],
+ )
+ )
+ )
+ );
+ $request->set_file_params( $files );
+
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_font_upload_invalid_file_type', $response, 400 );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::create_item
+ */
+ public function test_create_item_with_url_src() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param(
+ 'font_face_settings',
+ wp_json_encode(
+ array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontWeight' => '200',
+ 'fontStyle' => 'normal',
+ 'src' => 'https://fonts.gstatic.com/s/open-sans/v30/KFOkCnqEu92Fr1MmgWxPKTM1K9nz.ttf',
+ )
+ )
+ );
+
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 201, $response->get_status(), 'The response status should be 201.' );
+ $this->check_font_face_data( $data, $data['id'], $response->get_links() );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::create_item
+ */
+ public function test_create_item_with_all_properties() {
+ wp_set_current_user( self::$admin_id );
+
+ $properties = array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontWeight' => '300 500',
+ 'fontStyle' => 'oblique 30deg 50deg',
+ 'fontDisplay' => 'swap',
+ 'fontStretch' => 'expanded',
+ 'ascentOverride' => '70%',
+ 'descentOverride' => '30%',
+ 'fontVariant' => 'normal',
+ 'fontFeatureSettings' => '"swsh" 2',
+ 'fontVariationSettings' => '"xhgt" 0.7',
+ 'lineGapOverride' => '10%',
+ 'sizeAdjust' => '90%',
+ 'unicodeRange' => 'U+0025-00FF, U+4??',
+ 'preview' => 'https://s.w.org/images/fonts/16.7/previews/open-sans/open-sans-400-normal.svg',
+ 'src' => 'https://fonts.gstatic.com/s/open-sans/v30/KFOkCnqEu92Fr1MmgWxPKTM1K9nz.ttf',
+ );
+
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param( 'font_face_settings', wp_json_encode( $properties ) );
+
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+ wp_delete_post( $data['id'], true );
+
+ $this->assertSame( 201, $response->get_status(), 'The response status should be 201.' );
+ $this->assertArrayHasKey( 'font_face_settings', $data, 'The font_face_settings property should exist in the response data.' );
+ $this->assertSame( $properties, $data['font_face_settings'], 'The font_face_settings should match the expected properties.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::create_item
+ */
+ public function test_create_item_missing_parent() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER . '/font-faces' );
+ $request->set_param(
+ 'font_face_settings',
+ wp_json_encode( array_merge( self::$default_settings, array( 'fontWeight' => '100' ) ) )
+ );
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_post_invalid_parent', $response, 404 );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::create_item
+ */
+ public function test_create_item_with_duplicate_properties() {
+ $settings = array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontWeight' => '200',
+ 'fontStyle' => 'italic',
+ 'src' => home_url( '/wp-content/fonts/open-sans-italic-light.ttf' ),
+ );
+ self::create_font_face_post( self::$font_family_id, $settings );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'font_face_settings', wp_json_encode( $settings ) );
+
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_duplicate_font_face', $response, 400, 'The response should return an error for "rest_duplicate_font_face" with 400 status.' );
+ $expected_message = 'A font face matching those settings already exists.';
+ $message = $response->as_error()->get_error_messages()[0];
+ $this->assertSame( $expected_message, $message, 'The response error message should match.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::validate_create_font_face_request
+ */
+ public function test_create_item_default_theme_json_version() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param(
+ 'font_face_settings',
+ wp_json_encode(
+ array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontWeight' => '200',
+ 'src' => 'https://fonts.gstatic.com/s/open-sans/v30/KFOkCnqEu92Fr1MmgWxPKTM1K9nz.ttf',
+ )
+ )
+ );
+
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+ wp_delete_post( $data['id'], true );
+
+ $this->assertSame( 201, $response->get_status(), 'The response status should be 201.' );
+ $this->assertArrayHasKey( 'theme_json_version', $data, 'The theme_json_version property should exist in the response data.' );
+ $this->assertSame( WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED, $data['theme_json_version'], 'The default theme.json version should match the latest version supported by the controller.' );
+ }
+
+ /**
+ * @dataProvider data_create_item_invalid_theme_json_version
+ *
+ * @covers WP_REST_Font_Faces_Controller::create_item
+ *
+ * @param int $theme_json_version Version input to test.
+ */
+ public function test_create_item_invalid_theme_json_version( $theme_json_version ) {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'theme_json_version', $theme_json_version );
+ $request->set_param( 'font_face_settings', '' );
+
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_create_item_invalid_theme_json_version() {
+ return array(
+ array( 1 ),
+ array( 3 ),
+ );
+ }
+
+ /**
+ * @dataProvider data_create_item_invalid_settings
+ *
+ * @covers WP_REST_Font_Faces_Controller::validate_create_font_face_settings
+ *
+ * @param mixed $settings Settings to test.
+ */
+ public function test_create_item_invalid_settings( $settings ) {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param( 'font_face_settings', wp_json_encode( $settings ) );
+
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_create_item_invalid_settings() {
+ return array(
+ 'Missing fontFamily' => array(
+ 'settings' => array_diff_key( self::$default_settings, array( 'fontFamily' => '' ) ),
+ ),
+ 'Empty fontFamily' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'fontFamily' => '' ) ),
+ ),
+ 'Wrong fontFamily type' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'fontFamily' => 1234 ) ),
+ ),
+ 'Invalid fontDisplay' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'fontDisplay' => 'invalid' ) ),
+ ),
+ 'Missing src' => array(
+ 'settings' => array_diff_key( self::$default_settings, array( 'src' => '' ) ),
+ ),
+ 'Empty src string' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'src' => '' ) ),
+ ),
+ 'Empty src array' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'src' => array() ) ),
+ ),
+ 'Empty src array values' => array(
+ 'settings' => array_merge( self::$default_settings, array( '', '' ) ),
+ ),
+ 'Wrong src type' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'src' => 1234 ) ),
+ ),
+ 'Wrong src array types' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'src' => array( 1234, 5678 ) ) ),
+ ),
+ );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::validate_create_font_face_settings
+ */
+ public function test_create_item_invalid_settings_json() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param( 'font_face_settings', 'invalid' );
+
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400, 'The response should return an error for "rest_invalid_param" with 400 status.' );
+ $expected_message = 'font_face_settings parameter must be a valid JSON string.';
+ $message = $response->as_error()->get_all_error_data()[0]['params']['font_face_settings'];
+ $this->assertSame( $expected_message, $message, 'The response error message should match.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::validate_create_font_face_settings
+ */
+ public function test_create_item_invalid_file_src() {
+ $files = $this->setup_font_file_upload( array( 'woff2' ) );
+
+ wp_set_current_user( self::$admin_id );
+ $src = 'invalid';
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param(
+ 'font_face_settings',
+ wp_json_encode(
+ array_merge( self::$default_settings, array( 'src' => $src ) )
+ )
+ );
+ $request->set_file_params( $files );
+
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400, 'The response should return an error for "rest_invalid_param" with 400 status.' );
+ $expected_message = 'font_face_settings[src] value "' . $src . '" must be a valid URL or file reference.';
+ $message = $response->as_error()->get_all_error_data()[0]['params']['font_face_settings'];
+ $this->assertSame( $expected_message, $message, 'The response error message should match.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::validate_create_font_face_settings
+ */
+ public function test_create_item_missing_file_src() {
+ $files = $this->setup_font_file_upload( array( 'woff2', 'woff' ) );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param(
+ 'font_face_settings',
+ wp_json_encode(
+ array_merge( self::$default_settings, array( 'src' => array( array_keys( $files )[0] ) ) )
+ )
+ );
+ $request->set_file_params( $files );
+
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400, 'The response should return an error for "rest_invalid_param" with 400 status.' );
+ $expected_message = 'File ' . array_keys( $files )[1] . ' must be used in font_face_settings[src].';
+ $message = $response->as_error()->get_all_error_data()[0]['params']['font_face_settings'];
+ $this->assertSame( $expected_message, $message, 'The response error message should match.' );
+ }
+
+ /**
+ * @dataProvider data_sanitize_font_face_settings
+ *
+ * @covers WP_REST_Font_Face_Controller::sanitize_font_face_settings
+ *
+ * @param string $settings Settings to test.
+ * @param string $expected Expected settings result.
+ */
+ public function test_create_item_sanitize_font_face_settings( $settings, $expected ) {
+ $settings = array_merge( self::$default_settings, $settings );
+ $expected = array_merge( self::$default_settings, $expected );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $request->set_param( 'font_face_settings', wp_json_encode( $settings ) );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+ wp_delete_post( $data['id'], true );
+
+ $this->assertSame( 201, $response->get_status(), 'The response status should be 201.' );
+ $this->assertSame( $expected, $data['font_face_settings'], 'The response font_face_settings should match.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_sanitize_font_face_settings() {
+ return array(
+ 'settings with tags, extra whitespace, new lines' => array(
+ 'settings' => array(
+ 'fontFamily' => " Open Sans\n ",
+ 'fontStyle' => " oblique 20deg 50deg\n ",
+ 'fontWeight' => " 200\n ",
+ 'src' => " https://example.com/ ",
+ 'fontStretch' => " expanded\n ",
+ 'ascentOverride' => " 70%\n ",
+ 'descentOverride' => " 30%\n ",
+ 'fontVariant' => " normal\n ",
+ 'fontFeatureSettings' => " \"swsh\" 2\n ",
+ 'fontVariationSettings' => " \"xhgt\" 0.7\n ",
+ 'lineGapOverride' => " 10%\n ",
+ 'sizeAdjust' => " 90%\n ",
+ 'unicodeRange' => " U+0025-00FF, U+4??\n ",
+ 'preview' => " https://example.com/ ",
+ ),
+ 'expected' => array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontStyle' => 'oblique 20deg 50deg',
+ 'fontWeight' => '200',
+ 'src' => 'https://example.com//stylescriptalert(\'XSS\');/script%20%20%20%20%20%20',
+ 'fontStretch' => 'expanded',
+ 'ascentOverride' => '70%',
+ 'descentOverride' => '30%',
+ 'fontVariant' => 'normal',
+ 'fontFeatureSettings' => '"swsh" 2',
+ 'fontVariationSettings' => '"xhgt" 0.7',
+ 'lineGapOverride' => '10%',
+ 'sizeAdjust' => '90%',
+ 'unicodeRange' => 'U+0025-00FF, U+4??',
+ 'preview' => 'https://example.com//stylescriptalert(\'XSS\');/script%20%20%20%20%20%20',
+ ),
+ ),
+ 'multiword font family name with integer' => array(
+ 'settings' => array(
+ 'fontFamily' => 'Libre Barcode 128 Text',
+ ),
+ 'expected' => array(
+ 'fontFamily' => '"Libre Barcode 128 Text"',
+ ),
+ ),
+ 'multiword font family name' => array(
+ 'settings' => array(
+ 'fontFamily' => 'B612 Mono',
+ ),
+ 'expected' => array(
+ 'fontFamily' => '"B612 Mono"',
+ ),
+ ),
+ 'comma-separated font family names' => array(
+ 'settings' => array(
+ 'fontFamily' => 'Open Sans, Noto Sans, sans-serif',
+ ),
+ 'expected' => array(
+ 'fontFamily' => '"Open Sans", "Noto Sans", sans-serif',
+ ),
+ ),
+ );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::create_item
+ */
+ // public function test_create_item_no_permission() {}
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::update_item
+ */
+ public function test_update_item() {
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . self::$font_face_id1 );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_no_route', $response, 404 );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::delete_item
+ */
+ public function test_delete_item() {
+ wp_set_current_user( self::$admin_id );
+ $font_face_id = self::create_font_face_post( self::$font_family_id );
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . $font_face_id );
+ $request->set_param( 'force', true );
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 201.' );
+ $this->assertNull( get_post( $font_face_id ), 'The deleted post should not exist.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::delete_item
+ */
+ public function test_delete_item_no_trash() {
+ wp_set_current_user( self::$admin_id );
+ $font_face_id = self::create_font_face_post( self::$font_family_id );
+
+ // Attempt trashing.
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . $font_face_id );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501, 'The response should return an error for "rest_trash_not_supported" with 501 status.' );
+
+ $request->set_param( 'force', 'false' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501, 'When "force" is false, the response should return an error for "rest_trash_not_supported" with 501 status.' );
+
+ // Ensure the post still exists.
+ $post = get_post( $font_face_id );
+ $this->assertNotEmpty( $post, 'The post should still exists.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::delete_item
+ */
+ public function test_delete_item_invalid_font_face_id() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER );
+ $request->set_param( 'force', true );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_post_invalid_id', $response, 404 );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::delete
+ */
+ public function test_delete_item_missing_parent() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER . '/font-faces/' . self::$font_face_id1 );
+ $request->set_param( 'force', true );
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_post_invalid_parent', $response, 404 );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_item
+ */
+ public function test_delete_item_invalid_parent_id() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . self::$other_font_family_id . '/font-faces/' . self::$font_face_id1 );
+ $request->set_param( 'force', true );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_font_face_parent_id_mismatch', $response, 404, 'The response should return an error for "rest_font_face_parent_id_mismatch" with 404 status.' );
+
+ $expected_message = 'The font face does not belong to the specified font family with id of "' . self::$other_font_family_id . '".';
+ $this->assertSame( $expected_message, $response->as_error()->get_error_messages()[0], 'The message must contain the correct parent ID.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::delete_item
+ */
+ public function test_delete_item_no_permissions() {
+ $font_face_id = $this->create_font_face_post( self::$font_family_id );
+
+ wp_set_current_user( 0 );
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . $font_face_id );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_delete', $response, 401, 'The response should return an error for "rest_cannot_delete" with 401 status for an invalid user.' );
+
+ wp_set_current_user( self::$editor_id );
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . $font_face_id );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_delete', $response, 403, 'The response should return an error for "rest_cannot_delete" with 403 status for a user without permission.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::prepare_item_for_response
+ */
+ public function test_prepare_item() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces/' . self::$font_face_id2 );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->check_font_face_data( $data, self::$font_face_id2, $response->get_links() );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_item_schema
+ */
+ public function test_get_item_schema() {
+ $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/font-families/' . self::$font_family_id . '/font-faces' );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $properties = $data['schema']['properties'];
+ $this->assertCount( 4, $properties, 'There should be 4 properties in the schema::properties data.' );
+ $this->assertArrayHasKey( 'id', $properties, 'The id property should exist in the schema::properties data.' );
+ $this->assertArrayHasKey( 'theme_json_version', $properties, 'The theme_json_version property should exist in the schema::properties data.' );
+ $this->assertArrayHasKey( 'parent', $properties, 'The parent property should exist in the schema::properties data.' );
+ $this->assertArrayHasKey( 'font_face_settings', $properties, 'The font_face_settings property should exist in the schema::properties data.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_item_schema
+ */
+ public function test_get_item_schema_font_face_settings_should_all_have_sanitize_callbacks() {
+ $schema = ( new WP_REST_Font_Faces_Controller( 'wp_font_face' ) )->get_item_schema();
+ $font_face_settings_schema = $schema['properties']['font_face_settings'];
+
+ $this->assertArrayHasKey( 'properties', $font_face_settings_schema, 'font_face_settings schema is missing properties.' );
+ $this->assertIsArray( $font_face_settings_schema['properties'], 'font_face_settings properties should be an array.' );
+
+ // arg_options should be removed for each setting property.
+ foreach ( $font_face_settings_schema['properties'] as $property ) {
+ $this->assertArrayHasKey( 'arg_options', $property, 'Setting schema should have arg_options.' );
+ $this->assertArrayHasKey( 'sanitize_callback', $property['arg_options'], 'Setting schema should have a sanitize_callback.' );
+ $this->assertIsCallable( $property['arg_options']['sanitize_callback'], 'The sanitize_callback value should be callable.' );
+ }
+ }
+
+ /**
+ * @covers WP_REST_Font_Faces_Controller::get_public_item_schema
+ */
+ public function test_get_public_item_schema_should_not_have_arg_options() {
+ $schema = ( new WP_REST_Font_Faces_Controller( 'wp_font_face' ) )->get_public_item_schema();
+ $font_face_settings_schema = $schema['properties']['font_face_settings'];
+
+ $this->assertArrayHasKey( 'properties', $font_face_settings_schema, 'font_face_settings schema is missing properties.' );
+ $this->assertIsArray( $font_face_settings_schema['properties'], 'font_face_settings properties should be an array.' );
+
+ // arg_options should be removed for each setting property.
+ foreach ( $font_face_settings_schema['properties'] as $property ) {
+ $this->assertArrayNotHasKey( 'arg_options', $property, 'arg_options should be removed from the schema for each setting.' );
+ }
+ }
+
+ /**
+ * If WP_Theme_JSON::LATEST_SCHEMA is changed, the controller should be updated to handle any differences
+ * in `fontFace` structure to ensure support for the latest theme.json schema, and backwards compatibility
+ * for existing wp_font_face posts.
+ */
+ public function test_controller_supports_latest_theme_json_version() {
+ $this->assertSame( WP_Theme_JSON::LATEST_SCHEMA, WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ }
+
+ protected function check_font_face_data( $data, $post_id, $links ) {
+ self::$post_ids_for_cleanup[] = $post_id;
+ $post = get_post( $post_id );
+
+ $this->assertArrayHasKey( 'id', $data, 'The id property should exist in response data.' );
+ $this->assertSame( $post->ID, $data['id'], 'The "id" from the response data should match the post ID.' );
+
+ $this->assertArrayHasKey( 'parent', $data, 'The parent property should exist in response data.' );
+ $this->assertSame( $post->post_parent, $data['parent'], 'The "parent" from the response data should match the post parent.' );
+
+ $this->assertArrayHasKey( 'theme_json_version', $data, 'The theme_json_version property should exist in response data.' );
+ $this->assertSame( WP_REST_Font_Faces_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED, $data['theme_json_version'], 'The "theme_json_version" from the response data should match the latest version supported by the controller.' );
+
+ $this->assertArrayHasKey( 'font_face_settings', $data, 'The font_face_settings property should exist in response data.' );
+ $this->assertSame( $post->post_content, wp_json_encode( $data['font_face_settings'] ), 'The encoded "font_face_settings" from the response data should match the post content.' );
+
+ $this->assertNotEmpty( $links, 'The links should not be empty in the response data.' );
+ $expected = rest_url( 'wp/v2/font-families/' . $post->post_parent . '/font-faces/' . $post->ID );
+ $this->assertSame( $expected, $links['self'][0]['href'], 'The links URL from the response data should match the post\'s REST endpoint.' );
+ $expected = rest_url( 'wp/v2/font-families/' . $post->post_parent . '/font-faces' );
+ $this->assertSame( $expected, $links['collection'][0]['href'], 'The links collection URL from the response data should match the REST endpoint.' );
+ $expected = rest_url( 'wp/v2/font-families/' . $post->post_parent );
+ $this->assertSame( $expected, $links['parent'][0]['href'], 'The links for a parent URL from the response data should match the parent\'s REST endpoint.' );
+ }
+
+ protected function check_file_meta( $font_face_id, $src_attributes ) {
+ $file_meta = get_post_meta( $font_face_id, '_wp_font_face_file' );
+
+ foreach ( $src_attributes as $src_attribute ) {
+ $file_name = basename( $src_attribute );
+ $this->assertContains( $file_name, $file_meta, 'The uploaded font file path should be saved in the post meta.' );
+ }
+ }
+
+ protected function setup_font_file_upload( $formats ) {
+ $files = array();
+ foreach ( $formats as $format ) {
+ $font_file = DIR_TESTDATA . '/fonts/OpenSans-Regular.' . $format;
+ $font_path = wp_tempnam( 'OpenSans-Regular.' . $format );
+ copy( $font_file, $font_path );
+
+ $files[ 'file-' . count( $files ) ] = array(
+ 'name' => 'OpenSans-Regular.' . $format,
+ 'full_path' => 'OpenSans-Regular.' . $format,
+ 'type' => 'font/' . $format,
+ 'tmp_name' => $font_path,
+ 'error' => 0,
+ 'size' => filesize( $font_path ),
+ );
+ }
+
+ return $files;
+ }
+}
diff --git a/tests/phpunit/tests/fonts/font-library/wpRestFontFamiliesController.php b/tests/phpunit/tests/fonts/font-library/wpRestFontFamiliesController.php
new file mode 100644
index 0000000000000..0676c3ce4b88d
--- /dev/null
+++ b/tests/phpunit/tests/fonts/font-library/wpRestFontFamiliesController.php
@@ -0,0 +1,1057 @@
+ 'Open Sans',
+ 'slug' => 'open-sans',
+ 'fontFamily' => '"Open Sans", sans-serif',
+ 'preview' => 'https://s.w.org/images/fonts/16.7/previews/open-sans/open-sans-400-normal.svg',
+ );
+
+ public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+ self::$admin_id = $factory->user->create(
+ array(
+ 'role' => 'administrator',
+ )
+ );
+ self::$editor_id = $factory->user->create(
+ array(
+ 'role' => 'editor',
+ )
+ );
+
+ self::$font_family_id1 = self::create_font_family_post(
+ array(
+ 'name' => 'Open Sans',
+ 'slug' => 'open-sans',
+ 'fontFamily' => '"Open Sans", sans-serif',
+ 'preview' => 'https://s.w.org/images/fonts/16.7/previews/open-sans/open-sans-400-normal.svg',
+ )
+ );
+ self::$font_family_id2 = self::create_font_family_post(
+ array(
+ 'name' => 'Helvetica',
+ 'slug' => 'helvetica',
+ 'fontFamily' => 'Helvetica, Arial, sans-serif',
+ )
+ );
+ self::$font_face_id1 = Tests_REST_WpRestFontFacesController::create_font_face_post(
+ self::$font_family_id1,
+ array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontWeight' => '400',
+ 'fontStyle' => 'normal',
+ 'src' => home_url( '/wp-content/fonts/open-sans-medium.ttf' ),
+ )
+ );
+ self::$font_face_id2 = Tests_REST_WpRestFontFacesController::create_font_face_post(
+ self::$font_family_id1,
+ array(
+ 'fontFamily' => '"Open Sans"',
+ 'fontWeight' => '900',
+ 'fontStyle' => 'normal',
+ 'src' => home_url( '/wp-content/fonts/open-sans-bold.ttf' ),
+ )
+ );
+
+ static::$post_ids_to_cleanup = array();
+ }
+
+ public static function wpTearDownAfterClass() {
+ self::delete_user( self::$admin_id );
+ self::delete_user( self::$editor_id );
+
+ wp_delete_post( self::$font_family_id1 );
+ wp_delete_post( self::$font_family_id2 );
+ wp_delete_post( self::$font_face_id1 );
+ wp_delete_post( self::$font_face_id2 );
+ }
+
+ public function tear_down() {
+ foreach ( static::$post_ids_to_cleanup as $post_id ) {
+ wp_delete_post( $post_id, true );
+ }
+ static::$post_ids_to_cleanup = array();
+
+ parent::tear_down();
+ }
+
+ public static function create_font_family_post( $settings = array() ) {
+ $settings = array_merge( self::$default_settings, $settings );
+ $post_id = self::factory()->post->create(
+ wp_slash(
+ array(
+ 'post_type' => 'wp_font_family',
+ 'post_status' => 'publish',
+ 'post_title' => $settings['name'],
+ 'post_name' => $settings['slug'],
+ 'post_content' => wp_json_encode(
+ array(
+ 'fontFamily' => $settings['fontFamily'],
+ 'preview' => $settings['preview'],
+ )
+ ),
+ )
+ )
+ );
+
+ static::$post_ids_to_cleanup[] = $post_id;
+
+ return $post_id;
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::register_routes
+ */
+ public function test_register_routes() {
+ $routes = rest_get_server()->get_routes();
+ $this->assertArrayHasKey(
+ '/wp/v2/font-families',
+ $routes,
+ 'Font faces collection for the given font family does not exist'
+ );
+ $this->assertCount(
+ 2,
+ $routes['/wp/v2/font-families'],
+ 'Font faces collection for the given font family does not have exactly two elements'
+ );
+ $this->assertArrayHasKey(
+ '/wp/v2/font-families/(?P[\d]+)',
+ $routes,
+ 'Single font face route for the given font family does not exist'
+ );
+ $this->assertCount(
+ 3,
+ $routes['/wp/v2/font-families/(?P[\d]+)'],
+ 'Font faces collection for the given font family does not have exactly two elements'
+ );
+ }
+
+ public function test_font_families_no_autosave_routes() {
+ $routes = rest_get_server()->get_routes();
+ $this->assertArrayNotHasKey(
+ '/wp/v2/font-families/(?P[\d]+)/autosaves',
+ $routes,
+ 'Font families autosaves route exists.'
+ );
+ $this->assertArrayNotHasKey(
+ '/wp/v2/font-families/(?P[\d]+)/autosaves/(?P[\d]+)',
+ $routes,
+ 'Font families autosaves by id route exists.'
+ );
+ }
+
+ /**
+ * @doesNotPerformAssertions
+ */
+ public function test_context_param() {
+ // See test_get_context_param().
+ }
+
+ /**
+ * @dataProvider data_get_context_param
+ *
+ * @covers WP_REST_Font_Families_Controller::get_context_param
+ *
+ * @param bool $single_route Whether to test a single route.
+ */
+ public function test_get_context_param( $single_route ) {
+ $route = '/wp/v2/font-families';
+ if ( $single_route ) {
+ $route .= '/' . self::$font_family_id1;
+ }
+
+ $request = new WP_REST_Request( 'OPTIONS', $route );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $endpoint_data = $data['endpoints'][0];
+ $this->assertArrayNotHasKey( 'allow_batch', $endpoint_data, 'The allow_batch property should not exist in the endpoint data.' );
+ $this->assertSame( 'view', $endpoint_data['args']['context']['default'], 'The endpoint\'s args::context::default should be set to view.' );
+ $this->assertSame( array( 'view', 'embed', 'edit' ), $endpoint_data['args']['context']['enum'], 'The endpoint\'s args::context::enum should be set to [ view, embed, edit ].' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_get_context_param() {
+ return array(
+ 'Collection' => array( false ),
+ 'Single' => array( true ),
+ );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::get_items
+ */
+ public function test_get_items() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families' );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->assertCount( 2, $data, 'There should be 2 properties in the response data.' );
+ $this->assertArrayHasKey( '_links', $data[0], 'The _links property should exist in the response data 0.' );
+ $this->check_font_family_data( $data[0], self::$font_family_id2, $data[0]['_links'] );
+ $this->assertArrayHasKey( '_links', $data[1], 'The _links property should exist in the response data 1.' );
+ $this->check_font_family_data( $data[1], self::$font_family_id1, $data[1]['_links'] );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::get_items
+ */
+ public function test_get_items_by_slug() {
+ $font_family = get_post( self::$font_family_id2 );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families' );
+ $request->set_param( 'slug', $font_family->post_name );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->assertCount( 1, $data, 'There should be 2 properties in the response data.' );
+ $this->assertArrayHasKey( 'id', $data[0], 'The id property should exist in the response data.' );
+ $this->assertSame( $font_family->ID, $data[0]['id'], 'The id should match the expected ID in the response data.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::get_items
+ */
+ public function test_get_items_no_permission() {
+ wp_set_current_user( 0 );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_read', $response, 401, 'The response should return an error with a "rest_cannot_read" code and 401 status.' );
+
+ wp_set_current_user( self::$editor_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_read', $response, 403, 'The response should return an error with a "rest_cannot_read" code and 403 status.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::get_item
+ */
+ public function test_get_item() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id1 );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->check_font_family_data( $data, self::$font_family_id1, $response->get_links() );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::prepare_item_for_response
+ */
+ public function test_get_item_embedded_font_faces() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id1 );
+ $request->set_param( '_embed', true );
+ $response = rest_get_server()->dispatch( $request );
+ $data = rest_get_server()->response_to_data( $response, true );
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->assertArrayHasKey( '_embedded', $data, 'The _embedded property should exist in the response data.' );
+ $this->assertArrayHasKey( 'font_faces', $data['_embedded'], 'The font_faces property should exist in _embedded data.' );
+ $this->assertCount( 2, $data['_embedded']['font_faces'], 'There should be 2 font_faces in the _embedded data.' );
+
+ foreach ( $data['_embedded']['font_faces'] as $font_face ) {
+ $this->assertArrayHasKey( 'id', $font_face, 'The id property should exist in the _embedded font_face data.' );
+
+ $font_face_request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id1 . '/font-faces/' . $font_face['id'] );
+ $font_face_response = rest_get_server()->dispatch( $font_face_request );
+ $font_face_data = rest_get_server()->response_to_data( $font_face_response, true );
+
+ $this->assertSame( $font_face_data, $font_face, 'The embedded font_face data should match when the data from a single request.' );
+ }
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::get_item
+ */
+ public function test_get_item_removes_extra_settings() {
+ $font_family_id = self::create_font_family_post( array( 'fontFace' => array() ) );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . $font_family_id );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->assertArrayNotHasKey( 'fontFace', $data['font_family_settings'], 'The fontFace property should not exist in the font_family_settings data.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::prepare_item_for_response
+ */
+ public function test_get_item_malformed_post_content_returns_empty_settings() {
+ $font_family_id = wp_insert_post(
+ array(
+ 'post_type' => 'wp_font_family',
+ 'post_status' => 'publish',
+ 'post_content' => 'invalid',
+ )
+ );
+
+ static::$post_ids_to_cleanup[] = $font_family_id;
+
+ $empty_settings = array(
+ 'name' => '',
+ // Slug will default to the post id.
+ 'slug' => (string) $font_family_id,
+ 'fontFamily' => '',
+ 'preview' => '',
+ );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . $font_family_id );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->assertSame( $empty_settings, $data['font_family_settings'], 'The empty settings should exist in the font_family_settings data.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::get_item
+ */
+ public function test_get_item_invalid_font_family_id() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_post_invalid_id', $response, 404 );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::get_item
+ */
+ public function test_get_item_no_permission() {
+ wp_set_current_user( 0 );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id1 );
+
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_read', $response, 401, 'The response should return an error with a "rest_cannot_read" code and 401 status.' );
+
+ wp_set_current_user( self::$editor_id );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_read', $response, 403, 'The response should return an error with a "rest_cannot_read" code and 403 status.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::create_item
+ */
+ public function test_create_item() {
+ $settings = array_merge( self::$default_settings, array( 'slug' => 'open-sans-2' ) );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Families_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param( 'font_family_settings', wp_json_encode( $settings ) );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 201, $response->get_status(), 'The response status should be 201.' );
+ $this->check_font_family_data( $data, $data['id'], $response->get_links() );
+
+ $reponse_settings = $data['font_family_settings'];
+ $this->assertSame( $settings, $reponse_settings, 'The expected settings should exist in the font_family_settings data.' );
+ $this->assertEmpty( $data['font_faces'], 'The font_faces should be empty or not exist in the response data.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::validate_create_font_face_request
+ */
+ public function test_create_item_default_theme_json_version() {
+ $settings = array_merge( self::$default_settings, array( 'slug' => 'open-sans-2' ) );
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families' );
+ $request->set_param( 'font_family_settings', wp_json_encode( $settings ) );
+
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ static::$post_ids_to_cleanup[] = $data['id'];
+
+ $this->assertSame( 201, $response->get_status(), 'The response status should be 201.' );
+ $this->assertArrayHasKey( 'theme_json_version', $data, 'The theme_json_version property should exist in the response data.' );
+ $this->assertSame( WP_REST_Font_Families_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED, $data['theme_json_version'], 'The default theme.json version should match the latest version supported by the controller.' );
+ }
+
+ /**
+ * @dataProvider data_create_item_invalid_theme_json_version
+ *
+ * @covers WP_REST_Font_Families_Controller::create_item
+ *
+ * @param int $theme_json_version Version to test.
+ */
+ public function test_create_item_invalid_theme_json_version( $theme_json_version ) {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families' );
+ $request->set_param( 'theme_json_version', $theme_json_version );
+ $request->set_param( 'font_family_settings', wp_json_encode( self::$default_settings ) );
+
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_create_item_invalid_theme_json_version() {
+ return array(
+ array( 1 ),
+ array( 3 ),
+ );
+ }
+
+ /**
+ * @dataProvider data_create_item_with_default_preview
+ *
+ * @covers WP_REST_Font_Families_Controller::sanitize_font_family_settings
+ *
+ * @param array $settings Settings to test.
+ */
+ public function test_create_item_with_default_preview( $settings ) {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Families_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param( 'font_family_settings', wp_json_encode( $settings ) );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ static::$post_ids_to_cleanup[] = $data['id'];
+
+ $this->assertSame( 201, $response->get_status(), 'The response status should be 201.' );
+ $response_settings = $data['font_family_settings'];
+ $this->assertArrayHasKey( 'preview', $response_settings, 'The preview property should exist in the font_family_settings data.' );
+ $this->assertSame( '', $response_settings['preview'], 'The preview data should be an empty string.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_create_item_with_default_preview() {
+ $default_settings = array(
+ 'name' => 'Open Sans',
+ 'slug' => 'open-sans-2',
+ 'fontFamily' => '"Open Sans", sans-serif',
+ );
+ return array(
+ 'No preview param' => array(
+ 'settings' => $default_settings,
+ ),
+ 'Empty preview' => array(
+ 'settings' => array_merge( $default_settings, array( 'preview' => '' ) ),
+ ),
+ );
+ }
+
+ /**
+ * @dataProvider data_sanitize_font_family_settings
+ *
+ * @covers WP_REST_Font_Families_Controller::sanitize_font_family_settings
+ *
+ * @param string $settings Font family settings to test.
+ * @param string $expected Expected settings result.
+ */
+ public function test_create_item_santize_font_family_settings( $settings, $expected ) {
+ $settings = array_merge( self::$default_settings, $settings );
+ $expected = array_merge( self::$default_settings, $expected );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families' );
+ $request->set_param( 'font_family_settings', wp_json_encode( $settings ) );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ static::$post_ids_to_cleanup[] = $data['id'];
+
+ $this->assertSame( 201, $response->get_status(), 'The response status should be 201.' );
+ $this->assertSame( $expected, $data['font_family_settings'], 'The response font_family_settings should match.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_sanitize_font_family_settings() {
+ return array(
+ 'settings with tags, extra whitespace, new lines' => array(
+ 'settings' => array(
+ 'name' => " Opening Sans\n ",
+ 'slug' => " OPENing SanS \n ",
+ 'fontFamily' => " Opening Sans\n ",
+ 'preview' => " https://example.com/ ",
+ ),
+ 'expected' => array(
+ 'name' => 'Opening Sans',
+ 'slug' => 'opening-sans-alertxss',
+ 'fontFamily' => '"Opening Sans"',
+ 'preview' => "https://example.com//stylescriptalert('XSS');/script%20%20%20%20%20%20",
+ ),
+ ),
+ 'multiword font family name with integer' => array(
+ 'settings' => array(
+ 'slug' => 'libre-barcode-128-text',
+ 'fontFamily' => 'Libre Barcode 128 Text',
+ ),
+ 'expected' => array(
+ 'slug' => 'libre-barcode-128-text',
+ 'fontFamily' => '"Libre Barcode 128 Text"',
+ ),
+ ),
+ 'multiword font family name' => array(
+ 'settings' => array(
+ 'slug' => 'b612-mono',
+ 'fontFamily' => 'B612 Mono',
+ ),
+ 'expected' => array(
+ 'slug' => 'b612-mono',
+ 'fontFamily' => '"B612 Mono"',
+ ),
+ ),
+ 'comma-separated font family names' => array(
+ 'settings' => array(
+ 'slug' => 'open-sans-noto-sans',
+ 'fontFamily' => 'Open Sans, Noto Sans, sans-serif',
+ ),
+ 'expected' => array(
+ 'slug' => 'open-sans-noto-sans',
+ 'fontFamily' => '"Open Sans", "Noto Sans", sans-serif',
+ ),
+ ),
+ );
+ }
+
+ /**
+ * @dataProvider data_create_item_invalid_settings
+ *
+ * @covers WP_REST_Font_Families_Controller::validate_create_font_face_settings
+ *
+ * @param array $settings Settings to test.
+ */
+ public function test_create_item_invalid_settings( $settings ) {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Families_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param( 'font_family_settings', wp_json_encode( $settings ) );
+
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_create_item_invalid_settings() {
+ return array(
+ 'Missing name' => array(
+ 'settings' => array_diff_key( self::$default_settings, array( 'name' => '' ) ),
+ ),
+ 'Empty name' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'name' => '' ) ),
+ ),
+ 'Wrong name type' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'name' => 1234 ) ),
+ ),
+ 'Missing slug' => array(
+ 'settings' => array_diff_key( self::$default_settings, array( 'slug' => '' ) ),
+ ),
+ 'Empty slug' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'slug' => '' ) ),
+ ),
+ 'Wrong slug type' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'slug' => 1234 ) ),
+ ),
+ 'Missing fontFamily' => array(
+ 'settings' => array_diff_key( self::$default_settings, array( 'fontFamily' => '' ) ),
+ ),
+ 'Empty fontFamily' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'fontFamily' => '' ) ),
+ ),
+ 'Wrong fontFamily type' => array(
+ 'settings' => array_merge( self::$default_settings, array( 'fontFamily' => 1234 ) ),
+ ),
+ );
+ }
+
+ /**
+ * @covers WP_REST_Font_Family_Controller::validate_font_family_settings
+ */
+ public function test_create_item_invalid_settings_json() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Families_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param( 'font_family_settings', 'invalid' );
+
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400, 'The response should return an error for "rest_invalid_param" with 400 status.' );
+ $expected_message = 'font_family_settings parameter must be a valid JSON string.';
+ $message = $response->as_error()->get_all_error_data()[0]['params']['font_family_settings'];
+ $this->assertSame( $expected_message, $message, 'The response error message should match.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Family_Controller::create_item
+ */
+ public function test_create_item_with_duplicate_slug() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families' );
+ $request->set_param( 'theme_json_version', WP_REST_Font_Families_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ $request->set_param( 'font_family_settings', wp_json_encode( array_merge( self::$default_settings, array( 'slug' => 'helvetica' ) ) ) );
+
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_duplicate_font_family', $response, 400, 'The response should return an error for "rest_duplicate_font_family" with 400 status.' );
+ $expected_message = 'A font family with slug "helvetica" already exists.';
+ $message = $response->as_error()->get_error_messages()[0];
+ $this->assertSame( $expected_message, $message, 'The response error message should match.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::create_item
+ */
+ public function test_create_item_no_permission() {
+ $settings = array_merge( self::$default_settings, array( 'slug' => 'open-sans-2' ) );
+ wp_set_current_user( 0 );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families' );
+ $request->set_param( 'font_family_settings', wp_json_encode( $settings ) );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_create', $response, 401, 'The response should return an error for "rest_cannot_create" with 401 status.' );
+
+ wp_set_current_user( self::$editor_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families' );
+ $request->set_param(
+ 'font_family_settings',
+ wp_json_encode(
+ array(
+ 'name' => 'Open Sans',
+ 'slug' => 'open-sans',
+ 'fontFamily' => '"Open Sans", sans-serif',
+ 'preview' => 'https://s.w.org/images/fonts/16.7/previews/open-sans/open-sans-400-normal.svg',
+ )
+ )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_create', $response, 403, 'The response should return an error for "rest_cannot_create" with 403 status.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::update_item
+ */
+ public function test_update_item() {
+ wp_set_current_user( self::$admin_id );
+
+ $settings = array(
+ 'name' => 'Open Sans',
+ 'fontFamily' => '"Open Sans, "Noto Sans", sans-serif',
+ 'preview' => 'https://s.w.org/images/fonts/16.9/previews/open-sans/open-sans-400-normal.svg',
+ );
+
+ $font_family_id = self::create_font_family_post( array( 'slug' => 'open-sans-2' ) );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . $font_family_id );
+ $request->set_param(
+ 'font_family_settings',
+ wp_json_encode( $settings )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->check_font_family_data( $data, $font_family_id, $response->get_links() );
+
+ $expected_settings = array(
+ 'name' => $settings['name'],
+ 'slug' => 'open-sans-2',
+ 'fontFamily' => $settings['fontFamily'],
+ 'preview' => $settings['preview'],
+ );
+ $this->assertSame( $expected_settings, $data['font_family_settings'], 'The response font_family_settings should match expected settings.' );
+ }
+
+ /**
+ * @dataProvider data_update_item_individual_settings
+ *
+ * @covers WP_REST_Font_Families_Controller::update_item
+ *
+ * @param array $settings Settings to test.
+ */
+ public function test_update_item_individual_settings( $settings ) {
+ wp_set_current_user( self::$admin_id );
+
+ $font_family_id = self::create_font_family_post();
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . $font_family_id );
+ $request->set_param( 'font_family_settings', wp_json_encode( $settings ) );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $key = key( $settings );
+ $value = current( $settings );
+ $this->assertArrayHasKey( $key, $data['font_family_settings'], 'The expected key should exist in the font_family_settings data.' );
+ $this->assertSame( $value, $data['font_family_settings'][ $key ], 'The font_family_settings data should match.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_update_item_individual_settings() {
+ return array(
+ array( array( 'name' => 'Opened Sans' ) ),
+ array( array( 'fontFamily' => '"Opened Sans", sans-serif' ) ),
+ array( array( 'preview' => 'https://s.w.org/images/fonts/16.7/previews/opened-sans/opened-sans-400-normal.svg' ) ),
+ // Empty preview is allowed.
+ array( array( 'preview' => '' ) ),
+ );
+ }
+
+ /**
+ * @dataProvider data_sanitize_font_family_settings
+ *
+ * @covers WP_REST_Font_Families_Controller::sanitize_font_family_settings
+ *
+ * @param string $settings Font family settings to test.
+ * @param string $expected Expected settings result.
+ */
+ public function test_update_item_santize_font_family_settings( $settings, $expected ) {
+ // Unset/modify slug from the data provider, since we're updating rather than creating.
+ unset( $settings['slug'] );
+ $initial_settings = array( 'slug' => 'open-sans-update' );
+ $expected = array_merge( self::$default_settings, $expected, $initial_settings );
+
+ wp_set_current_user( self::$admin_id );
+ $font_family_id = self::create_font_family_post( $initial_settings );
+ static::$post_ids_to_cleanup[] = $font_family_id;
+
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . $font_family_id );
+ $request->set_param( 'font_family_settings', wp_json_encode( $settings ) );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->assertSame( $expected, $data['font_family_settings'], 'The response font_family_settings should match.' );
+ }
+
+ /**
+ * @dataProvider data_update_item_invalid_settings
+ *
+ * @covers WP_REST_Font_Families_Controller::update_item
+ *
+ * @param array $settings Settings to test.
+ */
+ public function test_update_item_empty_settings( $settings ) {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id1 );
+ $request->set_param(
+ 'font_family_settings',
+ wp_json_encode( $settings )
+ );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_update_item_invalid_settings() {
+ return array(
+ 'Empty name' => array(
+ array( 'name' => '' ),
+ ),
+ 'Wrong name type' => array(
+ array( 'name' => 1234 ),
+ ),
+ 'Empty fontFamily' => array(
+ array( 'fontFamily' => '' ),
+ ),
+ 'Wrong fontFamily type' => array(
+ array( 'fontFamily' => 1234 ),
+ ),
+ );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::update_item
+ */
+ public function test_update_item_update_slug_not_allowed() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id1 );
+ $request->set_param(
+ 'font_family_settings',
+ wp_json_encode( array( 'slug' => 'new-slug' ) )
+ );
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400, 'The response should return an error for "rest_invalid_param" with 400 status.' );
+ $expected_message = 'font_family_settings[slug] cannot be updated.';
+ $message = $response->as_error()->get_all_error_data()[0]['params']['font_family_settings'];
+ $this->assertSame( $expected_message, $message, 'The response error message should match.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::update_item
+ */
+ public function test_update_item_invalid_font_family_id() {
+ $settings = array_diff_key( self::$default_settings, array( 'slug' => '' ) );
+
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER );
+ $request->set_param( 'font_family_settings', wp_json_encode( $settings ) );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_post_invalid_id', $response, 404, 'The response should return an error for "rest_post_invalid_id" with 404 status.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::update_item
+ */
+ public function test_update_item_no_permission() {
+ $settings = array_diff_key( self::$default_settings, array( 'slug' => '' ) );
+
+ wp_set_current_user( 0 );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id1 );
+ $request->set_param( 'font_family_settings', wp_json_encode( $settings ) );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_edit', $response, 401, 'The response should return an error for "rest_cannot_edit" with 401 status for an invalid user.' );
+
+ wp_set_current_user( self::$editor_id );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . self::$font_family_id1 );
+ $request->set_param( 'font_family_settings', wp_json_encode( $settings ) );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_edit', $response, 403, 'The response should return an error for "rest_cannot_edit" with 403 status for a user without permission.' );
+ }
+
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::delete_item
+ */
+ public function test_delete_item() {
+ wp_set_current_user( self::$admin_id );
+ $font_family_id = self::create_font_family_post();
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . $font_family_id );
+ $request['force'] = true;
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->assertNull( get_post( $font_family_id ), 'The post should not exist after deleting.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::delete_item
+ */
+ public function test_delete_item_no_trash() {
+ wp_set_current_user( self::$admin_id );
+ $font_family_id = self::create_font_family_post();
+
+ // Attempt trashing.
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . $font_family_id );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501, 'The response should return an error for "rest_trash_not_supported" with 501 status.' );
+
+ $request->set_param( 'force', 'false' );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501, 'When "force" is false, the response should return an error for "rest_trash_not_supported" with 501 status.' );
+
+ // Ensure the post still exists.
+ $post = get_post( $font_family_id );
+ $this->assertNotEmpty( $post, 'The post should still exist.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::delete_item
+ */
+ public function test_delete_item_invalid_font_family_id() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_post_invalid_id', $response, 404 );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::delete_item
+ */
+ public function test_delete_item_no_permissions() {
+ $font_family_id = self::create_font_family_post();
+
+ wp_set_current_user( 0 );
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . $font_family_id );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_delete', $response, 401, 'The response should return an error for "rest_cannot_delete" with 401 status for an invalid user.' );
+
+ wp_set_current_user( self::$editor_id );
+ $request = new WP_REST_Request( 'DELETE', '/wp/v2/font-families/' . $font_family_id );
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_delete', $response, 403, 'The response should return an error for "rest_cannot_delete" with 403 status for a user without permission.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::prepare_item_for_response
+ */
+ public function test_prepare_item() {
+ wp_set_current_user( self::$admin_id );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/font-families/' . self::$font_family_id2 );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $this->check_font_family_data( $data, self::$font_family_id2, $response->get_links() );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::get_item_schema
+ */
+ public function test_get_item_schema() {
+ $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/font-families' );
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+ $properties = $data['schema']['properties'];
+ $this->assertCount( 4, $properties, 'There should be 4 properties in the schema::properties data.' );
+ $this->assertArrayHasKey( 'id', $properties, 'The id property should exist in the schema::properties data.' );
+ $this->assertArrayHasKey( 'theme_json_version', $properties, 'The theme_json_version property should exist in the schema::properties data.' );
+ $this->assertArrayHasKey( 'font_faces', $properties, 'The font_faces property should exist in the schema::properties data.' );
+ $this->assertArrayHasKey( 'font_family_settings', $properties, 'The font_family_settings property should exist in the schema::properties data.' );
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::get_item_schema
+ */
+ public function test_get_item_schema_font_family_settings_should_all_have_sanitize_callbacks() {
+ $schema = ( new WP_REST_Font_Families_Controller( 'wp_font_family' ) )->get_item_schema();
+ $font_family_settings_schema = $schema['properties']['font_family_settings'];
+
+ $this->assertArrayHasKey( 'properties', $font_family_settings_schema, 'font_family_settings schema is missing properties.' );
+ $this->assertIsArray( $font_family_settings_schema['properties'], 'font_family_settings properties should be an array.' );
+
+ // arg_options should be removed for each setting property.
+ foreach ( $font_family_settings_schema['properties'] as $property ) {
+ $this->assertArrayHasKey( 'arg_options', $property, 'Setting schema should have arg_options.' );
+ $this->assertArrayHasKey( 'sanitize_callback', $property['arg_options'], 'Setting schema should have a sanitize_callback.' );
+ $this->assertIsCallable( $property['arg_options']['sanitize_callback'], 'That sanitize_callback value should be callable.' );
+ }
+ }
+
+ /**
+ * @covers WP_REST_Font_Families_Controller::get_public_item_schema
+ */
+ public function test_get_public_item_schema_should_not_have_arg_options() {
+ $schema = ( new WP_REST_Font_Families_Controller( 'wp_font_family' ) )->get_public_item_schema();
+ $font_family_settings_schema = $schema['properties']['font_family_settings'];
+
+ $this->assertArrayHasKey( 'properties', $font_family_settings_schema, 'font_family_settings schema is missing properties.' );
+ $this->assertIsArray( $font_family_settings_schema['properties'], 'font_family_settings properties should be an array.' );
+
+ // arg_options should be removed for each setting property.
+ foreach ( $font_family_settings_schema['properties'] as $property ) {
+ $this->assertArrayNotHasKey( 'arg_options', $property, 'arg_options should be removed from the schema for each setting.' );
+ }
+ }
+
+ /**
+ * If WP_Theme_JSON::LATEST_SCHEMA is changed, the controller should be updated to handle any differences
+ * in `fontFamilies` structure to ensure support for the latest theme.json schema, and backwards compatibility
+ * for existing wp_font_family posts.
+ */
+ public function test_controller_supports_latest_theme_json_version() {
+ $this->assertSame( WP_Theme_JSON::LATEST_SCHEMA, WP_REST_Font_Families_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED );
+ }
+
+ protected function check_font_family_data( $data, $post_id, $links ) {
+ static::$post_ids_to_cleanup[] = $post_id;
+ $post = get_post( $post_id );
+
+ $this->assertArrayHasKey( 'id', $data, 'The id property should exist in response data.' );
+ $this->assertSame( $post->ID, $data['id'], 'The "id" from the response data should match the post ID.' );
+
+ $this->assertArrayHasKey( 'theme_json_version', $data, 'The theme_json_version property should exist in response data.' );
+ $this->assertSame( WP_REST_Font_Families_Controller::LATEST_THEME_JSON_VERSION_SUPPORTED, $data['theme_json_version'], 'The "theme_json_version" from the response data should match the latest version supported by the controller.' );
+
+ $font_face_ids = get_children(
+ array(
+ 'fields' => 'ids',
+ 'post_parent' => $post_id,
+ 'post_type' => 'wp_font_face',
+ 'order' => 'ASC',
+ 'orderby' => 'ID',
+ )
+ );
+ $this->assertArrayHasKey( 'font_faces', $data, 'The font_faces property should exist in the response data.' );
+
+ foreach ( $font_face_ids as $font_face_id ) {
+ $this->assertContains( $font_face_id, $data['font_faces'], 'The ID is in the font_faces data.' );
+ }
+
+ $this->assertArrayHasKey( 'font_family_settings', $data, 'The font_family_settings property should exist in the response data.' );
+ $settings = $data['font_family_settings'];
+ $expected_settings = array(
+ 'name' => $post->post_title,
+ 'slug' => $post->post_name,
+ 'fontFamily' => $settings['fontFamily'],
+ 'preview' => $settings['preview'],
+ );
+ $this->assertSame( $expected_settings, $settings, 'The font_family_settings should match.' );
+
+ $this->assertNotEmpty( $links, 'The links should not be empty in the response data.' );
+ $expected = rest_url( 'wp/v2/font-families/' . $post->ID );
+ $this->assertSame( $expected, $links['self'][0]['href'], 'The links URL from the response data should match the post\'s REST endpoint.' );
+ $expected = rest_url( 'wp/v2/font-families' );
+ $this->assertSame( $expected, $links['collection'][0]['href'], 'The links collection URL from the response data should match the REST endpoint.' );
+
+ if ( ! $font_face_ids ) {
+ return;
+ }
+
+ // Check font_face links, if present.
+ $this->assertArrayHasKey( 'font_faces', $links );
+ foreach ( $links['font_faces'] as $index => $link ) {
+ $expected = rest_url( 'wp/v2/font-families/' . $post->ID . '/font-faces/' . $font_face_ids[ $index ] );
+ $this->assertSame( $expected, $link['href'], 'The links for a font faces URL from the response data should match the REST endpoint.' );
+
+ $embeddable = isset( $link['attributes']['embeddable'] )
+ ? $link['attributes']['embeddable']
+ : $link['embeddable'];
+ $this->assertTrue( $embeddable, 'The embeddable should be true.' );
+ }
+ }
+}
diff --git a/tests/phpunit/tests/formatting/sanitizeTextField.php b/tests/phpunit/tests/formatting/sanitizeTextField.php
index d7a58486d1ba5..82cef34a382d5 100644
--- a/tests/phpunit/tests/formatting/sanitizeTextField.php
+++ b/tests/phpunit/tests/formatting/sanitizeTextField.php
@@ -143,4 +143,26 @@ public function data_sanitize_text_field() {
),
);
}
+
+ /**
+ * @ticket 60357
+ */
+ public function test_sanitize_text_field_filter() {
+ $filter = new MockAction();
+ add_filter( 'sanitize_text_field', array( $filter, 'filter' ) );
+
+ $this->assertSame( 'example', sanitize_text_field( 'example' ) );
+ $this->assertSame( 1, $filter->get_call_count(), 'The sanitize_text_field filter was not called.' );
+ }
+
+ /**
+ * @ticket 60357
+ */
+ public function test_sanitize_textarea_field_filter() {
+ $filter = new MockAction();
+ add_filter( 'sanitize_textarea_field', array( $filter, 'filter' ) );
+
+ $this->assertSame( 'example', sanitize_textarea_field( 'example' ) );
+ $this->assertSame( 1, $filter->get_call_count(), 'The sanitize_textarea_field filter was not called.' );
+ }
}
diff --git a/tests/phpunit/tests/functions.php b/tests/phpunit/tests/functions.php
index 3c2e1101ad69d..abef68f75b085 100644
--- a/tests/phpunit/tests/functions.php
+++ b/tests/phpunit/tests/functions.php
@@ -1370,6 +1370,26 @@ public function data_wp_get_image_mime() {
DIR_TESTDATA . '/uploads/dashicons.woff',
false,
),
+ // Animated AVIF.
+ array(
+ DIR_TESTDATA . '/images/avif-animated.avif',
+ 'image/avif',
+ ),
+ // Lossless AVIF.
+ array(
+ DIR_TESTDATA . '/images/avif-lossless.avif',
+ 'image/avif',
+ ),
+ // Lossy AVIF.
+ array(
+ DIR_TESTDATA . '/images/avif-lossy.avif',
+ 'image/avif',
+ ),
+ // Transparent AVIF.
+ array(
+ DIR_TESTDATA . '/images/avif-transparent.avif',
+ 'image/avif',
+ ),
);
return $data;
@@ -1496,6 +1516,50 @@ public function data_wp_getimagesize() {
DIR_TESTDATA . '/uploads/dashicons.woff',
false,
),
+ // Animated AVIF.
+ array(
+ DIR_TESTDATA . '/images/avif-animated.avif',
+ array(
+ 150,
+ 150,
+ IMAGETYPE_AVIF,
+ 'width="150" height="150"',
+ 'mime' => 'image/avif',
+ ),
+ ),
+ // Lossless AVIF.
+ array(
+ DIR_TESTDATA . '/images/avif-lossless.avif',
+ array(
+ 400,
+ 400,
+ IMAGETYPE_AVIF,
+ 'width="400" height="400"',
+ 'mime' => 'image/avif',
+ ),
+ ),
+ // Lossy AVIF.
+ array(
+ DIR_TESTDATA . '/images/avif-lossy.avif',
+ array(
+ 400,
+ 400,
+ IMAGETYPE_AVIF,
+ 'width="400" height="400"',
+ 'mime' => 'image/avif',
+ ),
+ ),
+ // Transparent AVIF.
+ array(
+ DIR_TESTDATA . '/images/avif-transparent.avif',
+ array(
+ 128,
+ 128,
+ IMAGETYPE_AVIF,
+ 'width="128" height="128"',
+ 'mime' => 'image/avif',
+ ),
+ ),
);
return $data;
diff --git a/tests/phpunit/tests/html-api/wpHtmlProcessor.php b/tests/phpunit/tests/html-api/wpHtmlProcessor.php
index d9f1357b5c66f..26dc7b0bdb826 100644
--- a/tests/phpunit/tests/html-api/wpHtmlProcessor.php
+++ b/tests/phpunit/tests/html-api/wpHtmlProcessor.php
@@ -52,12 +52,12 @@ public function test_warns_that_the_static_creator_methods_should_be_called_inst
* @covers WP_HTML_Processor::get_tag
*/
public function test_get_tag_is_null_once_document_is_finished() {
- $p = WP_HTML_Processor::create_fragment( '
' );
- while ( $p->next_tag() ) {
+ while ( $processor->next_tag() ) {
// Create a bookmark before entering a stack of elements and formatting elements.
- if ( null !== $p->get_attribute( 'one' ) ) {
- $this->assertTrue( $p->set_bookmark( 'one' ) );
+ if ( null !== $processor->get_attribute( 'one' ) ) {
+ $this->assertTrue( $processor->set_bookmark( 'one' ) );
continue;
}
// Create a bookmark inside of that stack.
- if ( null !== $p->get_attribute( 'two' ) ) {
- $p->set_bookmark( 'two' );
+ if ( null !== $processor->get_attribute( 'two' ) ) {
+ $processor->set_bookmark( 'two' );
break;
}
}
// Ensure that it's possible to seek back to the outside location.
- $this->assertTrue( $p->seek( 'one' ), 'Could not seek to earlier-seen location.' );
- $this->assertSame( 'DIV', $p->get_tag(), "Should have jumped back to DIV but found {$p->get_tag()} instead." );
+ $this->assertTrue( $processor->seek( 'one' ), 'Could not seek to earlier-seen location.' );
+ $this->assertSame( 'DIV', $processor->get_tag(), "Should have jumped back to DIV but found {$processor->get_tag()} instead." );
/*
* Ensure that the P element from the inner location isn't still on the stack of open elements.
* If it were, then the first STRONG element, inside the outer DIV would match the next call.
*/
- $this->assertTrue( $p->next_tag( array( 'breadcrumbs' => array( 'P', 'STRONG' ) ) ), 'Failed to find given location after seeking.' );
+ $this->assertTrue( $processor->next_tag( array( 'breadcrumbs' => array( 'P', 'STRONG' ) ) ), 'Failed to find given location after seeking.' );
// Only if the stack is properly managed will the processor advance to the inner STRONG element.
- $this->assertTrue( $p->get_attribute( 'two' ), "Found the wrong location given the breadcrumbs, at {$p->get_tag()}." );
+ $this->assertTrue( $processor->get_attribute( 'two' ), "Found the wrong location given the breadcrumbs, at {$processor->get_tag()}." );
// Ensure that in seeking backwards the processor reports the correct full set of breadcrumbs.
- $this->assertTrue( $p->seek( 'one' ), 'Failed to jump back to first bookmark.' );
- $this->assertSame( array( 'HTML', 'BODY', 'DIV' ), $p->get_breadcrumbs(), 'Found wrong set of breadcrumbs navigating to node "one".' );
+ $this->assertTrue( $processor->seek( 'one' ), 'Failed to jump back to first bookmark.' );
+ $this->assertSame( array( 'HTML', 'BODY', 'DIV' ), $processor->get_breadcrumbs(), 'Found wrong set of breadcrumbs navigating to node "one".' );
// Ensure that in seeking forwards the processor reports the correct full set of breadcrumbs.
- $this->assertTrue( $p->seek( 'two' ), 'Failed to jump forward to second bookmark.' );
- $this->assertTrue( $p->get_attribute( 'two' ), "Found the wrong location given the bookmark, at {$p->get_tag()}." );
+ $this->assertTrue( $processor->seek( 'two' ), 'Failed to jump forward to second bookmark.' );
+ $this->assertTrue( $processor->get_attribute( 'two' ), "Found the wrong location given the bookmark, at {$processor->get_tag()}." );
- $this->assertSame( array( 'HTML', 'BODY', 'P', 'STRONG' ), $p->get_breadcrumbs(), 'Found wrong set of bookmarks navigating to node "two".' );
+ $this->assertSame( array( 'HTML', 'BODY', 'P', 'STRONG' ), $processor->get_breadcrumbs(), 'Found wrong set of bookmarks navigating to node "two".' );
}
/**
@@ -126,10 +126,144 @@ public function test_clear_to_navigate_after_seeking() {
* @covers WP_HTML_Processor::reconstruct_active_formatting_elements
*/
public function test_fails_to_reconstruct_formatting_elements() {
- $p = WP_HTML_Processor::create_fragment( '
Four' );
- $this->assertTrue( $p->next_tag( 'EM' ), 'Could not find first EM.' );
- $this->assertFalse( $p->next_tag( 'EM' ), 'Should have aborted before finding second EM as it required reconstructing the first EM.' );
+ $this->assertTrue( $processor->next_tag( 'EM' ), 'Could not find first EM.' );
+ $this->assertFalse( $processor->next_tag( 'EM' ), 'Should have aborted before finding second EM as it required reconstructing the first EM.' );
+ }
+
+ /**
+ * Ensure non-nesting tags do not nest.
+ *
+ * @ticket 60283
+ *
+ * @covers WP_HTML_Processor::step_in_body
+ * @covers WP_HTML_Processor::is_void
+ *
+ * @dataProvider data_void_tags
+ *
+ * @param string $tag_name Name of void tag under test.
+ */
+ public function test_cannot_nest_void_tags( $tag_name ) {
+ $processor = WP_HTML_Processor::create_fragment( "<{$tag_name}>
" );
+
+ /*
+ * This HTML represents the same as the following HTML,
+ * assuming that it were provided `` as the tag:
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ */
+
+ $found_tag = $processor->next_tag();
+
+ if ( WP_HTML_Processor::ERROR_UNSUPPORTED === $processor->get_last_error() ) {
+ $this->markTestSkipped( "Tag {$tag_name} is not supported." );
+ }
+
+ $this->assertTrue(
+ $found_tag,
+ "Could not find first {$tag_name}."
+ );
+
+ $this->assertSame(
+ array( 'HTML', 'BODY', $tag_name ),
+ $processor->get_breadcrumbs(),
+ 'Found incorrect nesting of first element.'
+ );
+
+ $this->assertTrue(
+ $processor->next_tag(),
+ 'Should have found the DIV as the second tag.'
+ );
+
+ $this->assertSame(
+ array( 'HTML', 'BODY', 'DIV' ),
+ $processor->get_breadcrumbs(),
+ "DIV should have been a sibling of the {$tag_name}."
+ );
+ }
+
+ /**
+ * Ensure non-nesting tags do not nest when processing tokens.
+ *
+ * @ticket 60382
+ *
+ * @dataProvider data_void_tags
+ *
+ * @param string $tag_name Name of void tag under test.
+ */
+ public function test_cannot_nest_void_tags_next_token( $tag_name ) {
+ $processor = WP_HTML_Processor::create_fragment( "<{$tag_name}>
" );
+
+ /*
+ * This HTML represents the same as the following HTML,
+ * assuming that it were provided `` as the tag:
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ */
+
+ $found_tag = $processor->next_token();
+
+ if ( WP_HTML_Processor::ERROR_UNSUPPORTED === $processor->get_last_error() ) {
+ $this->markTestSkipped( "Tag {$tag_name} is not supported." );
+ }
+
+ $this->assertTrue(
+ $found_tag,
+ "Could not find first {$tag_name}."
+ );
+
+ $this->assertSame(
+ array( 'HTML', 'BODY', $tag_name ),
+ $processor->get_breadcrumbs(),
+ 'Found incorrect nesting of first element.'
+ );
+
+ $this->assertTrue(
+ $processor->next_token(),
+ 'Should have found the DIV as the second tag.'
+ );
+
+ $this->assertSame(
+ array( 'HTML', 'BODY', 'DIV' ),
+ $processor->get_breadcrumbs(),
+ "DIV should have been a sibling of the {$tag_name}."
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public static function data_void_tags() {
+ return array(
+ 'AREA' => array( 'AREA' ),
+ 'BASE' => array( 'BASE' ),
+ 'BR' => array( 'BR' ),
+ 'COL' => array( 'COL' ),
+ 'EMBED' => array( 'EMBED' ),
+ 'HR' => array( 'HR' ),
+ 'IMG' => array( 'IMG' ),
+ 'INPUT' => array( 'INPUT' ),
+ 'KEYGEN' => array( 'KEYGEN' ),
+ 'LINK' => array( 'LINK' ),
+ 'META' => array( 'META' ),
+ 'PARAM' => array( 'PARAM' ),
+ 'SOURCE' => array( 'SOURCE' ),
+ 'TRACK' => array( 'TRACK' ),
+ 'WBR' => array( 'WBR' ),
+ );
}
/**
@@ -156,30 +290,23 @@ public function test_step_in_body_fails_on_unsupported_tags( $tag_name ) {
*
* @return array[]
*/
- public function data_unsupported_special_in_body_tags() {
+ public static function data_unsupported_special_in_body_tags() {
return array(
'APPLET' => array( 'APPLET' ),
- 'AREA' => array( 'AREA' ),
'BASE' => array( 'BASE' ),
'BASEFONT' => array( 'BASEFONT' ),
'BGSOUND' => array( 'BGSOUND' ),
'BODY' => array( 'BODY' ),
- 'BR' => array( 'BR' ),
'CAPTION' => array( 'CAPTION' ),
'COL' => array( 'COL' ),
'COLGROUP' => array( 'COLGROUP' ),
- 'EMBED' => array( 'EMBED' ),
'FORM' => array( 'FORM' ),
'FRAME' => array( 'FRAME' ),
'FRAMESET' => array( 'FRAMESET' ),
'HEAD' => array( 'HEAD' ),
- 'HR' => array( 'HR' ),
'HTML' => array( 'HTML' ),
'IFRAME' => array( 'IFRAME' ),
- 'INPUT' => array( 'INPUT' ),
- 'KEYGEN' => array( 'KEYGEN' ),
'LINK' => array( 'LINK' ),
- 'LISTING' => array( 'LISTING' ),
'MARQUEE' => array( 'MARQUEE' ),
'MATH' => array( 'MATH' ),
'META' => array( 'META' ),
@@ -190,9 +317,7 @@ public function data_unsupported_special_in_body_tags() {
'OBJECT' => array( 'OBJECT' ),
'OPTGROUP' => array( 'OPTGROUP' ),
'OPTION' => array( 'OPTION' ),
- 'PARAM' => array( 'PARAM' ),
'PLAINTEXT' => array( 'PLAINTEXT' ),
- 'PRE' => array( 'PRE' ),
'RB' => array( 'RB' ),
'RP' => array( 'RP' ),
'RT' => array( 'RT' ),
@@ -200,7 +325,6 @@ public function data_unsupported_special_in_body_tags() {
'SARCASM' => array( 'SARCASM' ),
'SCRIPT' => array( 'SCRIPT' ),
'SELECT' => array( 'SELECT' ),
- 'SOURCE' => array( 'SOURCE' ),
'STYLE' => array( 'STYLE' ),
'SVG' => array( 'SVG' ),
'TABLE' => array( 'TABLE' ),
@@ -213,8 +337,6 @@ public function data_unsupported_special_in_body_tags() {
'THEAD' => array( 'THEAD' ),
'TITLE' => array( 'TITLE' ),
'TR' => array( 'TR' ),
- 'TRACK' => array( 'TRACK' ),
- 'WBR' => array( 'WBR' ),
'XMP' => array( 'XMP' ),
);
}
diff --git a/tests/phpunit/tests/html-api/wpHtmlProcessorBreadcrumbs.php b/tests/phpunit/tests/html-api/wpHtmlProcessorBreadcrumbs.php
index 15d38d6f70c6c..1488be91654a7 100644
--- a/tests/phpunit/tests/html-api/wpHtmlProcessorBreadcrumbs.php
+++ b/tests/phpunit/tests/html-api/wpHtmlProcessorBreadcrumbs.php
@@ -23,10 +23,10 @@ class Tests_HtmlApi_WpHtmlProcessorBreadcrumbs extends WP_UnitTestCase {
* @param string $tag_name Name of first tag in HTML (because HTML treats IMAGE as IMG this may not match the HTML).
*/
public function test_navigates_into_normative_html_for_supported_elements( $html, $tag_name ) {
- $p = WP_HTML_Processor::create_fragment( $html );
+ $processor = WP_HTML_Processor::create_fragment( $html );
- $this->assertTrue( $p->step(), "Failed to step into supported {$tag_name} element." );
- $this->assertSame( $tag_name, $p->get_tag(), "Misread {$tag_name} as a {$p->get_tag()} element." );
+ $this->assertTrue( $processor->step(), "Failed to step into supported {$tag_name} element." );
+ $this->assertSame( $tag_name, $processor->get_tag(), "Misread {$tag_name} as a {$processor->get_tag()} element." );
}
/**
@@ -34,12 +34,13 @@ public function test_navigates_into_normative_html_for_supported_elements( $html
*
* @return array[]
*/
- public function data_single_tag_of_supported_elements() {
+ public static function data_single_tag_of_supported_elements() {
$supported_elements = array(
'A',
'ABBR',
'ACRONYM', // Neutralized.
'ADDRESS',
+ 'AREA',
'ARTICLE',
'ASIDE',
'AUDIO',
@@ -48,6 +49,7 @@ public function data_single_tag_of_supported_elements() {
'BDO',
'BIG',
'BLINK', // Deprecated.
+ 'BR',
'BUTTON',
'CANVAS',
'CENTER', // Neutralized.
@@ -65,6 +67,7 @@ public function data_single_tag_of_supported_elements() {
'DL',
'DT',
'EM',
+ 'EMBED',
'FIELDSET',
'FIGCAPTION',
'FIGURE',
@@ -78,22 +81,25 @@ public function data_single_tag_of_supported_elements() {
'H6',
'HEADER',
'HGROUP',
+ 'HR',
'I',
'IMG',
'INS',
'LI',
- 'ISINDEX', // Deprecated
+ 'ISINDEX', // Deprecated.
'KBD',
+ 'KEYGEN', // Deprecated.
'LABEL',
'LEGEND',
+ 'LISTING', // Deprecated.
'MAIN',
'MAP',
'MARK',
'MENU',
'METER',
- 'MULTICOL', // Deprecated
+ 'MULTICOL', // Deprecated.
'NAV',
- 'NEXTID', // Deprecated
+ 'NEXTID', // Deprecated.
'OL',
'OUTPUT',
'P',
@@ -106,7 +112,7 @@ public function data_single_tag_of_supported_elements() {
'SECTION',
'SLOT',
'SMALL',
- 'SPACER', // Deprecated
+ 'SPACER', // Deprecated.
'SPAN',
'STRIKE',
'STRONG',
@@ -149,9 +155,9 @@ public function data_single_tag_of_supported_elements() {
* @param string $html HTML string containing unsupported elements.
*/
public function test_fails_when_encountering_unsupported_tag( $html ) {
- $p = WP_HTML_Processor::create_fragment( $html );
+ $processor = WP_HTML_Processor::create_fragment( $html );
- $this->assertFalse( $p->step(), "Should not have stepped into unsupported {$p->get_tag()} element." );
+ $this->assertFalse( $processor->step(), "Should not have stepped into unsupported {$processor->get_tag()} element." );
}
/**
@@ -159,29 +165,22 @@ public function test_fails_when_encountering_unsupported_tag( $html ) {
*
* @return array[]
*/
- public function data_unsupported_elements() {
+ public static function data_unsupported_elements() {
$unsupported_elements = array(
'APPLET', // Deprecated.
- 'AREA',
'BASE',
'BGSOUND', // Deprecated; self-closing if self-closing flag provided, otherwise normal.
'BODY',
- 'BR',
'CAPTION',
'COL',
'COLGROUP',
- 'EMBED',
'FORM',
'FRAME',
'FRAMESET',
'HEAD',
- 'HR',
'HTML',
'IFRAME',
- 'INPUT',
- 'KEYGEN', // Deprecated; void.
'LINK',
- 'LISTING', // Deprecated, use PRE instead.
'MARQUEE', // Deprecated.
'MATH',
'META',
@@ -193,14 +192,12 @@ public function data_unsupported_elements() {
'OPTGROUP',
'OPTION',
'PLAINTEXT', // Neutralized.
- 'PRE',
'RB', // Neutralized.
'RP',
'RT',
'RTC', // Neutralized.
'SCRIPT',
'SELECT',
- 'SOURCE',
'STYLE',
'SVG',
'TABLE',
@@ -213,8 +210,6 @@ public function data_unsupported_elements() {
'THEAD',
'TITLE',
'TR',
- 'TRACK',
- 'WBR',
'XMP', // Deprecated, use PRE instead.
);
@@ -234,14 +229,14 @@ public function data_unsupported_elements() {
* @param string $html HTML containing unsupported markup.
*/
public function test_fails_when_encountering_unsupported_markup( $html, $description ) {
- $p = WP_HTML_Processor::create_fragment( $html );
+ $processor = WP_HTML_Processor::create_fragment( $html );
- while ( $p->step() && null === $p->get_attribute( 'supported' ) ) {
+ while ( $processor->step() && null === $processor->get_attribute( 'supported' ) ) {
continue;
}
- $this->assertTrue( $p->get_attribute( 'supported' ), 'Did not find required supported element.' );
- $this->assertFalse( $p->step(), "Didn't properly reject unsupported markup: {$description}" );
+ $this->assertTrue( $processor->get_attribute( 'supported' ), 'Did not find required supported element.' );
+ $this->assertFalse( $processor->step(), "Didn't properly reject unsupported markup: {$description}" );
}
/**
@@ -249,7 +244,7 @@ public function test_fails_when_encountering_unsupported_markup( $html, $descrip
*
* @return array[]
*/
- public function data_unsupported_markup() {
+ public static function data_unsupported_markup() {
return array(
'A with formatting following unclosed A' => array(
'Click Here',
@@ -275,17 +270,17 @@ public function data_unsupported_markup() {
* @param int $n How many breadcrumb matches to scan through in order to find "target" element.
*/
public function test_finds_correct_tag_given_breadcrumbs( $html, $breadcrumbs, $n ) {
- $p = WP_HTML_Processor::create_fragment( $html );
+ $processor = WP_HTML_Processor::create_fragment( $html );
- $p->next_tag(
+ $processor->next_tag(
array(
'breadcrumbs' => $breadcrumbs,
'match_offset' => $n,
)
);
- $this->assertNotNull( $p->get_tag(), 'Failed to find target node.' );
- $this->assertTrue( $p->get_attribute( 'target' ), "Found {$p->get_tag()} element didn't contain the necessary 'target' attribute." );
+ $this->assertNotNull( $processor->get_tag(), 'Failed to find target node.' );
+ $this->assertTrue( $processor->get_attribute( 'target' ), "Found {$processor->get_tag()} element didn't contain the necessary 'target' attribute." );
}
/**
@@ -300,14 +295,14 @@ public function test_finds_correct_tag_given_breadcrumbs( $html, $breadcrumbs, $
* @param int $ignored_n Not used in this test but provided in the dataset for other tests.
*/
public function test_reports_correct_breadcrumbs_for_html( $html, $breadcrumbs, $ignored_n ) {
- $p = WP_HTML_Processor::create_fragment( $html );
+ $processor = WP_HTML_Processor::create_fragment( $html );
- while ( $p->next_tag() && null === $p->get_attribute( 'target' ) ) {
+ while ( $processor->next_tag() && null === $processor->get_attribute( 'target' ) ) {
continue;
}
- $this->assertNotNull( $p->get_tag(), 'Failed to find the target node.' );
- $this->assertSame( $breadcrumbs, $p->get_breadcrumbs(), 'Found the wrong path from the root of the HTML document to the target node.' );
+ $this->assertNotNull( $processor->get_tag(), 'Failed to find the target node.' );
+ $this->assertSame( $breadcrumbs, $processor->get_breadcrumbs(), 'Found the wrong path from the root of the HTML document to the target node.' );
}
/**
@@ -315,7 +310,7 @@ public function test_reports_correct_breadcrumbs_for_html( $html, $breadcrumbs,
*
* @return array[]
*/
- public function data_html_target_with_breadcrumbs() {
+ public static function data_html_target_with_breadcrumbs() {
return array(
'Simple IMG tag' => array( '', array( 'HTML', 'BODY', 'IMG' ), 1 ),
'Two sibling IMG tags' => array( '', array( 'HTML', 'BODY', 'IMG' ), 2 ),
@@ -398,7 +393,7 @@ public function test_reports_if_tag_matches_breadcrumbs_of_various_specificity(
*
* @return array[].
*/
- public function data_html_with_breadcrumbs_of_various_specificity() {
+ public static function data_html_with_breadcrumbs_of_various_specificity() {
return array(
// Test with void elements.
'Inner IMG' => array( '
', array( 'span', 'figure', 'img' ), true ),
@@ -438,38 +433,38 @@ public function data_html_with_breadcrumbs_of_various_specificity() {
* @covers WP_HTML_Tag_Processor::get_updated_html
*/
public function test_remains_stable_when_editing_attributes() {
- $p = WP_HTML_Processor::create_fragment( '