summaryrefslogtreecommitdiffstats
path: root/wp-includes/block-supports/position.php
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:56:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:56:49 +0000
commita415c29efee45520ae252d2aa28f1083a521cd7b (patch)
treef4ade4b6668ecc0765de7e1424f7c1427ad433ff /wp-includes/block-supports/position.php
parentInitial commit. (diff)
downloadwordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.tar.xz
wordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.zip
Adding upstream version 6.4.3+dfsg1.upstream/6.4.3+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'wp-includes/block-supports/position.php')
-rw-r--r--wp-includes/block-supports/position.php151
1 files changed, 151 insertions, 0 deletions
diff --git a/wp-includes/block-supports/position.php b/wp-includes/block-supports/position.php
new file mode 100644
index 0000000..5659afc
--- /dev/null
+++ b/wp-includes/block-supports/position.php
@@ -0,0 +1,151 @@
+<?php
+/**
+ * Position block support flag.
+ *
+ * @package WordPress
+ * @since 6.2.0
+ */
+
+/**
+ * Registers the style block attribute for block types that support it.
+ *
+ * @since 6.2.0
+ * @access private
+ *
+ * @param WP_Block_Type $block_type Block Type.
+ */
+function wp_register_position_support( $block_type ) {
+ $has_position_support = block_has_support( $block_type, 'position', false );
+
+ // Set up attributes and styles within that if needed.
+ if ( ! $block_type->attributes ) {
+ $block_type->attributes = array();
+ }
+
+ if ( $has_position_support && ! array_key_exists( 'style', $block_type->attributes ) ) {
+ $block_type->attributes['style'] = array(
+ 'type' => 'object',
+ );
+ }
+}
+
+/**
+ * Renders position styles to the block wrapper.
+ *
+ * @since 6.2.0
+ * @access private
+ *
+ * @param string $block_content Rendered block content.
+ * @param array $block Block object.
+ * @return string Filtered block content.
+ */
+function wp_render_position_support( $block_content, $block ) {
+ $block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
+ $has_position_support = block_has_support( $block_type, 'position', false );
+
+ if (
+ ! $has_position_support ||
+ empty( $block['attrs']['style']['position'] )
+ ) {
+ return $block_content;
+ }
+
+ $global_settings = wp_get_global_settings();
+ $theme_has_sticky_support = isset( $global_settings['position']['sticky'] ) ? $global_settings['position']['sticky'] : false;
+ $theme_has_fixed_support = isset( $global_settings['position']['fixed'] ) ? $global_settings['position']['fixed'] : false;
+
+ // Only allow output for position types that the theme supports.
+ $allowed_position_types = array();
+ if ( true === $theme_has_sticky_support ) {
+ $allowed_position_types[] = 'sticky';
+ }
+ if ( true === $theme_has_fixed_support ) {
+ $allowed_position_types[] = 'fixed';
+ }
+
+ $style_attribute = isset( $block['attrs']['style'] ) ? $block['attrs']['style'] : null;
+ $class_name = wp_unique_id( 'wp-container-' );
+ $selector = ".$class_name";
+ $position_styles = array();
+ $position_type = isset( $style_attribute['position']['type'] ) ? $style_attribute['position']['type'] : '';
+ $wrapper_classes = array();
+
+ if (
+ in_array( $position_type, $allowed_position_types, true )
+ ) {
+ $wrapper_classes[] = $class_name;
+ $wrapper_classes[] = 'is-position-' . $position_type;
+ $sides = array( 'top', 'right', 'bottom', 'left' );
+
+ foreach ( $sides as $side ) {
+ $side_value = isset( $style_attribute['position'][ $side ] ) ? $style_attribute['position'][ $side ] : null;
+ if ( null !== $side_value ) {
+ /*
+ * For fixed or sticky top positions,
+ * ensure the value includes an offset for the logged in admin bar.
+ */
+ if (
+ 'top' === $side &&
+ ( 'fixed' === $position_type || 'sticky' === $position_type )
+ ) {
+ // Ensure 0 values can be used in `calc()` calculations.
+ if ( '0' === $side_value || 0 === $side_value ) {
+ $side_value = '0px';
+ }
+
+ // Ensure current side value also factors in the height of the logged in admin bar.
+ $side_value = "calc($side_value + var(--wp-admin--admin-bar--position-offset, 0px))";
+ }
+
+ $position_styles[] =
+ array(
+ 'selector' => $selector,
+ 'declarations' => array(
+ $side => $side_value,
+ ),
+ );
+ }
+ }
+
+ $position_styles[] =
+ array(
+ 'selector' => $selector,
+ 'declarations' => array(
+ 'position' => $position_type,
+ 'z-index' => '10',
+ ),
+ );
+ }
+
+ if ( ! empty( $position_styles ) ) {
+ /*
+ * Add to the style engine store to enqueue and render position styles.
+ */
+ wp_style_engine_get_stylesheet_from_css_rules(
+ $position_styles,
+ array(
+ 'context' => 'block-supports',
+ 'prettify' => false,
+ )
+ );
+
+ // Inject class name to block container markup.
+ $content = new WP_HTML_Tag_Processor( $block_content );
+ $content->next_tag();
+ foreach ( $wrapper_classes as $class ) {
+ $content->add_class( $class );
+ }
+ return (string) $content;
+ }
+
+ return $block_content;
+}
+
+// Register the block support.
+WP_Block_Supports::get_instance()->register(
+ 'position',
+ array(
+ 'register_attribute' => 'wp_register_position_support',
+ )
+);
+add_filter( 'render_block', 'wp_render_position_support', 10, 2 );