-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathreadme.txt
174 lines (122 loc) · 8.05 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
=== Minimal Share Buttons ===
Tags: facebook, share buttons, social media, social sharing, X
Tested up to: 6.5
Stable tag: 1.7.3
Requires PHP: 5.6
License: GPL3 or later
License URI: https://www.gnu.org/licenses/gpl.html
Contributors: gonzomir, adrian-roselli, colinleroy
A social share plugin that doesn't spy on users and doesn't slow down your site.
== Description ==
Add simple share buttons under your posts, add share block in the new editor, or use the widget to add sharing to any widget area your theme provides. This plugin uses simple SVG icons for social network logos and small vanilla JavaScript to allow the user to share the current post or page. Share icons inherit their colours from the theme link colours to match the website design.
Why choose Minimal Share Buttons before other similar plugins?
* Minimal and elegant look that blends with your theme (tested with all latest default WordPress themes as well as with some other popular themes).
* Minimal impact on your site's performance - the plugin loads only a small SVG file with the icons, less than 1k CSS and 3.5к unminified and uncompressed JavaScript - most of it to make SVG icons work in old browsers.
* Doesn't spy on your users - the plugin doesn't load any thitd-party scripts that record your user's activity on your site, doesn't set or read any cookies.
* Sharing through the native share dialog on devices that support it.
* GDPR-hasle-free - since the plugin doesn't leak personal information to third parties, this makes it easier for website owners to comply with the European privacy regulations.
* Accessibility - the share links have labels, read by screen readers, and visible for keyboard users.
* Gutenberg and WordPress 5.0 ready - the plugin provides block that displays the share buttons so that authors can place them wherever they want in the post content.
== Installation ==
1. Extract the zip file and upload the folder `minimal-share-buttons` to the `/wp-content/plugins` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress
3. Use the Settings -> Share Options screen to select which social networks you want your content to be shared on, and on which post types the share buttons to appear.
== Usage ==
There are five ways of displaying the share buttons on a post or page:
1. Force them to display under the content of the post by checking the relevant checkboxes in the Display settings sections on the plugin settings screen.
2. Add Share widget to the sidebar or another widget area.
3. Use the Gutenberg block to add the share buttons whereever you want in the post content.
4. Use the shortcode `[msb_share title="Share this"]` in the classic editor.
5. Use the function `msb_display_buttons()` to render the widget in your theme templates.
== Changelog ==
= 1.7.3 =
* Fix textdomain for native share button label.
= 1.7.2 =
* Fix native share button label, make it translatable.
= 1.7.1 =
* Fix typo in native share button sprintf format string, fixes the `aria-label` of the button.
* Update native share button icon.
= 1.7.0 =
* Add Mastodon (thanks @colinleroy) and Threads.
* Update LinkedIn sharing URL.
* Update all icons, use SVGs from FontAwesome.
= 1.6.2 =
* Fix typo in Pinterest share URL, fixes fatal error with PHP 8.1.
= 1.6.1 =
* Fix button tooltips in TwentyTwenty, reset `word-wrap` and `word-break` to `normal`.
= 1.6 =
* Add additional class with the social network name to the buttons and allow filtering of the classes.
* Fix native share button appearing always.
* Fix undefined index notice when the native share option is unchecked.
= 1.5 =
* Add native share option for devices that support the `navigator.share` API.
= 1.4 =
* Define a single function to render the sharing buttons.
* Register a shortcode for rendering the widget in classic editor.
* Update the block editor components, used in the msb/share block.
= 1.3.1 =
* Change default container element to `div`.
= 1.3.0 =
* Don't display the widget if no sharing options are set.
* Display a guiding message to admins when no sharing options are set.
= 1.2.0 =
* Refactor folder structure and apply WP coding standards.
* Refactor JS, remove domready, load minified script, etc.
= 1.1.0 =
* Allow sharing of all public post types.
* Add more social networks.
= 1.0.1 =
* Fix a fatal error in WordPress 5.0 RC.
= 1.0 =
* Gutenberg block.
* Code style updates, output escaping, etc.
* Localisation updates.
= 0.6 =
* Accessibility fix and enhancement thanks to @adrian-roselli
= 0.5 =
* Update Twitter share URL to include permalink of page/post.
* Add rel="noopener" to share links, nullify window.opener in javascript.
= 0.4 =
* Fix $this reference when registering settings page in settings.php
= 0.3 =
* Refactor settings.php into a class.
* Add singleton class to hold social networks list and allow manipulation through a filter.
= 0.2 =
* Add filters that allow theme developers to use their own SVG sprite and rewrite icons.
= 0.1.1 =
* Fix old PHP versions compatibility issue
= 0.1 =
Initial release
== Theme developers ==
From version 1.4 you can more easily display the sharing widget in your templates using the function `msb_display_buttons()`. The function accepts two arguments - an array of options, passed to the widget, and a second boolean argument that tells the function to echo the resulting markup. Here's an example:
$args = [
'before_widget' => '<div class="msb-container">',
'after_widget' => '</div>',
'before_title' => '<h2>',
'after_title' => '</h2>',
'title' => __( 'Share this article', 'mytextdomain' ),
];
msb_display_buttons( $args, true );
If your theme uses SVG icons, combined into a SVG sprite, and your sprite has icons for Facebook, Twitter, Google+ and LinkedIn, there are two filters you can use to replace the icons, provided by the plugin, with yours. The results of the two filters are concatenated with a hash between them and passed through `esc_url` before output.
Another filter allows manipulation of the array of social networks.
===msb_sprite_url===
The filter is applied to the URL of the sprite image and the filter function should return the URL (without the hash sign) of an SVG sprite image, consisting of icons in `symbol` elements.
===msb_icon_name===
The filter is applied to the icon name before concatenating it to the sprite URL. It should return the ID of the icon symbol in the sprite.
===msb_socials===
The filter is applied to the default list of social networks and allows adding or removing socials networks. The array of social networks is associative array, the key is used for the option name on settings page and for the icon ID, and the value is associative array with three elements - `field_label` (the label of the field in settings), `button_label` (the label of the button for screenreader users), and `share_url` (the URL for sharing links). The `share_url` is passed through `sprintf` with two params - the URL of the current page and the title of the page. Example:
function my_add_xing( $socials ){
$socials['xing'] = array(
'field_label' => __( 'Xing', 'mytheme' ),
'button_label' => __( 'Share on Xing', 'mytheme' ),
'share_url' => 'https://www.xing.com/spi/shares/new?url=%1$s&title=%2$s'
);
return $socials;
}
add_filter( 'msb_socials', 'my_add_xing' );
===msb_button_classes===
This filter allows changing the classes of the individual buttons. Two parameters are apssed to the filter functions: the array with classes and the social network / button slug.
== Credits ==
* SVG Icons from [FontAwesome](https://fontawesome.com/), [Creative Commons CC BY 4.0](https://creativecommons.org/licenses/by/4.0/), MIT licence
* Banner image by [heinzremyschindler on pixbay](https://pixabay.com/en/share-play-words-2482016/), [Creative Commons CC0](https://creativecommons.org/publicdomain/zero/1.0/deed.en)
* Plugin icon based on [work by Nathan Diesel from the Noun Project](https://thenounproject.com/term/share/107273/), [Creative Commons CC-BY](http://creativecommons.org/licenses/by/3.0/us/)