-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathreadme.txt
397 lines (276 loc) · 26.2 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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
=== Simple Facebook Connect ===
Contributors: Otto42
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=otto%40ottodestruct%2ecom
Tags: facebook, connect, simple, otto, otto42, javascript, comments, share, status
Requires at least: 3.0
Tested up to: 3.1
Stable tag: 0.25
== Description ==
Simple Facebook Connect is a series of plugins that let you add any sort of Facebook Connect functionality you like to a WordPress blog. This lets you have an integrated site without a lot of coding, and still letting you customize it exactly the way you'd like.
First, you activate and set up the base plugin, which makes your site have basic Facebook Connect functionality. Then, each of the add-on plugins will let you add small pieces of specific Facebook-related functionality, one by one.
Requires WordPress 3.0 and PHP 5.
**Current add-ons**
* Comment using Facebook Identity (with FB avatar support)
* Automatically Publish new posts to Facebook Profile or Fan Page
* Manually Publish posts to FB Profile or Application or Fan Page
* Login with your Facebook credentials
* New user registration with Facebook credentials
* Share button and Shortcode
* Connect Button Widget and Shortcode
* User Status Widget and Shortcode
* Live Stream Widget and Shortcode
* Bookmark Widget and Shortcode
* Find us on Facebook button Widget and Shortcode
* Fan Box Widget
* Fan Count Chicklet and Widget
* Like Button and Shortcode
* Upcoming Events Widget
* Activity Feed Widget
**Coming soon**
* (Got more ideas? Tell me!)
If you have suggestions for a new add-on, feel free to email me at [email protected] .
Want regular updates? Become a fan of my sites on Facebook!
http://www.facebook.com/apps/application.php?id=116002660893
http://www.facebook.com/ottopress
Or follow my sites on Twitter!
http://twitter.com/ottodestruct
== Installation ==
1. Upload the files to the `/wp-content/plugins/simple-facebook-connect/` directory
1. Activate the "Simple Facebook Connect" plugin through the 'Plugins' menu in WordPress
1. Follow the instructions that the plugin itself will give you.
== Frequently Asked Questions ==
= Whoa, what's with all these plugins? =
The principle behind this plugin is to enable small pieces of Facebook Connect functionality, one at a time.
Thus, you have the base plugin, which does nothing except to enable your site for XFBML and Facebook Connect in general. It's required by all the other plugins.
Then you have individual plugins, one for each piece of functionality. One for enabling comments, one for adding a share button, etc. These are all smaller and simpler, for the most part, because they don't have to add all the Facebook Connect stuff that the base plugin adds.
= The comments plugin isn't working! =
You have to modify your theme to use the comments plugin.
(Note: If you have WordPress 3.0 and a theme using the new comment_form() method, then this step is not necessary).
In your comments.php file (or wherever your comments form is), you need to do the following.
1. Find the three inputs for the author, email, and url information. They need to have those ID's on the inputs (author, email, url). This is what the default theme and all standardized themes use, but some may be slightly different. You'll have to alter them to have these ID's in that case.
2. Just before the first input, add this code:
[div id="comment-user-details"]
[?php do_action('alt_comment_login'); ?]
(Replace the []'s with normal html greater/less than signs).
3. Just below the last input (not the comment text area, just the name/email/url inputs, add this:
[/div]
That will add the necessary pieces to allow the script to work.
If you're using WordPress 3.0 and the new "comments_form" code (like in the Twenty Ten theme), then this is unnecessary! Check ottopress.com for info on how to upgrade your theme to use the new 3.0 features.
= The plugin causes an error with a missing "json_encode"! =
I did say that this plugin was for WordPress 2.9 and up.
If you are using PHP 5.2 and up, json_encode is built in. If not, then WordPress 2.9 contains a backwards compatible version of it. Either way, many of the plugins need this function in order to do the Facebook sharing functionality properly.
Instead of defining the function itself, it's relying on your code already having it available, whether it's through PHP or WordPress. WordPress 2.8.5 does NOT have this function, so unless you're running PHP 5.2 or up, many of the add-on plugins will not work with that version of WordPress.
= The automatic "share" after the comments looks funky! Or, there's strange text showing up where it shouldn't be! =
I have encountered other WordPress plugins which mess with the output created by the_excerpt. Since I'm using this to create the content for this piece of the share part, it's possible that there is another plugin interfering.
To check this, view the source of the single post page. Near the bottom is a fair amount of javascript added by the comments plugin. One section in particular looks like this:
`var attachment = {
'name':'Name of post',
'href':'http://example.com/blog/2009/post-name/',
'description':"Lorem ipsum dolor sit amet [...]",
'caption':'{*actor*} left a comment on Name of post',
'comments_xid':'http%3A%2F%2Fexample.com%2Fblog%2F2009%2Fpost-name%2F'
};`
If it looks messed up in any way, or if there's any extra text around that area, then you likely have some other plugin that breaks the usage of the_excerpt. You'll need to find and deactivate that plugin.
= The automatic "share" after the comments shows the wrong post! =
You have some plugin that is breaking the proper operation of The Loop. A lot of plugins that display some list of posts (like a list of most popular posts in the sidebar, or a recent comments list, etc) have been known to do this. These plugins were written incorrectly and need to be fixed. Look for updates to those plugins.
Note that you *must* fix these plugins, or remove them. They can cause other issues as well, like comments being attached to the wrong posts and other oddities along those lines. This has been a long standing problem with many WordPress plugins and even some themes. If you cannot find the culprit, try the WordPress support forums. Be prepared to post code from your theme so that somebody can solve the problem for you.
= Share doesn't work, Publish doesn't work =
Check the page source. If you have a message in there that looks like this: "Warning: Cannot modify header information - headers already sent by ... in .../wp-includes/class-json.php on line 238", then you need to upgrade WordPress to 2.9.1. WordPress 2.9 had a minor bug that manifested itself as this error in some cases.
= Facebook Avatars look wrong. =
Facebook avatars use slightly different code than other avatars. They should style the same, but not all themes will have this working properly, due to various theme designs and such.
However, it is almost always possible to correct this with some simple CSS adjustments. For this reason, they are given an "fbavatar" class, for you to use to style them as you need. Just use .fbavatar in your CSS and add styling rules to correct those specific avatars.
Also note that Facebook "square" avatars are limited to 50 by 50 pixels in size. If your theme uses a bigger one, then it'll get scaled up and may look bad. There's no easy fix for this, as the other avatars offered by Facebook are not square shaped. If it returned those, then it could mess up many more themes. complain to Facebook and tell them to offer larger squared off avatars.
= The login plugin won't let me connect my accounts! =
A new security feature in the login plugin is email validation.
When you connect your account to Facebook, the plugin talks to Facebook behind the scenes and attempts to verify your email address. This means that your email on your WordPress account must match one of the email addresses attached to your Facebook account. If the matching process fails, you'll get an alert box telling you why it failed, and the accounts will not be linked.
This is a very alpha process and I can't be sure I've worked all the bugs out. If you have a problem and you know that your two accounts share the same email address, then email me directly with the problem and I'll try to help you out and fix the plugin. Please include screenshots of your email address in both WordPress and Facebook to prove you've checked that possible problem, and also so I can check the code with that address myself.
= Why can't I automatically publish to my Application? =
Sorry, nothing I can do about it. There's a bug (or design flaw, if you prefer) on Facebook preventing this for Applications: http://bugs.developers.facebook.com/show_bug.cgi?id=8184
When they fix it, I'll turn this feature on. The code is there and done, it just needs to have that bug fixed.
Note that you should be able to auto-publish to Fan Pages just fine.
In the meantime, the manual publishing button for an Application or Fan Page works correctly. And automatic publishing of new posts to your personal profile works fine. Note: If you use a multi-user blog, this will publish to the user profile of whoever is publishing the post. That user must also have granted the extended permissions for it to work. Different people may see different settings there, so anybody doing publishing must have granted that permission if they want the post sent to Facebook automatically in any format.
= How do I use this Fanbox custom CSS option? =
Well, first you have to learn CSS.
Next, try starting with this code in the custom CSS box:
.connect_widget .connect_widget_facebook_logo_menubar {}
.fan_box .full_widget .connect_top {}
.fan_box .full_widget .page_stream {}
.fan_box .full_widget .connections {}
That should be enough to get you started.
= The publish code doesn't process the NextGen gallery shortcodes! =
Upgrade NextGen Gallery to 1.60 or later.
= How do I use this with multi-site across subdomains/subdirectories? =
(This is a new feature to 0.21 and it has NOT been really tested well yet. You have been warned.)
Many people want to set up a "network" of sites, and enable SFC across all of them. Furthermore, they'd like people to stay "connected" across them all, and to only use one Facebook Application to connect their users. This is entirely possible with a bit of setup.
First, create your Facebook Application. It should use the base domain field as well as the normal fields. No subdirectories or subdomains anywhere. For this example, we'll use "example.com".
Next, you can add these to your site's wp-config:
define('SFC_API_KEY', 'xxxxx');
define('SFC_APP_SECRET', 'xxxxx');
define('SFC_APP_ID', 'xxxxx');
define('SFC_FANPAGE', '(this one is optional)');
define('SFC_IGNORE_ERRORS', true');
The first four are the exact same settings as on the normal SFC base configuration screen, and they will override those settings for the entire network of sites. In fact, when those are defined, the corresponding settings options won't even appear. This may look odd at first.
The last one is a special override that causes the normal URL check to be disabled. This is because your URLs won't match the Facebook settings, but in this case, they don't actually need to.
With this setup, SFC *should* work across all your subdomains and subdirectories. So it'll work on example.com or blog.example.com or otto.example.com or whatever. It should also work on example.com/blog.
The "base domain" setting on your Facebook application is important. In this case, it MUST be set to the base domain (example.com), so that the cookies will be set there and thus will let you stay "connected" across the sites.
Notes:
* SFC-Login may or may not work. It's hard to say. Try it, it might work. I need more info to debug this.
* Using other base domains with the domain mapping plugin absolutely will NOT work. Period. The redirection to the base domain for login breaks SFC-Login, because there is no way for Facebook to stay connected across domain names.
Email me if you have problems... But only if you're also willing to help solve those problems, I can't reproduce most setups and I can't fix what I can't see.
== Screenshots ==
1. Simple Facebook Connect Main Admin Screen.
2. Facebook share button in action.
3. Facebook Comments login button.
4. Facebook Connect button on the Login Screen.
5. Facebook Publisher box in the Post editing screen.
6. Connecting a WordPress account to a Facebook Account on the Profiles Page.
7. Connected a WordPress account to a Facebook Account on the Profiles Page.
8. Share button configuration
== Upgrade Notice ==
= 0.25 =
* Sorry for yet another update, but the UTF8 publish bug affects a lot of international users, so I have to get it out there ASAP.
== Changelog ==
= 0.26 =
* SFC-Login: Profile connection fix
* SFC-Base: SSL admin fix (thanks to jwz)
* SFC-Publish: Squeeze out max possible number of chars (jwz)
= 0.25 =
* Fix UTF-8 encoding problem for non-English publishing.
* Add FB Icon to username for FB connected users
= 0.24 =
* Fix missing xd_receiver URL.
= 0.23 =
* i18n thanks to Burak Tuyan.
* New filter: sfc_img_exclude will let other plugin authors add their own image classes to exclude from the automatic image finder for share and publish and such.
* sfc_like_button now supports a url parameter to add a like button to a specific URL, like the homepage.
* Publish now sends up to 1000 chars from the post to Facebook. Thanks to jwz for the patch.
* Publish now gets images correctly in more cases. Thanks to jwz.
* If you enable login avatars (by uncommenting that code), it will show them for comments now too.
* xid elimination
* Custom Post Type support for automatic publishing (any CPT with public=>true will get auto-published)
* Contextual help added
* Improved error messages
* Numerous optimizations and bugfixes
= 0.22 =
* Error due to bad code release. Do not use.
= 0.21 =
* The main SFC base plugin now has a proper and working check for PHP 5 only systems. I think. I hope. I'm sick of people talking about "error on line 210" or what have you. Read the requirements, folks!
* The base plugin now has ways to pre-define the main four settings (api-key, app-secret, app-id, and fanpage-id). You can add defines for each of them into your wp-config with these names: SFC_API_KEY, SFC_APP_SECRET, SFC_APP_ID, and SFC_FANPAGE. All of them are optional, and when defined they will no longer show up on the settings page. This may be useful for people using the multi-site capabilities of WP 3.0 and wanting to use a single application across domains. You can also define SFC_IGNORE_ERRORS to "true" to force the settings page to not display the "Incorrect URL" error. This is necessary for multi-user systems using a base domain application across multiple subdomains, as the error checker cannot account for that.
* Facebook avatars now use the Graph API for displaying. This eliminates the fb:profile XFBML tag and makes it back into a normal IMG tag, like Gravatars and Twitter avatars are. This should remove styling problems people had, though they are still classed as "fbavatar" if you want to style them differently. Side note: Because of this, the Facebook logo on these avatars is now gone. Graph API has no way to force the logo.
* Several like button options added.
* Remove minimum width of Fanbox.
* More options in activity feed widget.
* Assorted bug fixes.
= 0.20 =
* Added Activity Feed widget.
* Minor update to fanbox. functions get_sfc_fanbox() and sfc_fanbox() are now available for direct theme usage.
* Added lots more og: meta data. Facebook added an "article" type, specifically for blog posts and other such similar things. This fixes the every-post-becomes-a-fan-page problem.
* Minor wording changes.
* Minor bugfixes.
* Fix for login for people with high FB ID numbers. Maybe. I can't test this patch, but somebody told me it worked.
* Changed the init call to force email request on connection. This may solve some problems for people unable to comment and such.
= 0.19 =
* Added og:site_name to base plugin, for OpenGraph info.
* Added fb-like shortcode.
* Offline permissions fix, assorted thumbnail handling fixes.
= 0.18 =
* Added Upcoming Events widget. This will show your upcoming events from Facebook. For a user, it shows events that person has been invited to. For a fan page, application, or group, it will show events created by that entity.
* Added Like button. Will be reworking entire plugin soon for FB's new OpenGraph support. Expect that to be a 1.0 release.
= 0.17 =
* Add error checking for bad API and similar inputs which caused a Facebook API error. The error from FB is now echoed and handled properly.
* Add Locale support. If your WordPress is in a locale, then that locale will be passed to Facebook's Javascript to make the default text appear in that language. Logged in users will still see the text localized to their own lanaguage.
* Support for WordPress 3.0. Works with Multi-Site, but it must be configured separately for each individual site, it will not work sitewide. Sitewide coming soon for a small percentage of configurations (it's only possible if all sites are on the same domain, not in multiple domains).
* Fixed image handling in Share and Publish plugins (requires WP 3.0 kses fixes for it to really work).
* Facebook decided to remove email_domain without telling anybody in advance. That's now fixed.
= 0.16.1 =
* Missed a trailing slash issue in 0.16.
= 0.16 =
* Error handling on login now tells you "Facebook user not recognized" if you try to login with a FB user that isn't attached to a WP user.
* Added Facebook Platform Status Feed on config page. This might help to tell users when Facebook is having issues, hopefully to make them stop emailing me every time Facebook's API servers have another hiccup.
* Rewritten javascript for Comments plugin. Now the Sharing is optional with a checkbox (per FB's new guidelines) and the comment submission should be more bulletproof (for browsers that don't do Javascript quite properly... I'm looking at you Safari and Chrome!).
* Fixed avatar styling issues. If you had already made changes to your CSS to account for the avatar divs, then those are now gone and the avatar class is properly on the IMG instead. If you do need special styling, use .fbavatar to refer to facebook avatars only.
* Fixed minor share button problem with "method 2".
* Main plugin now does some sanity checking for common errors.
= 0.15 =
* Script and style tags now get stripped properly when publishing.
* Fanbox widget now has a height option.
* The Connect Widget will now actually log a user into WordPress via redirecting them to wp-login.php. Login plugin must be activated for this to work. This can also trigger Register plugin, if that plugin is activated. User will be redirected back to current page, but with logged in cookies set.
= 0.14 =
* Fanbox had an error in 0.13.
* Fixes publish error for people using themes that don't support post thumbnails
= 0.13 =
* Bug fix: Publish and Share could miss images in the content sometimes.
* Minor speed improvements to Fan Box CSS handling.
* Automatic Fan Page publishing now tries to force privacy setting to "Everyone", to eliminate issues with invalid privacy settings making posts not visible to Fans.
* Post thumbnail support in Publish and Share plugins.
* Minor Fanbox custom CSS improvement.
* Publish won't send mere edits of already existing posts to Facebook now.
* Changed comment plugin to use newer translateable Connect with Facebook button.
= 0.12 =
* Fan Box custom CSS support.
* PHP 5 version checking as a base requirement. No way around this, Facebook's PHP libraries are PHP 5 and up only. PHP 4 is just dead.
* Login and Comments plugins add Facebook person extension data to Atom feeds, based on Friendfeed <a href="http://friendfeed.com/jessestay/0293c591/i-would-love-to-see-rss-and-or-atom-support">discussion</a>.
* Additional error checking to try to prevent odd PHP errors whenever Facebook's API goes wonky.
* Login now has an option to prevent people from disconnecting their WP and FB accounts. Add a "define('SFC_ALLOW_DISCONNECT',false); to your wp-config to prevent disconnection of accounts.
* Fixed logout bugs in Login plugin. Logout works correctly now.
* SSL Support. The base plugin now loads the scripts correctly for SSL connections. No guarantees, but it should work for SSL Admin users now.
* Added "Find us on Facebook" button in widget and shortcode form. Button links to your main Facebook App/Fan Page wall. Use [fb-find] in posts for shortcode.
* Automatic publishing to Fan Pages works now. Automatic publish to Application Walls does not work yet, due to Facebook bugs.
* Register plugin now has a "one-click" mode, to skip all prompting. Add "define ('SFC_REGISTER_TRANSPARENT', true);" to your wp-config to enable this mode. WARNING: May be buggy, not recommended for production sites.
* Minor speed enhancement that should fix some of the delays people see when logging in with FB on their sites.
* Height support in Fan Box shortcode.
= 0.11 =
* Fix html entities in publish dialogs.
* Publish plugin now supports automatic publishing! Look on the SFC settings page to grant permissions and enable automatic publishing.
* Real email address support in comments and register. You need to fill in the "Email Domain" on the FB Applications tab to be given a proper choice.
* Register plugin is now working. Requires login plugin to be enabled first.
* Publish plugin is now smarter and won't show you publishing buttons if you're not connected to Facebook.
* Published posts now also have a See Comments link on Facebook.
= 0.10 =
* Fix quoting problems with publish and comments, for stream publishing (quote marks in titles and such shouldn't cause problems any more)
* Comment email improvement: If you have the "Comment author must fill out name and e-mail" checked in Settings->Discussion, the comments plugin will now ask the Facebook user for Permission to email that user. This will allow things like replying to the comment emails and Subscribe to Comments and similar plugins to work with Simple Facebook Connect. Yes, you can actually reply to the Facebook commenter when their comment gets emailed to you, and the reply *works*. Tested, proven.
* Comments plugin now uses comment meta table for storing FB user id, making for *much* quicker avatar generation. Avatars used to be built by getting FB UID from the email field, which took time for regex parsing. Old avatars will be auto-converted to new method when displayed. This also has an advantage in that there's now an 'fbuid' comment meta field on every facebook connected comment, to tie back to the author of the comment.
* Comments now don't rely on Javascript quite so much. Facebook PHP code is used to get relevant data.
* Publish post-processing improvements, to try to get more images from the post content by using the_content filter.
* Publish button now shows "Fan Page" instead of "Application", if you're using a Fan Page.
* Made comment login button hook a bit more generic (anticipating a "Simple Twitter Connect" plugin).
= 0.9 =
* Added share button type option.
* Improved login support. Now it verifies your users email address with Facebook before allowing them to connect their accounts. This ensures that at least they're using the same email on FB and on WP.
* Fixed problem with page reloading for no obvious reason (using different reload method for login plugin).
* Share button shortcode is now [fb-share] if you want to use that in a post.
* Added new Publisher button to publish to your own Facebook profile (this is the same as sharing the post with the share button, actually, but a few people requested it).
* Added Facebook logo checkbox to fanbox plugin.
= 0.8 =
* Added Fan Page support, for people who already have Fan Pages that they don't want to give up. I do not recommend using this option, but it's there if you really need it.
* Improved login capabilities. Now a Connect button shows on the login screen, and logging out actually logs you out properly.
= 0.7 =
* Added shortcode for fanbox widget. [fb-fanbox]. Optional parameters are stream (1 or 0), connections (int), and width (int).
* Added Application Secret field to main plugin. Login plugin will need it.
* Facebook login now partially working. If you connect your WP account to your FB account and you visit the wp-login page while logged into Facebook as well, you will get auto-logged into WordPress, without any prompting or intervention. This may not be 100% secure or safe, and I do not recommend using it at this point, it's for testing only. I would, however, appreciate feedback on the best way to implement this, sort of thing.
= 0.6 =
* Added shortcode for live stream widget. [fb-livestream] will work in pages and posts. The width and height are optional parameters.
* Added shortcode for user status widget. [fb-userstatus profileid="12345"] will work similarly. The profileid is required.
* Added Connect button widget and shortcode [fb-connect].
* Added Bookmark button widget and shortcode [fb-bookmark].
= 0.5 =
* Live Stream widget
* Manual Publishing plugin. Lets you post links to your posts on the Facebook Application's Wall. These will show up as "updates" to Fans of your application (which makes the Fan Box widget more useful). Currently, this is manual in that it will only push posts to the Wall when you click the button on the Edit Post page and publish it there.
= 0.4 =
* Added Fan Box Widget
* Added new Application ID field to main plugin
* Minor internal reorganizing, for planned addons
* Decided to keep all the version numbers in sync
= 0.3 =
* Comment avatars working, beginnings of a Facebook login capability.
= 0.2.3 =
* Comments working now. Requires minor theme modifications to make it work.
= 0.2.2 =
* Support FBFoundations compatibility, to some extent (make it easier to switch)
* Correct minor errors
= 0.2.1 =
* Add meta information to share button, so that stuff shows up nicely on Facebook.
= 0.2 =
* Functional enough to use. Barely. Comments still not working. Share button works. XFBML works.
= 0.1 =
* Pre-Alpha. DO NOT USE.