$link
";
if ( $echo ) {
echo $return; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- we escape things above.
}
return $return;
}
/**
* Get sharing stats for a specific post or sharing service.
*
* @param bool|WP_Post $post Post object.
*
* @return int
*/
public function get_total( $post = false ) {
global $wpdb, $blog_id;
$name = strtolower( $this->get_id() );
if ( $post === false ) {
// get total number of shares for service
return (int) $wpdb->get_var( $wpdb->prepare( 'SELECT SUM( count ) FROM sharing_stats WHERE blog_id = %d AND share_service = %s', $blog_id, $name ) );
}
// get total shares for a post
return (int) $wpdb->get_var( $wpdb->prepare( 'SELECT count FROM sharing_stats WHERE blog_id = %d AND post_id = %d AND share_service = %s', $blog_id, $post->ID, $name ) );
}
/**
* Get sharing stats for all posts on the site.
*
* @return array
*/
public function get_posts_total() {
global $wpdb, $blog_id;
$totals = array();
$name = strtolower( $this->get_id() );
$my_data = $wpdb->get_results( $wpdb->prepare( 'SELECT post_id as id, SUM( count ) as total FROM sharing_stats WHERE blog_id = %d AND share_service = %s GROUP BY post_id ORDER BY count DESC ', $blog_id, $name ) );
if ( ! empty( $my_data ) ) {
foreach ( $my_data as $row ) {
$totals[] = new Sharing_Post_Total( $row->id, $row->total );
}
}
usort( $totals, array( 'Sharing_Post_Total', 'cmp' ) );
return $totals;
}
/**
* Process sharing request. Add actions that need to happen when sharing here.
*
* @param WP_Post $post Post object.
* @param array $post_data Array of information about the post we're sharing.
*
* @return void
*/
public function process_request( $post, array $post_data ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
/**
* Fires when a post is shared via one of the sharing buttons.
*
* @module sharedaddy
*
* @since 1.1.0
*
* @param array $args Aray of information about the sharing service.
*/
do_action(
'sharing_bump_stats',
array(
'service' => $this,
'post' => $post,
)
);
}
/**
* Redirect to an external social network site to finish sharing.
*
* @param string $url Sharing URL for a given service.
* @return never
*/
public function redirect_request( $url ) {
wp_redirect( $url ); // phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect -- We allow external redirects here; we define them ourselves.
// We set up this custom header to indicate to search engines not to index this page.
header( 'X-Robots-Tag: noindex, nofollow' );
die();
}
/**
* Add extra JavaScript to a sharing service.
*
* @param string $name Sharing service name.
* @param array $params Array of sharing options.
*
* @return void
*/
public function js_dialog( $name, $params = array() ) {
if ( true !== $this->open_link_in_new ) {
return;
}
$defaults = array(
'menubar' => 1,
'resizable' => 1,
'width' => 600,
'height' => 400,
);
$params = array_merge( $defaults, $params );
$opts = array();
foreach ( $params as $key => $val ) {
$opts[] = "$key=$val";
}
$opts = implode( ',', $opts );
// Add JS after sharing-js has been enqueued.
wp_add_inline_script(
'sharing-js',
"var windowOpen;
( function () {
function matches( el, sel ) {
return !! (
el.matches && el.matches( sel ) ||
el.msMatchesSelector && el.msMatchesSelector( sel )
);
}
document.body.addEventListener( 'click', function ( event ) {
if ( ! event.target ) {
return;
}
var el;
if ( matches( event.target, 'a.share-$name' ) ) {
el = event.target;
} else if ( event.target.parentNode && matches( event.target.parentNode, 'a.share-$name' ) ) {
el = event.target.parentNode;
}
if ( el ) {
event.preventDefault();
// If there's another sharing window open, close it.
if ( typeof windowOpen !== 'undefined' ) {
windowOpen.close();
}
windowOpen = window.open( el.getAttribute( 'href' ), 'wpcom$name', '$opts' );
return false;
}
} );
} )();"
);
}
}
/**
* Handle the display of deprecated sharing services.
*/
abstract class Deprecated_Sharing_Source extends Sharing_Source {
/**
* Button style (icon-text, icon, or text)
*
* @var string
*/
public $button_style = 'text';
/**
* Does the service have an official version.
*
* @var bool
*/
public $smart = false;
/**
* Should the sharing link open in a new tab.
*
* @var bool
*/
protected $open_link_in_new = false;
/**
* Sharing unique ID.
*
* @var int
*/
protected $id;
/**
* Is the service deprecated.
*
* @var bool
*/
protected $deprecated = true;
/**
* Constructor.
*
* @param int $id Sharing source ID.
* @param array $settings Sharing settings.
*/
final public function __construct( $id, array $settings ) {
$this->id = $id;
if ( isset( $settings['button_style'] ) ) {
$this->button_style = $settings['button_style'];
}
}
/**
* Is the service deprecated.
*
* @return bool
*/
final public function is_deprecated() {
return true;
}
/**
* Get a post's permalink to use for sharing.
*
* @param int $post_id Post ID.
*
* @return string
*/
final public function get_share_url( $post_id ) {
return get_permalink( $post_id );
}
/**
* No AMP display for deprecated sources.
*
* @param \WP_Post $post The current post being viewed.
*/
final public function get_amp_display( $post ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
return false;
}
/**
* Display a preview of the sharing button.
*
* @param bool $echo Whether to echo the output or return it.
* @param bool $force_smart Whether to force the smart (official) services to be shown.
* @param null|string $button_style Button style.
*
* @return string|void
*/
final public function display_preview( $echo = true, $force_smart = false, $button_style = null ) {
return parent::display_preview( $echo, false, $button_style );
}
/**
* Get sharing stats for a specific post or sharing service.
*
* @param bool|WP_Post $post Post object.
*
* @return int
*/
final public function get_total( $post = false ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
return 0;
}
/**
* Get sharing stats for all posts on the site.
*
* @return int|array
*/
final public function get_posts_total() {
return 0;
}
/**
* Process sharing request. Add actions that need to happen when sharing here.
*
* @param WP_Post $post Post object.
* @param array $post_data Array of information about the post we're sharing.
*
* @return void
*/
final public function process_request( $post, array $post_data ) { // phpcs:ignore Generic.CodeAnalysis.UselessOverridingMethod.Found
parent::process_request( $post, $post_data );
}
/**
* Get the markup of the sharing button.
*
* @param WP_Post $post Post object.
*
* @return string
*/
final public function get_display( $post ) {
if ( current_user_can( 'manage_options' ) ) {
return $this->display_deprecated( $post );
}
return '';
}
/**
* Display a custom message for deprecated services.
*
* @param WP_Post $post Post object.
*
* @return string
*/
public function display_deprecated( $post ) {
return $this->get_link(
$this->get_share_url( $post->ID ),
/* translators: %1$s is the name of a deprecated Sharing Service like "Google+" */
sprintf( __( '%1$s is no longer supported', 'jetpack' ), $this->get_name() ),
/* translators: %1$s is the name of a deprecated Sharing Service like "Google+" */
sprintf( __( 'The %1$s sharing service has shut down or discontinued support for sharing buttons. This sharing button is not displayed to your visitors and should be removed.', 'jetpack' ), $this->get_name() )
);
}
}
/**
* Handle the display of advanced sharing services.
* Custom sharing buttons we create ourselves will be such services.
*/
abstract class Sharing_Advanced_Source extends Sharing_Source {
/**
* Does the service have advanced options.
*
* @return bool
*/
public function has_advanced_options() {
return true;
}
/**
* Display options for our sharing buttons.
*/
abstract public function display_options();
/**
* Sanitize and save options for our sharing buttons.
*
* @param array $data Data to be saved.
*
* @return void
*/
abstract public function update_options( array $data );
/**
* Get array of information about the service.
*
* @return array
*/
abstract public function get_options();
}
/**
* Handle the display of the email sharing button.
*/
class Share_Email extends Sharing_Source {
/**
* Service short name.
*
* @var string
*/
public $shortname = 'email';
/**
* Service icon font code.
*
* @var string
*/
public $icon = '\f410';
/**
* Constructor.
*
* @param int $id Sharing source ID.
* @param array $settings Sharing settings.
*/
public function __construct( $id, array $settings ) {
parent::__construct( $id, $settings );
if ( 'official' === $this->button_style ) {
$this->smart = true;
} else {
$this->smart = false;
}
}
/**
* Service name.
*
* @return string
*/
public function get_name() {
return _x( 'Email', 'as sharing source', 'jetpack' );
}
/**
* Helper function to return a nonce action based on the current post.
*
* @param WP_Post|null $post The current post if it is defined.
* @return string The nonce action name.
*/
protected function get_email_share_nonce_action( $post ) {
if ( ! empty( $post ) && $post instanceof WP_Post ) {
return 'jetpack-email-share-' . $post->ID;
}
return 'jetpack-email-share';
}
/**
* Process sharing request. Add actions that need to happen when sharing here.
*
* @param WP_Post $post Post object.
* @param array $post_data Array of information about the post we're sharing.
*
* @return void
*/
public function process_request( $post, array $post_data ) {
$is_ajax = false;
if (
isset( $_SERVER['HTTP_X_REQUESTED_WITH'] )
&& strtolower( sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_REQUESTED_WITH'] ) ) ) === 'xmlhttprequest'
) {
$is_ajax = true;
}
// Require an AJAX-driven submit and a valid nonce to process the request
if (
$is_ajax
&& isset( $post_data['email-share-nonce'] )
&& wp_verify_nonce( $post_data['email-share-nonce'], $this->get_email_share_nonce_action( $post ) )
) {
// Ensure that we bump stats
parent::process_request( $post, $post_data );
}
if ( $is_ajax ) {
wp_send_json_success();
} else {
wp_safe_redirect( get_permalink( $post->ID ) . '?shared=email&msg=fail' );
exit;
}
wp_die();
}
/**
* Get the markup of the sharing button.
*
* @param WP_Post $post Post object.
*
* @return string The HTML for the button.
*/
public function get_display( $post ) {
$tracking_url = $this->get_process_request_url( $post->ID );
if ( false === stripos( $tracking_url, '?' ) ) {
$tracking_url .= '?';
} else {
$tracking_url .= '&';
}
$tracking_url .= 'share=email';
$data_attributes = array(
'email-share-error-title' => __( 'Do you have email set up?', 'jetpack' ),
'email-share-error-text' => __(
"If you're having problems sharing via email, you might not have email set up for your browser. You may need to create a new email yourself.",
'jetpack'
),
'email-share-nonce' => wp_create_nonce( $this->get_email_share_nonce_action( $post ) ),
'email-share-track-url' => $tracking_url,
);
$post_title = $this->get_share_title( $post->ID );
$post_url = $this->get_share_url( $post->ID );
/** This filter is documented in plugins/jetpack/modules/sharedaddy/sharedaddy.php */
$email_subject = apply_filters(
'wp_sharing_email_send_post_subject',
sprintf( '[%s] %s', __( 'Shared Post', 'jetpack' ), $post_title )
);
$mailto_query = sprintf(
'subject=%s&body=%s&share=email',
rawurlencode( $email_subject ),
rawurlencode( $post_url )
);
return $this->get_link(
'mailto:',
_x( 'Email', 'share to', 'jetpack' ),
__( 'Click to email a link to a friend', 'jetpack' ),
$mailto_query,
false,
$data_attributes
);
}
/**
* AMP display for email.
*
* @param \WP_Post $post The current post being viewed.
*/
public function get_amp_display( $post ) { // phpcs:ignore
$attrs = array(
// Prevents an empty window from opening on desktop: https://github.com/ampproject/amphtml/issues/9157.
'data-target' => '_self',
);
return $this->build_amp_markup( $attrs );
}
}
/**
* Twitter sharing button.
*/
class Share_Twitter extends Sharing_Source {
/**
* Service short name.
*
* @var string
*/
public $shortname = 'twitter';
/**
* Service icon font code.
*
* @var string
*/
public $icon = '\f202';
/**
* Length of a URL on Twitter.
* 'https://dev.twitter.com/rest/reference/get/help/configuration'
* ( 2015/02/06 ) short_url_length is 22, short_url_length_https is 23
*
* @var int
*/
public $short_url_length = 24;
/**
* Constructor.
*
* @param int $id Sharing source ID.
* @param array $settings Sharing settings.
*/
public function __construct( $id, array $settings ) {
parent::__construct( $id, $settings );
if ( 'official' === $this->button_style ) {
$this->smart = true;
} else {
$this->smart = false;
}
}
/**
* Service name.
*
* @return string
*/
public function get_name() {
return __( 'Twitter', 'jetpack' );
}
/**
* Determine the Twitter 'via' value for a post.
*
* @param WP_Post|int $post Post object or post ID.
* @return string Twitter handle without the preceding @.
**/
public static function sharing_twitter_via( $post ) {
$post = get_post( $post );
/**
* Allow third-party plugins to customize the Twitter username used as "twitter:site" Twitter Card Meta Tag.
*
* @module sharedaddy
*
* @since 3.0.0
*
* @param string $string Twitter Username.
* @param array $args Array of Open Graph Meta Tags and Twitter Cards tags.
*/
$twitter_site_tag_value = apply_filters(
'jetpack_twitter_cards_site_tag',
'',
/** This action is documented in modules/sharedaddy/sharing-sources.php */
array( 'twitter:creator' => apply_filters( 'jetpack_sharing_twitter_via', '', $post->ID ) )
);
/*
* Hack to remove the unwanted behavior of adding 'via @jetpack' which
* was introduced with the adding of the Twitter cards.
* This should be a temporary solution until a better method is setup.
*/
if ( 'jetpack' === $twitter_site_tag_value ) {
$twitter_site_tag_value = '';
}
/**
* Filters the Twitter username used as "via" in the Twitter sharing button.
*
* @module sharedaddy
*
* @since 1.7.0
*
* @param string $twitter_site_tag_value Twitter Username.
* @param int $post->ID Post ID.
*/
$twitter_site_tag_value = apply_filters( 'jetpack_sharing_twitter_via', $twitter_site_tag_value, $post->ID );
// Strip out anything other than a letter, number, or underscore.
// This will prevent the inadvertent inclusion of an extra @, as well as normalizing the handle.
return preg_replace( '/[^\da-z_]+/i', '', $twitter_site_tag_value );
}
/**
* Determine the 'related' Twitter accounts for a post.
*
* @param WP_Post|int $post Post object or post ID.
* @return string Comma-separated list of Twitter handles.
**/
public static function get_related_accounts( $post ) {
$post = get_post( $post );
/**
* Filter the list of related Twitter accounts added to the Twitter sharing button.
*
* @module sharedaddy
*
* @since 1.7.0
*
* @param array $args Array of Twitter usernames. Format is 'username' => 'Optional description'
* @param int $post->ID Post ID.
*/
$related_accounts = apply_filters( 'jetpack_sharing_twitter_related', array(), $post->ID );
// Example related string: account1,account2:Account 2 description,account3
$related = array();
foreach ( $related_accounts as $related_account_username => $related_account_description ) {
// Join the description onto the end of the username
if ( $related_account_description ) {
$related_account_username .= ':' . $related_account_description;
}
$related[] = $related_account_username;
}
return implode( ',', $related );
}
/**
* Get the markup of the sharing button.
*
* @param WP_Post $post Post object.
*
* @return string
*/
public function get_display( $post ) {
$via = static::sharing_twitter_via( $post );
if ( $via ) {
$via = 'data-via="' . esc_attr( $via ) . '"';
} else {
$via = '';
}
$related = static::get_related_accounts( $post );
if ( ! empty( $related ) && $related !== $via ) {
$related = 'data-related="' . esc_attr( $related ) . '"';
} else {
$related = '';
}
if ( $this->smart ) {
$share_url = $this->get_share_url( $post->ID );
$post_title = $this->get_share_title( $post->ID );
return sprintf(
'Tweet',
esc_url( $share_url ),
esc_attr( $post_title ),
$via,
$related
);
} else {
if (
/**
* Allow plugins to disable sharing counts for specific sharing services.
*
* @module sharedaddy
*
* @since 3.0.0
*
* @param bool true Should sharing counts be enabled for this specific service. Default to true.
* @param int $post->ID Post ID.
* @param string $str Sharing service name.
*/
apply_filters( 'jetpack_register_post_for_share_counts', true, $post->ID, 'twitter' )
) {
sharing_register_post_for_share_counts( $post->ID );
}
return $this->get_link( $this->get_process_request_url( $post->ID ), _x( 'Twitter', 'share to', 'jetpack' ), __( 'Click to share on Twitter', 'jetpack' ), 'share=twitter', 'sharing-twitter-' . $post->ID );
}
}
/**
* Process sharing request. Add actions that need to happen when sharing here.
*
* @param WP_Post $post Post object.
* @param array $post_data Array of information about the post we're sharing.
*
* @return void
*/
public function process_request( $post, array $post_data ) {
$post_title = $this->get_share_title( $post->ID );
$post_link = $this->get_share_url( $post->ID );
if ( function_exists( 'mb_stripos' ) ) {
$strlen = 'mb_strlen';
$substr = 'mb_substr';
} else {
$strlen = 'strlen';
$substr = 'substr';
}
$via = static::sharing_twitter_via( $post );
$related = static::get_related_accounts( $post );
if ( $via ) {
$sig = " via @$via";
if ( $related === $via ) {
$related = false;
}
} else {
$via = false;
$sig = '';
}
$suffix_length = $this->short_url_length + $strlen( $sig );
// $sig is handled by twitter in their 'via' argument.
// $post_link is handled by twitter in their 'url' argument.
if ( 280 < $strlen( $post_title ) + $suffix_length ) {
// The -1 is for "\xE2\x80\xA6", a UTF-8 ellipsis.
$text = $substr( $post_title, 0, 280 - $suffix_length - 1 ) . "\xE2\x80\xA6";
} else {
$text = $post_title;
}
// Record stats
parent::process_request( $post, $post_data );
$url = $post_link;
$twitter_url = add_query_arg(
rawurlencode_deep( array_filter( compact( 'via', 'related', 'text', 'url' ) ) ),
'https://twitter.com/intent/tweet'
);
parent::redirect_request( $twitter_url );
}
/**
* Does this sharing source have a custom style.
*
* @return bool
*/
public function has_custom_button_style() {
return $this->smart;
}
/**
* Add content specific to a service in the footer.
*/
public function display_footer() {
if ( $this->smart ) {
?>
js_dialog( $this->shortname, array( 'height' => 350 ) );
}
}
}
/**
* X sharing button.
*
* While the old Twitter button had an official button,
* this new X button does not, since there is no official X button yet.
*/
class Share_X extends Sharing_Source {
/**
* Service short name.
*
* @var string
*/
public $shortname = 'x';
/**
* Service icon font code.
*
* @var string
*/
public $icon = '\f10e';
/**
* Length of a URL on X.
* https://developer.twitter.com/en/docs/tco
*
* @var int
*/
public $short_url_length = 24;
/**
* Constructor.
*
* @param int $id Sharing source ID.
* @param array $settings Sharing settings.
*/
public function __construct( $id, array $settings ) {
parent::__construct( $id, $settings );
if ( 'official' === $this->button_style ) {
$this->smart = true;
} else {
$this->smart = false;
}
}
/**
* Service name.
*
* @return string
*/
public function get_name() {
return __( 'X', 'jetpack' );
}
/**
* Get the markup of the sharing button.
*
* @param WP_Post $post Post object.
*
* @return string
*/
public function get_display( $post ) {
$via = static::sharing_x_via( $post );
if ( $via ) {
$via = 'data-via="' . esc_attr( $via ) . '"';
} else {
$via = '';
}
$related = static::get_related_accounts( $post );
if ( ! empty( $related ) && $related !== $via ) {
$related = 'data-related="' . esc_attr( $related ) . '"';
} else {
$related = '';
}
if ( $this->smart ) {
$share_url = $this->get_share_url( $post->ID );
$post_title = $this->get_share_title( $post->ID );
return sprintf(
'%5$s',
esc_url( $share_url ),
esc_attr( $post_title ),
$via,
$related,
esc_html__( 'Post', 'jetpack' )
);
} else {
if (
/** This filter is documented in modules/sharedaddy/sharing-sources.php */
apply_filters( 'jetpack_register_post_for_share_counts', true, $post->ID, 'x' )
) {
sharing_register_post_for_share_counts( $post->ID );
}
return $this->get_link(
$this->get_process_request_url( $post->ID ),
_x( 'X', 'share to', 'jetpack' ),
__( 'Click to share on X', 'jetpack' ),
'share=x',
'sharing-x-' . $post->ID
);
}
}
/**
* Determine the X 'via' value for a post.
*
* @param WP_Post|int $post Post object or post ID.
* @return string X handle without the preceding @.
**/
public static function sharing_x_via( $post ) {
$post = get_post( $post );
/** This filter is documented in modules/sharedaddy/sharing-sources.php */
$twitter_site_tag_value = apply_filters(
'jetpack_twitter_cards_site_tag',
'',
/** This action is documented in modules/sharedaddy/sharing-sources.php */
array( 'twitter:creator' => apply_filters( 'jetpack_sharing_twitter_via', '', $post->ID ) )
);
/*
* Hack to remove the unwanted behavior of adding 'via @jetpack' which
* was introduced with the adding of the Twitter cards.
* This should be a temporary solution until a better method is setup.
*/
if ( 'jetpack' === $twitter_site_tag_value ) {
$twitter_site_tag_value = '';
}
/** This filter is documented in modules/sharedaddy/sharing-sources.php */
$twitter_site_tag_value = apply_filters( 'jetpack_sharing_twitter_via', $twitter_site_tag_value, $post->ID );
// Strip out anything other than a letter, number, or underscore.
// This will prevent the inadvertent inclusion of an extra @, as well as normalizing the handle.
return preg_replace( '/[^\da-z_]+/i', '', $twitter_site_tag_value );
}
/**
* Determine the 'related' X accounts for a post.
*
* @param WP_Post|int $post Post object or post ID.
* @return string Comma-separated list of X handles.
**/
public static function get_related_accounts( $post ) {
$post = get_post( $post );
/** This filter is documented in modules/sharedaddy/sharing-sources.php */
$related_accounts = apply_filters( 'jetpack_sharing_twitter_related', array(), $post->ID );
// Example related string: account1,account2:Account 2 description,account3
$related = array();
foreach ( $related_accounts as $related_account_username => $related_account_description ) {
// Join the description onto the end of the username
if ( $related_account_description ) {
$related_account_username .= ':' . $related_account_description;
}
$related[] = $related_account_username;
}
return implode( ',', $related );
}
/**
* Add content specific to a service in the footer.
*/
public function display_footer() {
if ( $this->smart ) {
?>
js_dialog( $this->shortname, array( 'height' => 350 ) );
}
}
/**
* Process sharing request. Add actions that need to happen when sharing here.
*
* @param WP_Post $post Post object.
* @param array $post_data Array of information about the post we're sharing.
*
* @return void
*/
public function process_request( $post, array $post_data ) {
$post_title = $this->get_share_title( $post->ID );
$post_link = $this->get_share_url( $post->ID );
if ( function_exists( 'mb_stripos' ) ) {
$strlen = 'mb_strlen';
$substr = 'mb_substr';
} else {
$strlen = 'strlen';
$substr = 'substr';
}
$via = static::sharing_x_via( $post );
$related = static::get_related_accounts( $post );
if ( $via ) {
$sig = " via @$via";
if ( $related === $via ) {
$related = false;
}
} else {
$via = false;
$sig = '';
}
$suffix_length = $this->short_url_length + $strlen( $sig );
// $sig is handled by twitter in their 'via' argument.
// $post_link is handled by twitter in their 'url' argument.
if ( 280 < $strlen( $post_title ) + $suffix_length ) {
// The -1 is for "\xE2\x80\xA6", a UTF-8 ellipsis.
$text = $substr( $post_title, 0, 280 - $suffix_length - 1 ) . "\xE2\x80\xA6";
} else {
$text = $post_title;
}
// Record stats
parent::process_request( $post, $post_data );
$url = $post_link;
$twitter_url = add_query_arg(
rawurlencode_deep( array_filter( compact( 'via', 'related', 'text', 'url' ) ) ),
'https://x.com/intent/tweet'
);
parent::redirect_request( $twitter_url );
}
/**
* Does this sharing source have a custom style.
*
* @return bool
*/
public function has_custom_button_style() {
return $this->smart;
}
}
/**
* Reddit sharing button.
*/
class Share_Reddit extends Sharing_Source {
/**
* Service short name.
*
* @var string
*/
public $shortname = 'reddit';
/**
* Service icon font code.
*
* @var string
*/
public $icon = '\f222';
/**
* Service name.
*
* @return string
*/
public function get_name() {
return __( 'Reddit', 'jetpack' );
}
/**
* Get the markup of the sharing button.
*
* @param WP_Post $post Post object.
*
* @return string
*/
public function get_display( $post ) {
return $this->get_link(
$this->get_process_request_url( $post->ID ),
_x( 'Reddit', 'share to', 'jetpack' ),
__( 'Click to share on Reddit', 'jetpack' ),
'share=reddit'
);
}
/**
* AMP display for Reddit.
*
* @param \WP_Post $post The current post being viewed.
*/
public function get_amp_display( $post ) {
$attrs = array(
'data-share-endpoint' => esc_url_raw( 'https://reddit.com/submit?url=' . rawurlencode( $this->get_share_url( $post->ID ) ) . '&title=' . rawurlencode( $this->get_share_title( $post->ID ) ) ),
);
return $this->build_amp_markup( $attrs );
}
/**
* Process sharing request. Add actions that need to happen when sharing here.
*
* @param WP_Post $post Post object.
* @param array $post_data Array of information about the post we're sharing.
*
* @return void
*/
public function process_request( $post, array $post_data ) {
$reddit_url = $this->http() . '://reddit.com/submit?url=' . rawurlencode( $this->get_share_url( $post->ID ) ) . '&title=' . rawurlencode( $this->get_share_title( $post->ID ) );
// Record stats
parent::process_request( $post, $post_data );
parent::redirect_request( $reddit_url );
}
}
/**
* LinkedIn sharing button.
*/
class Share_LinkedIn extends Sharing_Source {
/**
* Service short name.
*
* @var string
*/
public $shortname = 'linkedin';
/**
* Service icon font code.
*
* @var string
*/
public $icon = '\f207';
/**
* Constructor.
*
* @param int $id Sharing source ID.
* @param array $settings Sharing settings.
*/
public function __construct( $id, array $settings ) {
parent::__construct( $id, $settings );
if ( 'official' === $this->button_style ) {
$this->smart = true;
} else {
$this->smart = false;
}
}
/**
* Service name.
*
* @return string
*/
public function get_name() {
return __( 'LinkedIn', 'jetpack' );
}
/**
* Does this sharing source have a custom style.
*
* @return bool
*/
public function has_custom_button_style() {
return $this->smart;
}
/**
* Get the markup of the sharing button.
*
* @param WP_Post $post Post object.
*
* @return string
*/
public function get_display( $post ) {
$display = '';
if ( $this->smart ) {
$share_url = $this->get_share_url( $post->ID );
$display .= sprintf( '', esc_url( $share_url ) );
} else {
$display = $this->get_link( $this->get_process_request_url( $post->ID ), _x( 'LinkedIn', 'share to', 'jetpack' ), __( 'Click to share on LinkedIn', 'jetpack' ), 'share=linkedin', 'sharing-linkedin-' . $post->ID );
}
/** This filter is already documented in modules/sharedaddy/sharing-sources.php */
if ( apply_filters( 'jetpack_register_post_for_share_counts', true, $post->ID, 'linkedin' ) ) {
sharing_register_post_for_share_counts( $post->ID );
}
return $display;
}
/**
* Process sharing request. Add actions that need to happen when sharing here.
*
* @param WP_Post $post Post object.
* @param array $post_data Array of information about the post we're sharing.
*
* @return void
*/
public function process_request( $post, array $post_data ) {
$post_link = $this->get_share_url( $post->ID );
// Using the same URL as the official button, which is *not* LinkedIn's documented sharing link
// https://www.linkedin.com/cws/share?url={url}&token=&isFramed=false
$linkedin_url = add_query_arg(
array(
'url' => rawurlencode( $post_link ),
),
'https://www.linkedin.com/cws/share?token=&isFramed=false'
);
// Record stats
parent::process_request( $post, $post_data );
parent::redirect_request( $linkedin_url );
}
/**
* Add content specific to a service in the footer.
*/
public function display_footer() {
if ( ! $this->smart ) {
$this->js_dialog(
$this->shortname,
array(
'width' => 580,
'height' => 450,
)
);
} else {
?>
share_type = $settings['share_type'];
}
if ( 'official' === $this->button_style ) {
$this->smart = true;
} else {
$this->smart = false;
}
}
/**
* Service name.
*
* @return string
*/
public function get_name() {
return __( 'Facebook', 'jetpack' );
}
/**
* Add content specific to a service in the head.
*/
public function display_header() {
}
/**
* Guess locale from language code.
*
* @param string $lang Language code.
*
* @return string|bool
*/
public function guess_locale_from_lang( $lang ) {
if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
return 'en_US';
}
if ( ! class_exists( 'GP_Locales' ) ) {
if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
return false;
}
require JETPACK__GLOTPRESS_LOCALES_PATH;
}
if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
// WP.com: get_locale() returns 'it'
$locale = GP_Locales::by_slug( $lang );
} else {
// Jetpack: get_locale() returns 'it_IT';
$locale = GP_Locales::by_field( 'wp_locale', $lang );
}
if ( ! $locale ) {
return false;
}
if ( empty( $locale->facebook_locale ) ) {
if ( empty( $locale->wp_locale ) ) {
return false;
} else {
// Facebook SDK is smart enough to fall back to en_US if a
// locale isn't supported. Since supported Facebook locales
// can fall out of sync, we'll attempt to use the known
// wp_locale value and rely on said fallback.
return $locale->wp_locale;
}
}
return $locale->facebook_locale;
}
/**
* Get the markup of the sharing button.
*
* @param WP_Post $post Post object.
*
* @return string
*/
public function get_display( $post ) {
if ( $this->smart ) {
$share_url = $this->get_share_url( $post->ID );
$fb_share_html = '';
/**
* Filter the output of the Facebook Sharing button.
*
* @module sharedaddy
*
* @since 3.6.0
*
* @param string $fb_share_html Facebook Sharing button HTML.
* @param string $share_url URL of the post to share.
*/
return apply_filters( 'jetpack_sharing_facebook_official_button_output', $fb_share_html, $share_url );
}
/** This filter is already documented in modules/sharedaddy/sharing-sources.php */
if ( apply_filters( 'jetpack_register_post_for_share_counts', true, $post->ID, 'facebook' ) ) {
sharing_register_post_for_share_counts( $post->ID );
}
return $this->get_link( $this->get_process_request_url( $post->ID ), _x( 'Facebook', 'share to', 'jetpack' ), __( 'Click to share on Facebook', 'jetpack' ), 'share=facebook', 'sharing-facebook-' . $post->ID );
}
/**
* AMP display for Facebook.
*
* @param \WP_Post $post The current post being viewed.
*/
public function get_amp_display( $post ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
$attrs = array(
/** This filter is documented in modules/sharedaddy/sharing-sources.php */
'data-param-app_id' => apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' ),
);
return $this->build_amp_markup( $attrs );
}
/**
* Process sharing request. Add actions that need to happen when sharing here.
*
* @param WP_Post $post Post object.
* @param array $post_data Array of information about the post we're sharing.
*
* @return void
*/
public function process_request( $post, array $post_data ) {
$fb_url = $this->http() . '://www.facebook.com/sharer.php?u=' . rawurlencode( $this->get_share_url( $post->ID ) ) . '&t=' . rawurlencode( $this->get_share_title( $post->ID ) );
// Record stats
parent::process_request( $post, $post_data );
parent::redirect_request( $fb_url );
}
/**
* Add content specific to a service in the footer.
*/
public function display_footer() {
$this->js_dialog( $this->shortname );
if ( $this->smart ) {
$locale = $this->guess_locale_from_lang( get_locale() );
if ( ! $locale ) {
$locale = 'en_US';
}
/**
* Filter the App ID used in the official Facebook Share button.
*
* @since 3.8.0
*
* @param int $fb_app_id Facebook App ID. Default to 249643311490 (WordPress.com's App ID).
*/
$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
if ( is_numeric( $fb_app_id ) ) {
$fb_app_id = '&appId=' . $fb_app_id;
} else {
$fb_app_id = '';
}
?>
button_style ) {
$this->smart = true;
} else {
$this->smart = false;
}
}
/**
* Service name.
*
* @return string
*/
public function get_name() {
return __( 'Print', 'jetpack' );
}
/**
* Get the markup of the sharing button.
*
* @param WP_Post $post Post object.
*
* @return string
*/
public function get_display( $post ) {
return $this->get_link( $this->get_process_request_url( $post->ID ) . ( ( is_single() || is_page() ) ? '#print' : '' ), _x( 'Print', 'share to', 'jetpack' ), __( 'Click to print', 'jetpack' ) );
}
/**
* AMP display for Print.
*
* @param \WP_Post $post The current post being viewed.
*/
public function get_amp_display( $post ) {
if ( empty( $post ) ) {
return false;
}
return '';
}
}
/**
* Press This Button.
*/
class Share_PressThis extends Sharing_Source {
/**
* Service short name.
*
* @var string
*/
public $shortname = 'pressthis';
/**
* Service icon font code.
*
* @var string
*/
public $icon = '\f205';
/**
* Constructor.
*
* @param int $id Sharing source ID.
* @param array $settings Sharing settings.
*/
public function __construct( $id, array $settings ) {
parent::__construct( $id, $settings );
if ( 'official' === $this->button_style ) {
$this->smart = true;
} else {
$this->smart = false;
}
}
/**
* Service name.
*
* @return string
*/
public function get_name() {
return __( 'Press This', 'jetpack' );
}
/**
* Process sharing request. Add actions that need to happen when sharing here.
*
* @param WP_Post $post Post object.
* @param array $post_data Array of information about the post we're sharing.
*
* @return void
*/
public function process_request( $post, array $post_data ) {
global $current_user;
$primary_blog = (int) get_user_meta( $current_user->ID, 'primary_blog', true );
if ( $primary_blog ) {
$primary_blog_details = get_blog_details( $primary_blog );
} else {
$primary_blog_details = false;
}
if ( $primary_blog_details ) {
$blogs = array( $primary_blog_details );
} elseif ( function_exists( 'get_active_blogs_for_user' ) ) {
$blogs = get_active_blogs_for_user();
if ( empty( $blogs ) ) {
$blogs = get_blogs_of_user( $current_user->ID );
}
} else {
$blogs = get_blogs_of_user( $current_user->ID );
}
if ( empty( $blogs ) ) {
wp_safe_redirect( get_permalink( $post->ID ) );
die();
}
$blog = current( $blogs );
$args = array(
'u' => rawurlencode( $this->get_share_url( $post->ID ) ),
);
$args['url-scan-submit'] = 'Scan';
$args['_wpnonce'] = wp_create_nonce( 'scan-site' );
$url = $blog->siteurl . '/wp-admin/press-this.php';
$url = add_query_arg( $args, $url );
// Record stats
parent::process_request( $post, $post_data );
parent::redirect_request( $url );
}
/**
* Get the markup of the sharing button.
*
* @param WP_Post $post Post object.
*
* @return string
*/
public function get_display( $post ) {
return $this->get_link( $this->get_process_request_url( $post->ID ), _x( 'Press This', 'share to', 'jetpack' ), __( 'Click to Press This!', 'jetpack' ), 'share=press-this' );
}
/**
* No AMP display for PressThis.
*
* @param \WP_Post $post The current post being viewed.
*/
public function get_amp_display( $post ) { // phpcs:ignore
return false;
}
}
/**
* Custom (user-defined) sharing button.
*/
class Share_Custom extends Sharing_Advanced_Source {
/**
* Sharing service name.
*
* @var string
*/
private $name;
/**
* Sharing icon.
*
* @var string
*/
private $icon;
/**
* Sharing service URL.
*
* @var string
*/
private $url;
/**
* Does the service have an official version.
*
* @var bool
*/
public $smart = true;
/**
* Service short name.
*
* @var string
*/
public $shortname;
/**
* Custom sharing class.
*
* @return string
*/
public function get_class() {
return 'custom share-custom-' . sanitize_html_class( strtolower( $this->name ) );
}
/**
* Constructor.
*
* @param int $id Sharing source ID.
* @param array $settings Sharing settings.
*/
public function __construct( $id, array $settings ) {
parent::__construct( $id, $settings );
if ( isset( $settings['name'] ) ) {
$this->name = $settings['name'];
$this->shortname = preg_replace( '/[^a-z0-9]*/', '', $settings['name'] );
}
if ( isset( $settings['icon'] ) ) {
$this->icon = $settings['icon'];
$new_icon = esc_url_raw( wp_specialchars_decode( $this->icon, ENT_QUOTES ) );
$i = 0;
while ( $new_icon !== $this->icon ) {
if ( $i > 5 ) {
$this->icon = false;
break;
} else {
$this->icon = $new_icon;
$new_icon = esc_url_raw( wp_specialchars_decode( $this->icon, ENT_QUOTES ) );
}
++$i;
}
}
if ( isset( $settings['url'] ) ) {
$this->url = $settings['url'];
}
}
/**
* Service name.
*
* @return string
*/
public function get_name() {
return $this->name;
}
/**
* Get the markup of the sharing button.
*
* @param WP_Post $post Post object.
*
* @return string
*/
public function get_display( $post ) {
$str = $this->get_link(
$this->get_process_request_url( $post->ID ),
esc_html( $this->name ),
sprintf(
/* Translators: placeholder is the name of a social network. */
__( 'Click to share on %s', 'jetpack' ),
esc_attr( $this->name )
),
'share=' . $this->id
);
return str_replace( '', 'icon ), '"' ) . '");' ) . '">', $str );
}
/**
* No AMP display for custom elements.
*
* @param \WP_Post $post The current post being viewed.
*/
public function get_amp_display( $post ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
return false;
}
/**
* Process sharing request. Add actions that need to happen when sharing here.
*
* @param WP_Post $post Post object.
* @param array $post_data Array of information about the post we're sharing.
*
* @return void
*/
public function process_request( $post, array $post_data ) {
$url = str_replace( '&', '&', $this->url );
$url = str_replace( '%post_id%', rawurlencode( $post->ID ), $url );
$url = str_replace( '%post_url%', rawurlencode( $this->get_share_url( $post->ID ) ), $url );
$url = str_replace( '%post_full_url%', rawurlencode( get_permalink( $post->ID ) ), $url );
$url = str_replace( '%post_title%', rawurlencode( $this->get_share_title( $post->ID ) ), $url );
$url = str_replace( '%home_url%', rawurlencode( home_url() ), $url );
$url = str_replace( '%post_slug%', rawurlencode( $post->post_name ), $url );
if ( strpos( $url, '%post_tags%' ) !== false ) {
$tags = get_the_tags( $post->ID );
$tagged = '';
if ( $tags ) {
$tagged_raw = array();
foreach ( $tags as $tag ) {
$tagged_raw[] = rawurlencode( $tag->name );
}
$tagged = implode( ',', $tagged_raw );
}
$url = str_replace( '%post_tags%', $tagged, $url );
}
if ( strpos( $url, '%post_excerpt%' ) !== false ) {
$url_excerpt = $post->post_excerpt;
if ( empty( $url_excerpt ) ) {
$url_excerpt = $post->post_content;
}
$url_excerpt = wp_strip_all_tags( strip_shortcodes( $url_excerpt ) );
$url_excerpt = wp_html_excerpt( $url_excerpt, 100 );
$url_excerpt = rtrim( preg_replace( '/[^ .]*$/', '', $url_excerpt ) );
$url = str_replace( '%post_excerpt%', rawurlencode( $url_excerpt ), $url );
}
// Record stats
parent::process_request( $post, $post_data );
parent::redirect_request( $url );
}
/**
* Display options for our sharing buttons.
*
* @return void
*/
public function display_options() {
?>
name = $name;
}
if ( $url ) {
$this->url = $url;
}
if ( $icon ) {
$this->icon = $icon;
}
}
/**
* Get array of information about the service.
*
* @return array
*/
public function get_options() {
return array(
'name' => $this->name,
'icon' => $this->icon,
'url' => $this->url,
);
}
/**
* Display a preview of the sharing button.
*
* @param bool $echo Whether to echo the output or return it.
* @param bool $force_smart Whether to force the smart (official) services to be shown.
* @param null|string $button_style Button style.
*
* @return void
*/
public function display_preview( $echo = true, $force_smart = false, $button_style = null ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
$opts = $this->get_options();
$text = ' ';
if ( ! $this->smart ) {
if ( $this->button_style !== 'icon' ) {
$text = $this->get_name();
}
}
$klasses = array( 'share-' . $this->shortname );
if ( $this->button_style === 'icon' || $this->button_style === 'icon-text' ) {
$klasses[] = 'share-icon';
}
if ( $this->button_style === 'icon' ) {
$text = '';
$klasses[] = 'no-text';
}
if ( $this->button_style === 'text' ) {
$klasses[] = 'no-icon';
}
$link = sprintf(
'%s',
esc_attr( implode( ' ', $klasses ) ),
esc_attr( $this->get_name() ),
addcslashes( esc_url_raw( $opts['icon'] ), '"' ),
esc_html( $text )
);
?>
