← All changes
|
extensions/blocks/sharing-button/sharing-button.php
+212
-16
13.1.5
→
16.3-a.7
View file →
| @@ -1,9 +1,9 @@ | ||
| 1 | 1 | <?php |
| 2 | 2 | /** |
| 3 | 3 | * Sharing Buttons Block. |
| 4 | 4 | * |
| 5 | - * @since 11.x | |
| 5 | + * @since 13.1 | |
| 6 | 6 | * |
| 7 | 7 | * @package automattic/jetpack |
| 8 | 8 | */ |
| 9 | 9 | |
| @@ -9,13 +9,23 @@ | ||
| 9 | 9 | |
| 10 | 10 | namespace Automattic\Jetpack\Extensions\Sharing_Button_Block; |
| 11 | 11 | |
| 12 | 12 | use Automattic\Jetpack\Blocks; |
| 13 | +use Automattic\Jetpack\Modules; | |
| 14 | +use Automattic\Jetpack\Status\Host; | |
| 13 | 15 | use Jetpack_Gutenberg; |
| 16 | +use WP_Block_Template; | |
| 14 | 17 | |
| 18 | +if ( ! defined( 'ABSPATH' ) ) { | |
| 19 | + exit( 0 ); | |
| 20 | +} | |
| 21 | + | |
| 15 | 22 | require_once __DIR__ . '/class-sharing-source-block.php'; |
| 16 | 23 | require_once __DIR__ . '/components/social-icons.php'; |
| 17 | 24 | |
| 25 | +const PARENT_BLOCK_NAME = 'jetpack/sharing-buttons'; | |
| 26 | +const INNER_BLOCK_NAME = 'jetpack/sharing-button'; | |
| 27 | + | |
| 18 | 28 | /** |
| 19 | 29 | * Registers the block for use in Gutenberg |
| 20 | 30 | * This is done via an action so that we can disable |
| 21 | 31 | * registration if we need to. |
| @@ -24,8 +34,14 @@ | ||
| 24 | 34 | Blocks::jetpack_register_block( |
| 25 | 35 | __DIR__, |
| 26 | 36 | array( 'render_callback' => __NAMESPACE__ . '\render_block' ) |
| 27 | 37 | ); |
| 38 | + | |
| 39 | + /* | |
| 40 | + * Automatically add the sharing block to the end of single posts. | |
| 41 | + */ | |
| 42 | + add_filter( 'hooked_block_types', __NAMESPACE__ . '\add_block_to_single_posts_template', 10, 4 ); | |
| 43 | + add_filter( 'hooked_block_' . PARENT_BLOCK_NAME, __NAMESPACE__ . '\add_default_services_to_block', 10, 5 ); | |
| 28 | 44 | } |
| 29 | 45 | add_action( 'init', __NAMESPACE__ . '\register_block' ); |
| 30 | 46 | |
| 31 | 47 | /** |
| @@ -37,8 +53,13 @@ | ||
| 37 | 53 | * |
| 38 | 54 | * @return string |
| 39 | 55 | */ |
| 40 | 56 | function render_block( $attr, $content, $block ) { |
| 57 | + $services = get_services(); | |
| 58 | + if ( ! isset( $attr['service'] ) || ! array_key_exists( $attr['service'], $services ) ) { | |
| 59 | + return $content; | |
| 60 | + } | |
| 61 | + | |
| 41 | 62 | $service_name = $attr['service']; |
| 42 | 63 | $title = $attr['label'] ?? $service_name; |
| 43 | 64 | $icon = get_social_logo( $service_name ); |
| 44 | 65 | $style_type = $block->context['styleType'] ?? 'icon-text'; |
| @@ -48,27 +69,45 @@ | ||
| 48 | 69 | $service_name, |
| 49 | 70 | $post_id |
| 50 | 71 | ); |
| 51 | 72 | |
| 52 | - $services = get_services(); | |
| 53 | - $service = new $services[ $service_name ]( $service_name, array() ); | |
| 54 | - $link_props = $service->get_link( | |
| 73 | + $service = new $services[ $service_name ]( $service_name, array() ); | |
| 74 | + $link_props = $service->get_link( | |
| 55 | 75 | $post_id, |
| 56 | 76 | 'share=' . esc_attr( $service_name ) . '&nb=1', |
| 57 | 77 | esc_attr( $data_shared ) |
| 58 | 78 | ); |
| 59 | - $link_url = $link_props['url']; | |
| 60 | - $link_classes = sprintf( | |
| 79 | + $link_url = $link_props['url']; | |
| 80 | + $link_classes = sprintf( | |
| 61 | 81 | 'jetpack-sharing-button__button style-%1$s share-%2$s', |
| 62 | 82 | $style_type, |
| 63 | 83 | $service_name |
| 64 | 84 | ); |
| 65 | - $link_aria_label = sprintf( | |
| 66 | - /* translators: %s refers to a string representation of sharing service, e.g. Facebook */ | |
| 85 | + | |
| 86 | + $accessible_name = sprintf( | |
| 87 | + /* translators: %s refers to a string representation of sharing service, e.g. Facebook */ | |
| 67 | 88 | esc_html__( 'Share on %s', 'jetpack' ), |
| 68 | 89 | esc_html( $title ) |
| 69 | 90 | ); |
| 70 | 91 | |
| 92 | + $accessible_name .= __( ' (Opens in new window)', 'jetpack' ); | |
| 93 | + | |
| 94 | + $block_class_name = 'jetpack-sharing-button__list-item'; | |
| 95 | + | |
| 96 | + if ( $service_name === 'share' ) { | |
| 97 | + $block_class_name .= ' tooltip'; | |
| 98 | + /* translators: aria label for SMS sharing button */ | |
| 99 | + $accessible_name = esc_attr__( 'Share using Native tools', 'jetpack' ); | |
| 100 | + $link_props = $service->get_link( $post_id ); | |
| 101 | + } | |
| 102 | + | |
| 103 | + $link_url = $link_props['url']; | |
| 104 | + $link_classes = sprintf( | |
| 105 | + 'jetpack-sharing-button__button style-%1$s share-%2$s', | |
| 106 | + $style_type, | |
| 107 | + $service_name | |
| 108 | + ); | |
| 109 | + | |
| 71 | 110 | $styles = array(); |
| 72 | 111 | if ( |
| 73 | 112 | array_key_exists( 'iconColorValue', $block->context ) |
| 74 | 113 | && ! empty( $block->context['iconColorValue'] ) |
| @@ -87,20 +126,30 @@ | ||
| 87 | 126 | } |
| 88 | 127 | |
| 89 | 128 | Jetpack_Gutenberg::load_assets_as_required( __DIR__ ); |
| 90 | 129 | |
| 91 | - $component = '<li class="jetpack-sharing-button__list-item">'; | |
| 130 | + $component = '<li class="' . esc_attr( $block_class_name ) . '">'; | |
| 92 | 131 | $component .= sprintf( |
| 93 | - '<a href="%1$s" target="_blank" rel="nofollow noopener noreferrer" class="%2$s" style="%3$s" data-service="%4$s" data-shared="%5$s" aria-label="%6$s">', | |
| 132 | + '<a href="%1$s" target="_blank" rel="nofollow noopener noreferrer" class="%2$s" style="%3$s" data-service="%4$s" data-shared="%5$s" aria-labelledby="%5$s">', | |
| 94 | 133 | esc_url( $link_url ), |
| 95 | 134 | esc_attr( $link_classes ), |
| 96 | 135 | esc_attr( $link_styles ), |
| 97 | 136 | esc_attr( $service_name ), |
| 137 | + esc_attr( $data_shared ) | |
| 138 | + ); | |
| 139 | + | |
| 140 | + // Add hidden span with accessible name | |
| 141 | + $component .= sprintf( | |
| 142 | + '<span id="%s" hidden>%s</span>', | |
| 98 | 143 | esc_attr( $data_shared ), |
| 99 | - esc_attr( $link_aria_label ) | |
| 144 | + esc_html( $accessible_name ) | |
| 100 | 145 | ); |
| 146 | + | |
| 101 | 147 | $component .= $style_type !== 'text' ? $icon : ''; |
| 102 | 148 | $component .= '<span class="jetpack-sharing-button__service-label" aria-hidden="true">' . esc_html( $title ) . '</span>'; |
| 149 | + if ( $service_name === 'share' ) { | |
| 150 | + $component .= '<span class="tooltiptext" aria-live="assertive">' . esc_html__( 'Copied to clipboard', 'jetpack' ) . '</span>'; | |
| 151 | + } | |
| 103 | 152 | $component .= '</a>'; |
| 104 | 153 | $component .= '</li>'; |
| 105 | 154 | |
| 106 | 155 | return $component; |
| @@ -120,14 +169,16 @@ | ||
| 120 | 169 | 'reddit' => Share_Reddit_Block::class, |
| 121 | 170 | 'twitter' => Share_Twitter_Block::class, |
| 122 | 171 | 'tumblr' => Share_Tumblr_Block::class, |
| 123 | 172 | 'pinterest' => Share_Pinterest_Block::class, |
| 124 | - 'pocket' => Share_Pocket_Block::class, | |
| 125 | 173 | 'telegram' => Share_Telegram_Block::class, |
| 174 | + 'threads' => Share_Threads_Block::class, | |
| 126 | 175 | 'whatsapp' => Jetpack_Share_WhatsApp_Block::class, |
| 127 | 176 | 'mastodon' => Share_Mastodon_Block::class, |
| 128 | 177 | 'nextdoor' => Share_Nextdoor_Block::class, |
| 178 | + 'bluesky' => Share_Bluesky_Block::class, | |
| 129 | 179 | 'x' => Share_X_Block::class, |
| 180 | + 'share' => Share_Native_Block::class, | |
| 130 | 181 | ); |
| 131 | 182 | |
| 132 | 183 | return $services; |
| 133 | 184 | } |
| @@ -149,12 +200,157 @@ | ||
| 149 | 200 | if ( ! array_key_exists( $service_name, $services ) ) { |
| 150 | 201 | return; |
| 151 | 202 | } |
| 152 | 203 | |
| 153 | - $service = new $services[ ( $service_name ) ]( $service_name, array() ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended | |
| 154 | - if ( $service ) { | |
| 155 | - $service->process_request( $post, $_POST ); // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 204 | + $service = new $services[ ( $service_name ) ]( $service_name, array() ); | |
| 205 | + $service->process_request( $post, $_POST ); // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 206 | + } | |
| 207 | +} | |
| 208 | + | |
| 209 | +// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Only checking for the data being present. | |
| 210 | +if ( isset( $_GET['share'] ) ) { | |
| 211 | + add_action( 'template_redirect', __NAMESPACE__ . '\sharing_process_requests', 9 ); | |
| 212 | +} | |
| 213 | + | |
| 214 | +/** | |
| 215 | + * Automatically add the Sharing Buttons block to the end of the Single Posts template. | |
| 216 | + * | |
| 217 | + * @since 13.2 | |
| 218 | + * | |
| 219 | + * @param array $hooked_block_types The list of hooked block types. | |
| 220 | + * @param string $relative_position The relative position of the hooked blocks. Can be one of 'before', 'after', 'first_child', or 'last_child'. | |
| 221 | + * @param string $anchor_block_type The anchor block type. | |
| 222 | + * @param WP_Block_Template|array $context The block template, template part, or pattern that the anchor block belongs to. | |
| 223 | + * | |
| 224 | + * @return array | |
| 225 | + */ | |
| 226 | +function add_block_to_single_posts_template( $hooked_block_types, $relative_position, $anchor_block_type, $context ) { | |
| 227 | + // Add the block at the end of the post content. | |
| 228 | + if ( | |
| 229 | + 'after' !== $relative_position | |
| 230 | + || 'core/post-content' !== $anchor_block_type | |
| 231 | + ) { | |
| 232 | + return $hooked_block_types; | |
| 233 | + } | |
| 234 | + | |
| 235 | + // Only automate the addition of the block in block-based themes. | |
| 236 | + if ( ! wp_is_block_theme() ) { | |
| 237 | + return $hooked_block_types; | |
| 238 | + } | |
| 239 | + | |
| 240 | + // Proceed if the user has toggled the auto-addition in Jetpack settings. | |
| 241 | + if ( ! get_option( 'jetpack_sharing_buttons_auto_add' ) ) { | |
| 242 | + return $hooked_block_types; | |
| 243 | + } | |
| 244 | + | |
| 245 | + /* | |
| 246 | + * The Sharing module must be disabled. | |
| 247 | + * We do not want to automatically insert sharing buttons twice. | |
| 248 | + * On WordPress.com Simple the module is always active so we must check differently. | |
| 249 | + * There, we check if buttons are enabled on single posts and pages. | |
| 250 | + */ | |
| 251 | + if ( ( new Host() )->is_wpcom_simple() ) { | |
| 252 | + if ( ! class_exists( 'Sharing_Service' ) ) { | |
| 253 | + include_once JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php'; | |
| 156 | 254 | } |
| 255 | + | |
| 256 | + $sharer = new \Sharing_Service(); | |
| 257 | + $global = $sharer->get_global_options(); | |
| 258 | + if ( | |
| 259 | + ! $global['show'] | |
| 260 | + || in_array( 'post', $global['show'], true ) | |
| 261 | + || in_array( 'page', $global['show'], true ) | |
| 262 | + ) { | |
| 263 | + return $hooked_block_types; | |
| 264 | + } | |
| 265 | + } elseif ( ( new Modules() )->is_active( 'sharedaddy' ) ) { | |
| 266 | + return $hooked_block_types; | |
| 157 | 267 | } |
| 268 | + | |
| 269 | + // Only hook into page and single post templates. | |
| 270 | + if ( | |
| 271 | + ! $context instanceof WP_Block_Template | |
| 272 | + || ! property_exists( $context, 'slug' ) | |
| 273 | + || empty( $context->slug ) | |
| 274 | + || ! preg_match( '/^(page|single)/', $context->slug ) | |
| 275 | + ) { | |
| 276 | + return $hooked_block_types; | |
| 277 | + } | |
| 278 | + | |
| 279 | + $hooked_block_types[] = PARENT_BLOCK_NAME; | |
| 280 | + return $hooked_block_types; | |
| 158 | 281 | } |
| 159 | 282 | |
| 160 | -add_action( 'template_redirect', __NAMESPACE__ . '\sharing_process_requests', 9 ); | |
| 283 | +/** | |
| 284 | + * Add default services to the block we add to the post content by default. | |
| 285 | + * | |
| 286 | + * @since 13.2 | |
| 287 | + * | |
| 288 | + * @param array $parsed_hooked_block The parsed block array for the given hooked block type. | |
| 289 | + * @param string $hooked_block_type The hooked block type name. | |
| 290 | + * @param string $relative_position The relative position of the hooked block. | |
| 291 | + * @param array $parsed_anchor_block The anchor block, in parsed block array format. | |
| 292 | + * @param WP_Block_Template|array $context The block template, template part, or pattern that the anchor block. | |
| 293 | + * | |
| 294 | + * @return array | |
| 295 | + */ | |
| 296 | +function add_default_services_to_block( $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block, $context ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable | |
| 297 | + // Is the hooked block adjacent to the anchor block? | |
| 298 | + if ( 'after' !== $relative_position ) { | |
| 299 | + return $parsed_hooked_block; | |
| 300 | + } | |
| 301 | + | |
| 302 | + // Use the icon style by default. | |
| 303 | + $parsed_hooked_block['attrs']['styleType'] = 'icon'; | |
| 304 | + | |
| 305 | + // Add default services (inner blocks) to the block. | |
| 306 | + $parsed_hooked_block['innerBlocks'] = array( | |
| 307 | + array( | |
| 308 | + 'blockName' => INNER_BLOCK_NAME, | |
| 309 | + 'innerContent' => array(), | |
| 310 | + 'attrs' => array( | |
| 311 | + 'service' => 'facebook', | |
| 312 | + 'label' => esc_html__( 'Facebook', 'jetpack' ), | |
| 313 | + ), | |
| 314 | + ), | |
| 315 | + array( | |
| 316 | + 'blockName' => INNER_BLOCK_NAME, | |
| 317 | + 'innerContent' => array(), | |
| 318 | + 'attrs' => array( | |
| 319 | + 'service' => 'x', | |
| 320 | + 'label' => esc_html__( 'X', 'jetpack' ), | |
| 321 | + ), | |
| 322 | + ), | |
| 323 | + array( | |
| 324 | + 'blockName' => INNER_BLOCK_NAME, | |
| 325 | + 'innerContent' => array(), | |
| 326 | + 'attrs' => array( | |
| 327 | + 'service' => 'mastodon', | |
| 328 | + 'label' => esc_html__( 'Mastodon', 'jetpack' ), | |
| 329 | + ), | |
| 330 | + ), | |
| 331 | + ); | |
| 332 | + | |
| 333 | + // Wrap inner blocks in our sharing buttons markup. | |
| 334 | + $parsed_hooked_block['innerContent'] = array( | |
| 335 | + '<ul class="wp-block-jetpack-sharing-buttons has-normal-icon-size jetpack-sharing-buttons__services-list" id="jetpack-sharing-serivces-list">', | |
| 336 | + null, | |
| 337 | + null, | |
| 338 | + null, | |
| 339 | + '</ul>', | |
| 340 | + ); | |
| 341 | + | |
| 342 | + // Wrap the whole thing in a group block. | |
| 343 | + return array( | |
| 344 | + 'blockName' => 'core/group', | |
| 345 | + 'attrs' => array( | |
| 346 | + // Does the anchor block have a layout attribute? If so, use it in the group to maintain the same alignment. | |
| 347 | + 'layout' => $parsed_anchor_block['attrs']['layout'] ?? 'null', | |
| 348 | + ), | |
| 349 | + 'innerBlocks' => array( $parsed_hooked_block ), | |
| 350 | + 'innerContent' => array( | |
| 351 | + '<div class="wp-block-group">', | |
| 352 | + null, | |
| 353 | + '</div>', | |
| 354 | + ), | |
| 355 | + ); | |
| 356 | +} | |