name = esc_html__( 'Pinterest', 'social-warfare' );
$this->cta = esc_html__( 'Pin', 'social-warfare' );
$this->key = 'pinterest';
$this->default = 'true';
$this->base_share_url = 'https://pinterest.com/pin/create/button/?url=';
$this->init_social_network();
}
/**
* Generate the API Share Count Request URL
*
* @since 1.0.0 | 06 APR 2018 | Created
* @access public
* @param string $url The permalink of the page or post for which to fetch share counts
* @return string $request_url The complete URL to be used to access share counts via the API
*/
public function get_api_link( $url ) {
return 'https://api.pinterest.com/v1/urls/count.json?url=' . $url;
}
/**
* Parse the response to get the share count
*
* @since 1.0.0 | 06 APR 2018 | Created
* @access public
* @param string $response The raw response returned from the API request
* @return int $total_activity The number of shares reported from the API
*/
public function parse_api_response( $response ) {
$response = preg_replace( '/^receiveCount\((.*)\)$/', "\\1", $response );
$response = json_decode( $response, true );
return isset( $response['count'] ) ? intval( $response['count'] ) : 0;
}
/**
* Create the HTML to display the share button
*
* @since 1.0.0
* @since 3.0.0 | 01 MAY 2018 | Re-wrote the function to a class method.
* @since 3.0.6 | 14 MAY 2018 | Appended $pinterest_username to $pinterest_description.
* @since 3.0.9 | 04 JUN 2018 | Updated the check for pinterest image.
* @since 4.5.0 | 26 JUL 2024 | Ensure proper escaping of HTML output
* @since 4.5.4 | 28 AUG 2024 | Fix Pinterest share button to include href for SEO while preserving onclick functionality.
* @access public
* @return array $panel_context Array of
* ['post_data'] => metadata about the post;
* ['shares'] => share count data
* ['options'] => swp_user_options
* @param bool $output If true, this will immediately echo its code rather than save it for later.
*/
public function render_HTML( $panel_context, $output = false ) {
/**
* The global array containing the admin's options as set on the Social
* Warfare admin options page.
*/
global $swp_user_options;
$options = $swp_user_options;
// The ID of the current WordPress post or page.
$post_id = $panel_context['post_data']['ID'];
/**
* The processed permalink for the current post. Since this passes
* through our SWP_Link_Manager::process_url() method it will have the
* Google Anaytlics UTM and link shortening applied (if those features
* are turned on in the options).
*/
$post_url = urlencode( urldecode( SWP_Link_Manager::process_url( $panel_context['post_data']['permalink'], 'pinterest', $post_id ) ) );
/**
* This meta or custom field is where the ID is stored for the image
* that the user has uploaded into the "Pinterest Image" spot. This will
* return an array of images ID's.
*/
$metabox_pinterest_image = get_post_meta( $post_id, 'swp_pinterest_image', false );
/**
* This conditonal will trigger if the user has uploaded an image into
* the "Pinterest Image" field.
*/
if ( false === empty( $metabox_pinterest_image ) && false !== $metabox_pinterest_image ) :
// If the user has uploaded multiple Pinterest images.
if ( count( $metabox_pinterest_image ) > 1 ) {
$pinterest_image = 'multiple';
// If the user has uploaded only one single Pinterest image.
} else {
$pinterest_image = wp_get_attachment_url( $metabox_pinterest_image[0] );
}
/**
* The user has not uploaded a designated Pinterest image, then we will
* check for fallback image conditions and use those if necessary.
*
* In this case, we'll attempt to use the post's designated featured
* image as the Pinterest image.
*/
elseif ( 'featured' === SWP_Utility::get_option( 'pinterest_fallback' ) ) :
$pinterest_image = wp_get_attachment_url( get_post_thumbnail_id( $post_id ) );
else :
$pinterest_image = '';
endif;
/**
* This section will get the Pinterest username if one is set in the
* admin options page. We will include this in the description when shared.
*/
$pinterest_username = '';
$pinterest_id = SWP_Utility::get_option( 'pinterest_id' );
if ( false === empty( $pinterest_id ) ) {
$pinterest_username = ' via @' . str_replace( '@', '', $pinterest_id );
}
// The post's title.
$title = str_replace( '|', '', wp_strip_all_tags( $panel_context['post_data']['post_title'] ) );
/**
* Check if the user has provided a description for the "Pinterest
* Description" field in the post meta boxes.
*/
$pinterest_description = get_post_meta( $post_id, 'swp_pinterest_description', true );
/**
* In some bizarre instances, the description was returned as an array
* even when the "true" parameter is provided as the third parameter in
* the get_post_meta() function above. If this is the case, we'll strip
* it out here and just grab the very first item returned in that array.
*/
if ( is_array( $pinterest_description ) && ! empty( $pinterest_description ) ) {
$pinterest_description = $pinterest_description[0];
// delete_post_meta( $post_id , 'swp_pinterest_description' );
update_post_meta( $post_id, 'swp_pinterest_description', $pinterest_description );
}
/**
* If no Pinterest description was provided, then we'll use the post
* title as the description.
*/
if ( empty( $pinterest_description ) ) {
$pinterest_description = $title;
}
$pinterest_username = self::get_via();
$pinterest_description = self::trim_pinterest_description( $pinterest_description, $pinterest_username );
/**
* Now that we've processed all of our variables, we'll proceed to put
* together the HTML for the button.
*
* If we have a designated Pinterest image, we'll start here...
*/
if ( ! empty( $pinterest_image ) ) {
// If the user has uploaded multiple Pinterest images...
if ( 'multiple' === $pinterest_image ) {
// Build all the data needed by the JS process into this array.
$pin_data = array();
$pin_data['description'] = $pinterest_description;
$pin_data['url'] = $post_url;
// Store the permalink of each Pinterest image in the "images" indice.
foreach ( $metabox_pinterest_image as $image ) {
$pin_data['images'][] = wp_get_attachment_url( $image );
}
$json_pin_data = wp_json_encode( $pin_data, JSON_HEX_APOS );
$anchor = '