*/
private SplObjectStorage $internal_blocks;
/**
* Constructor.
*
* @since 3.9
*
* @param \PLL_Base $polylang Polylang object.
*/
public function __construct( &$polylang ) {
parent::__construct( $polylang );
$this->internal_blocks = new SplObjectStorage();
}
/**
* Adds the required hooks specific to the navigation language switcher.
*
* @since 3.2
*
* @return self
*/
public function init() {
parent::init();
add_action( 'rest_api_init', array( $this, 'register_switcher_menu_item_options_meta_rest_field' ) );
add_filter( 'render_block_core/navigation-link', array( $this, 'render_custom_attributes' ), 10, 3 );
add_filter( 'render_block_core/navigation-submenu', array( $this, 'render_custom_attributes' ), 10, 3 );
add_action( 'init', array( $this, 'register_styles' ) );
return $this;
}
/**
* Registers the styles for the navigation language switcher block.
*
* @since 3.8
*
* @return void
*/
public function register_styles(): void {
$suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
wp_register_style(
'pll-navigation-language-switcher',
plugins_url( 'css/build/navigation-language-switcher' . $suffix . '.css', POLYLANG_ROOT_FILE ),
array(),
POLYLANG_VERSION
);
wp_register_style(
'pll-navigation-language-switcher-editor',
plugins_url( 'css/build/navigation-language-switcher-editor' . $suffix . '.css', POLYLANG_ROOT_FILE ),
array(),
POLYLANG_VERSION
);
}
/**
* Returns the navigation language switcher block name with the Polylang's namespace.
*
* @since 3.2
*
* @return string The block name.
*/
protected function get_block_name() {
return 'polylang/navigation-language-switcher';
}
/**
* Renders the `polylang/navigation-language-switcher` block on server.
*
* @since 3.1
* @since 3.3 Accepts two new parameters, $content and $block.
*
* @param array $attributes The block attributes.
* @param string $content The saved content. Unused.
* @param WP_Block $block The parsed block.
* @return string The HTML string output to serve.
*/
public function render( $attributes, $content, $block ) {
$settings = new Settings( $attributes );
$elements = ( new Switcher( $settings, $this->links ) )->get_elements();
if ( empty( $elements ) ) {
return '';
}
$attributes['className'] .= ' ' . wp_apply_generated_classname_support( $block->block_type )['class'];
if ( 'dropdown' === $settings->layout ) {
$top_level_element = $this->get_top_level_element( $settings );
if ( empty( $top_level_element ) ) {
return '';
}
$inner_nav_link_blocks = array();
$attributes_wo_classname = array_diff_key( $attributes, array( 'className' => '' ) );
foreach ( $elements as $element ) {
$inner_nav_link_blocks[] = $this->create_inner_block( 'core/navigation-link', $attributes_wo_classname, $element, $block->context );
}
$submenu_block = $this->create_inner_block( 'core/navigation-submenu', $attributes, $top_level_element, $block->context, $inner_nav_link_blocks );
$output = $submenu_block->render();
} else {
$output = '';
foreach ( $elements as $element ) {
$output .= $this->create_inner_block( 'core/navigation-link', $attributes, $element, $block->context )->render();
}
}
return $output;
}
/**
* Register switcher menu item meta options as a REST API field.
*
* @since 3.2
*
* @return void
*/
public function register_switcher_menu_item_options_meta_rest_field() {
register_post_meta(
'nav_menu_item',
'_pll_menu_item',
array(
'object_subtype' => 'nav_menu_item',
'description' => __( 'Language switcher settings', 'polylang' ),
'single' => true,
'show_in_rest' => array(
'schema' => array(
'type' => 'object',
'additionalProperties' => array(
'type' => 'boolean',
),
),
),
)
);
}
/**
* Renders a core/naviagation-link or core/naviagation-submenu block by adding hreflang and lang attributes to the tag
* and also the language flag if required.
*
* @since 3.6
*
* @param string $block_content The block content.
* @param array $block The full block, including name and attributes.
* @param WP_Block $instance The block instance.
*
* @return string A formatted HTML string representing the core/navigation-link or core/navigation-submenu block.
*/
public function render_custom_attributes( $block_content, $block, $instance ) {
if ( ! $this->internal_blocks->offsetExists( $instance ) ) {
return $block_content;
}
$snapshot = $this->internal_blocks->offsetGet( $instance );
$this->internal_blocks->offsetUnset( $instance );
$content_tags = new WP_HTML_Tag_Processor( $block_content );
if ( 'core/navigation-submenu' === $instance->name ) {
// If `openSubmenusOnClick`, the submenu is rendered as a button, so there are no `` to process.
if ( empty( $instance->context['openSubmenusOnClick'] ) && $content_tags->next_tag( array( 'tag_name' => 'a' ) ) ) {
$content_tags->set_attribute( 'hreflang', $snapshot['locale'] );
$content_tags->set_attribute( 'lang', $snapshot['locale'] );
}
if ( $content_tags->next_tag( array( 'tag_name' => 'button' ) ) ) {
$content_tags->set_attribute(
'aria-label',
str_replace(
static::PLACEHOLDER,
__( 'Languages', 'polylang' ),
(string) $content_tags->get_attribute( 'aria-label' )
)
);
}
} elseif ( $content_tags->next_tag( array( 'tag_name' => 'a' ) ) ) {
$content_tags->set_attribute( 'hreflang', $snapshot['locale'] );
$content_tags->set_attribute( 'lang', $snapshot['locale'] );
}
$overridden_block_content = $content_tags->get_updated_html();
return str_replace(
static::PLACEHOLDER,
$snapshot['label'],
$overridden_block_content
);
}
/**
* Returns the path to the block JSON file directory.
* The directory name being used to register a block.
*
* @since 3.8
*
* @return string The path to the block.
*/
protected function get_path(): string {
return __DIR__;
}
/**
* Creates an inner navigation block and stores the locale and label to render for it.
*
* @since 3.9
*
* @param string $block_name Core block name.
* @param array $attributes Array of polylang/navigation-language-switcher attributes.
* @param Abstract_Element $element Switcher element.
* @param array $context Block context.
* @param WP_Block[] $inner_blocks Optional inner blocks.
* @return WP_Block
*/
private function create_inner_block( string $block_name, array $attributes, Abstract_Element $element, array $context, array $inner_blocks = array() ): WP_Block {
$block = new WP_Block(
array(
'blockName' => $block_name,
'attrs' => $this->get_core_block_attributes( $attributes, $element ),
'innerBlocks' => $inner_blocks,
),
$context
);
$this->internal_blocks->offsetSet(
$block,
array(
'locale' => $element->locale,
'label' => $this->apply_flag_styles_to_markup( $element->get_label(), $attributes ),
)
);
return $block;
}
/**
* Returns the top-level language element for a dropdown layout.
*
* @since 3.9
*
* @param Settings $settings Switcher settings.
* @return Element|null
*/
private function get_top_level_element( Settings $settings ): ?Element {
$curlang = $this->links->curlang ?? $this->model->get_default_language();
if ( ! $curlang instanceof PLL_Language ) {
return null;
}
return new Element( $curlang, $settings, $this->links );
}
/**
* Returns attributes that fit for core/navigation-link or core/navigation-submenu and specific to polylang/navigation-language-switcher.
*
* @since 3.6
*
* @param array $attributes Array of polylang/navigation-language-switcher attributes.
* @param Abstract_Element $element Switcher element.
* @return array Attributes to be rendered by core.
*/
private function get_core_block_attributes( array $attributes, Abstract_Element $element ): array {
$class_name = trim( implode( ' ', $element->item_classes ) );
if ( ! empty( $attributes['show_flags'] ) ) {
$aspect_ratio = $attributes['flag_aspect_ratio'] ?? '3:2';
$class_name .= ' pll-aspect-ratio-' . str_replace( ':', '', $aspect_ratio );
}
if ( ! empty( $attributes['className'] ) ) {
$class_name .= ' ' . $attributes['className'];
}
return array(
'label' => static::PLACEHOLDER,
'url' => $element->url,
'className' => $class_name,
);
}
}