inc2734/wp-share-buttons

A library for WordPress theme that adds social share buttons.

7.2.0 2024-11-30 06:07 UTC

Requires

• php: >=7.4
• inc2734/wp-ogp: ^2.0

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^1.0
• phpcompatibility/phpcompatibility-wp: *
• wp-coding-standards/wpcs: ^3.1
• yoast/phpunit-polyfills: ^2.0

GPL-2.0-or-later

• Takashi Kitajima

README

This library adds share button shortcodes for WordPress. This buttons display to sum http and https counts. And, It works lightly with asynchronous display and caching.

When SNS Count Cache plugin is activated WP Share Buttons uses that counts.

This buttons can use for singular pages.

Install

$ composer require inc2734/wp-share-buttons

How to use

<?php
new \Inc2734\WP_Share_Buttons\Bootstrap();

Shortcodes

All buttons

[wp_share_buttons type="(Optional)" title="(Optional)" post_id="(Required)"]

type:
Baloon, horizontal, icon, block, official
When type is not official, buttons sums http and https counts.

Facebook

[wp_share_buttons_facebook type="(Optional)" post_id="(Required)"]

Need App Token to get facebook share count.

/**
 * @see https://developers.facebook.com/tools/accesstoken
 */
add_filter(
  'inc2734_wp_share_buttons_facebook_app_token',
  function() {
    return 'Your App Token';
  }
);

Twitter

[wp_share_buttons_twitter type="(Optional)" title="(Optional)" post_id="(Required)"]

X

[wp_share_buttons_x type="(Optional)" title="(Optional)" post_id="(Required)"]

Threads

[wp_share_buttons_threads type="(Optional)" title="(Optional)" post_id="(Required)"]

Hatna Bookmark

[wp_share_buttons_hatena type="(Optional)" post_id="(Required)"]

Feedly

[wp_share_buttons_feedly type="(Optional)" post_id="(Required)"]

Pocket

[wp_share_buttons_pocket type="(Optional)" title="(Optional)" post_id="(Required)"]

Pinterest

[wp_share_buttons_pinterest type="(Optional)" post_id="(Required)"]

Line

[wp_share_buttons_line type="(Optional)" post_id="(Required)"]

Feed

[wp_share_buttons_feed type="(Optional)" post_id="(Required)"]

Copy URL

[wp_share_buttons_copy type="(Optional)" title="(Optional)" post_id="(Required)"]

Filter hooks

inc2734_wp_share_buttons_count_cache_seconds

/**
 * Set count cache time
 *
 * @param  {int} $seconds
 * @return {int}
 */
add_filter(
	'inc2734_wp_share_buttons_count_cache_seconds',
	function( $seconds ) {
		return 300;
	}
);

inc2734_wp_share_buttons_apply_https_total_count

/**
 * When permalink is https, whether or not to sum http and https
 *
 * @param  {bool} $bool
 * @return {bool}
 */
add_filter(
	'inc2734_wp_share_buttons_apply_https_total_count',
	function( $bool ) {
		return true;
	}
);

inc2734_wp_share_buttons_localize_script_handle

/**
 * Set handle of localize_script
 *
 * @param  {string} $handle
 * @return {string}
 */
add_filter(
	'inc2734_wp_share_buttons_localize_script_handle',
	function( $handle ) {
		return $handle;
	}
);

inc2734_wp_share_buttons_facebook_official_button_share

/**
 * Add facebook sahre button when using official facebook like button
 *
 * @param  {boolean} $boolean
 * @return {boolean}
 */
add_filter(
	'inc2734_wp_share_buttons_facebook_official_button_share',
	function( $boolean ) {
		return $boolean;
	}
);

inc2734_wp_share_buttons_shared_title

/**
 * Customize shared title
 *
 * @param  {string} $title
 * @param  {string} $service twitter or copy
 * @return {string}
 */
add_filter(
	'inc2734_wp_share_buttons_shared_title',
	function( $title, $service ) {
		if ( 'twitter' === $service ) {
			return $title . ' #hashtag';
		}
		return $title;
	},
	10,
	2
);

inc2734_wp_share_buttons_shared_hashtags

/**
 * Customize shared title
 *
 * @param  {string} $title
 * @param  {string} $service twitter or copy
 * @return {string}
 */
add_filter(
	'inc2734_wp_share_buttons_shared_hashtags',
	function( $hashtags, $service ) {
		if ( 'twitter' === $service ) {
			return 'hashtagA,hashtagB';
		}
		return $title;
	},
	10,
	2
);

inc2734_wp_share_buttons_count_cache_seconds

/**
 * Customize share count caching time
 *
 * @param $seconds
 * @return $seconds
 */
add_filter(
	'inc2734_wp_share_buttons_count_cache_seconds',
	function( $seconds ) {
		return $seconds;
	},
	10
);

inc2734_wp_share_buttons_facebook_app_token

/**
 * Set Facebook app token.
 *
 * @param string|false
 * @return string|false
 */
add_filter(
	'inc2734_wp_share_buttons_facebook_app_token',
	function( $token ) {
		return $token;
	},
	10
);