| @@ -1,126 +1,92 @@ | ||
| 1 | 1 | === bbPress === |
| 2 | -Contributors: matt, johnjamesjacoby | |
| 3 | -Tags: forums, discussion, support, theme, akismet, multisite | |
| 4 | -Requires at least: 3.4 | |
| 5 | -Tested up to: 3.4 | |
| 6 | -Stable tag: 2.1 | |
| 7 | -License: GPLv2 or later | |
| 8 | -License URI: http://www.gnu.org/licenses/gpl-2.0.html | |
| 2 | +Contributors: matt, johnjamesjacoby, jmdodd, netweb, sergeybiryukov | |
| 3 | +Tags: forum, forums, discussion, support | |
| 4 | +License: GNU General Public License v2 or later | |
| 5 | +License URI: https://www.gnu.org/licenses/gpl-2.0.html | |
| 6 | +Requires PHP: 5.6.20 | |
| 7 | +Requires at least: 6.0 | |
| 8 | +Tested up to: 7.1 | |
| 9 | +Stable tag: 2.6.17 | |
| 9 | 10 | |
| 10 | -bbPress is forum software, made the WordPress way | |
| 11 | +bbPress is forum software for WordPress. | |
| 11 | 12 | |
| 12 | 13 | == Description == |
| 13 | 14 | |
| 14 | -Have you ever been frustrated with forum or bulletin board software that was slow, bloated and always got your server hacked? bbPress is focused on ease of integration, ease of use, web standards, and speed. | |
| 15 | +Are you looking for a timeless, elegant, and streamlined discussion board? bbPress is easy to integrate, easy to use, and is built to scale with your growing community. | |
| 15 | 16 | |
| 16 | -We're keeping things as small and light as possible while still allowing for great add-on features through WordPress's extensive plugin system. What does all that mean? bbPress is lean, mean, and ready to take on any job you throw at it. | |
| 17 | +bbPress is intentionally simple yet infinitely powerful forum software, built by contributors to WordPress. | |
| 17 | 18 | |
| 18 | 19 | == Installation == |
| 19 | 20 | |
| 20 | -1. Place the 'bbpress' folder in your '/wp-content/plugins/' directory. | |
| 21 | -2. Activate bbPress. | |
| 22 | -3. Visit 'Settings > Forums' and adjust your configuration. | |
| 23 | -4. Create some forums. | |
| 24 | -5. View your site. | |
| 25 | -6. Adjust the CSS of your theme as needed, to make everything pretty. | |
| 21 | += From your WordPress dashboard = | |
| 26 | 22 | |
| 27 | -== Changelog == | |
| 23 | +1. Visit 'Plugins > Add New' | |
| 24 | +2. Search for 'bbPress' | |
| 25 | +3. Activate bbPress from your Plugins page. (You will be greeted with a Welcome page.) | |
| 28 | 26 | |
| 29 | -= 2.1 = | |
| 30 | -* WordPress 3.4 compatibility | |
| 31 | -* Deprecate $bbp global, use bbpress() singleton | |
| 32 | -* Private forums now visible to registered users | |
| 33 | -* Updated forum converter | |
| 34 | -* Topic and reply edits now ran through Akismet | |
| 35 | -* Fixed Akismet edit bug | |
| 36 | -* Fixed Widgets nooping globals | |
| 37 | -* Fixed translation load order | |
| 38 | -* Fixed user-edit bugs | |
| 39 | -* Fixed settings screen regressions | |
| 40 | -* Improved post cache invalidation | |
| 41 | -* Improved admin-side nonce checks | |
| 42 | -* Improved admin settings API | |
| 43 | -* Improved bbPress 1.1 converter | |
| 44 | -* Improved BuddyPress integration | |
| 45 | -* Improved Theme-Compatibility | |
| 46 | -* Improved template coverage | |
| 47 | -* Improved query performance | |
| 48 | -* Improved breadcrumb behavior | |
| 49 | -* Improved multisite integration | |
| 50 | -* Improved code clarity | |
| 51 | -* Improved RTL styling | |
| 52 | -* Added 2x menu icons for HiDPI displays | |
| 53 | -* Added fancy editor support | |
| 54 | -* Added fallback theme picker | |
| 55 | -* Added tools for importing, resetting, and removing | |
| 27 | += From WordPress.org = | |
| 56 | 28 | |
| 57 | -= 2.0 = | |
| 58 | -* Released on September 21, 2011 | |
| 29 | +1. Download bbPress. | |
| 30 | +2. Upload the 'bbpress' directory to your '/wp-content/plugins/' directory, using your favorite method (ftp, sftp, scp, etc...) | |
| 31 | +3. Activate bbPress from your Plugins page. (You will be greeted with a Welcome page.) | |
| 59 | 32 | |
| 60 | -= 2.0-rc-5 = | |
| 61 | -* Fixed Genesis incompatibilities | |
| 62 | -* Fixed BuddyPress activity stream issues | |
| 63 | -* Fixed Subscription email sending issues | |
| 64 | -* Fixed Theme Compat display issues for some themes | |
| 65 | -* Improved Theme Compat class | |
| 66 | -* More future proofing internal API's | |
| 33 | += Once Activated = | |
| 67 | 34 | |
| 68 | -= 2.0-rc-4 = | |
| 69 | -* BuddyPress @mention integration | |
| 70 | -* Improved Akismet user agent handling | |
| 71 | -* Added blacklist_keys support | |
| 72 | -* Fixed spam/deleted user handling | |
| 73 | -* Updated green admin color scheme for WordPress 3.2 | |
| 74 | -* Added actions to topic/reply forms | |
| 75 | -* Improved support for future ajaxification | |
| 35 | +1. Visit 'Forums > Add New' and create some forums. (You can always delete these later.) | |
| 36 | +2. If you have pretty permalinks enabled, visit example.com/forums/, or if you do not have pretty permalinks enabled, visit example.com?post_type=forum | |
| 37 | +3. Visit 'Settings > Forums' and configure the settings to best match the needs of your community. | |
| 38 | +4. Visit 'Tools > Forums > Import Forums' if you have an existing forum to convert to bbPress. | |
| 76 | 39 | |
| 77 | -= 2.0-rc-3 = | |
| 78 | -* Fixed activation/deactivation | |
| 79 | -* Added Forum Participant role for multisite use | |
| 40 | += Once Configured = | |
| 80 | 41 | |
| 81 | -= 2.0-rc-2 = | |
| 82 | -* BuddyPress activity action integration | |
| 83 | -* Multisite integration | |
| 84 | -* Fixed a bushel of bugs | |
| 85 | -* Fixed tag pagination again | |
| 86 | -* Fixed ajax priority loading | |
| 42 | +* bbPress comes with a robust theme-compatibility API that does its best to make bbPress look and feel right with just-about any WordPress theme. You may need to adjust some styling on your own to make everything look pristine. | |
| 43 | +* You may want to customize the register/activation/sign-in/lost-password flows, to better suit your site. bbPress comes with a bevy of shortcodes to make this possible, listed here: https://codex.bbpress.org/shortcodes/ | |
| 44 | +* bbPress also comes with built-in support for Akismet and BuddyPress, two very popular and very powerful WordPress plugins. If you're using either, visit your Forum Settings page and ensure that integration appears correct. | |
| 87 | 45 | |
| 88 | -= 2.0-rc-1 = | |
| 89 | -* Fixed tag pagination | |
| 90 | -* Broke tag pagination | |
| 91 | -* Squashed a bunch of bugs | |
| 46 | +== Developer Notes == | |
| 92 | 47 | |
| 93 | -= 2.0-beta-3b = | |
| 94 | -* Fix regression in forum index theme compatibility template | |
| 95 | -* Audit usage of get strings for moderator level and above users | |
| 48 | += Count updates in 2.6.17 = | |
| 96 | 49 | |
| 97 | -= 2.0-beta-3 = | |
| 98 | -* Akismet integration | |
| 99 | -* Fixes replies within wp-admin | |
| 100 | -* Fixes reply notification links | |
| 101 | -* Fixes inconsistent breadcrumb behavior | |
| 102 | -* Fixes theme compatibility issues | |
| 103 | -* Fixes archive and page conflicts | |
| 104 | -* Improvements to unpretty permalink support | |
| 105 | -* Improvements to importer | |
| 106 | -* Improvements to multisite support | |
| 107 | -* Normalize theme, shortcodes, and template parts | |
| 108 | -* Add humans.txt | |
| 109 | -* Add empty index.php files to prevent snooping | |
| 110 | -* Add max length to topic titles (default 80 chars) | |
| 50 | +bbPress now synchronizes its built-in public and hidden topic and reply counts, aggregate forum counts, and user contribution counts on `bbp_transition_post_status` at priority 10, after WordPress persists the new post status. When a topic crosses the public status boundary, its stored public reply count is applied to the forum aggregate instead of recounting every reply. The action receives the new status, old status, and `WP_Post` object. The `bbp_pre_update_counts_on_transition_post_status` filter can short-circuit the complete topic or reply count operation for custom status lifecycles or count storage. | |
| 111 | 51 | |
| 112 | -= 2.0-beta-2 = | |
| 113 | -* GlotPress integration | |
| 114 | -* Fixes Forum archive bug | |
| 115 | -* Fixes and improvements to importer | |
| 116 | -* Adds home link support to breadcrumb | |
| 117 | -* Improvements to Theme Compatibility | |
| 118 | -* Numerous template and CSS improvements | |
| 119 | -* RTL support | |
| 120 | -* Improved multisite support | |
| 121 | -* Add filters for future anti-spam support | |
| 122 | -* Add missing breadcrumbs to various template files | |
| 123 | -* Topic/reply trash fixes | |
| 52 | +The existing `bbp_new_*`, `bbp_insert_*`, `bbp_trash_*`, `bbp_untrash_*`, `bbp_spam_*`, `bbp_unspam_*`, `bbp_approve_*`, and `bbp_unapprove_*` topic and reply actions continue to fire with their existing arguments and timing. Their corresponding completed actions, such as `bbp_trashed_*`, also remain available. The public count helper functions also remain callable. | |
| 124 | 53 | |
| 125 | -= 2.0-beta-1 = | |
| 126 | -* In development | |
| 54 | +For topic and reply creation, the status transition occurs inside `wp_insert_post()`. The later `bbp_new_*` and `bbp_insert_*` actions therefore continue to run after status counts are updated and after bbPress stores its relationship metadata. Creation-specific integrations can remain on those actions. | |
| 55 | + | |
| 56 | +For moderation, status-count synchronization occurs between the existing pre-transition action, such as `bbp_spam_reply`, and its completed action, such as `bbp_spammed_reply`. Extensions that need every persisted topic, reply, forum, and user status-count change should use `bbp_transition_post_status` at priority 11 or later. Completed moderation actions begin after those counts are finalized. | |
| 57 | + | |
| 58 | +bbPress no longer attaches its built-in topic, reply, forum, and user status-count callbacks to the creation and moderation actions. Manually firing one of those actions without changing the post status therefore no longer updates those counts. Topic voice counts and engagements remain attached to the creation and completed moderation actions, so manually firing one of those actions can still recalculate voices and engagements without a status change. The priority-11 transition hook does not observe those later updates. Extensions that need both recalculations to finish can use priority 31 or later on the legacy action; bbPress runs engagement callbacks before voice-count callbacks. Count membership comes from the filtered public and non-public status arrays. Extensions that already maintain counts for custom statuses should remove duplicate count callbacks and keep the public and non-public arrays disjoint. The public increase and decrease convenience functions now validate the current topic or reply status; use the lower-level bump functions for an intentional numeric difference. Do not manually fire `bbp_transition_post_status` to simulate a write because its count callback trusts the supplied statuses as a completed database transition. | |
| 59 | + | |
| 60 | +Permanent deletion does not produce a post-status transition. Its count maintenance continues through the existing `bbp_deleted_topic` and `bbp_deleted_reply` actions. | |
| 61 | + | |
| 62 | +Count bump functions now use conditional metadata writes and bounded retries so simultaneous requests do not overwrite each other's existing count changes. Existing bbPress count filters and the standard WordPress metadata filters and actions continue to run. A before-update metadata action may run more than once when a request loses a comparison and retries; its matching after-update action runs only for the successful write. The update-metadata short-circuit filter runs once for the bump call using its first sanitized candidate value. A user-count filter that changes the absolute result retains the previous absolute-update behavior and opts that call out of the atomic difference path. | |
| 63 | + | |
| 64 | +WordPress metadata tables do not enforce unique object-and-key pairs, so simultaneous first-time inserts retain the same limitation as the core metadata API. A request can also exhaust the bounded retries under unusually high contention. An atomic bump applies a difference to its supplied stored or default value and is not a recount. The `bbp_pre_bump_count_meta` filter can short-circuit an update, the `bbp_bump_count_meta_max_attempts` filter controls the default limit of five write attempts, and the `bbp_bump_count_meta_types` filter controls the post, user, term, and comment metadata types supported by default. `bbp_update_user_topic_count()` and `bbp_update_user_reply_count()` accept an optional third `$difference` argument for this internal bump lifecycle; existing calls remain compatible. | |
| 65 | + | |
| 66 | +Post-author changes and user deletion with post reassignment now reconcile affected user contribution, topic engagement, and voice counts. Moderator move, merge, and split operations also reconcile source, destination, and ancestor forum counts. Forum count updater functions accept an optional final argument for propagating a recount's difference through ancestor totals; existing calls remain compatible. Forum reply recounts include public replies only when their parent topics are also public. A public reply beneath a non-public topic is excluded from the public forum total without being included in the pending, spammed, and trashed reply count. Topic engagement recounts honor filtered public topic and reply statuses, and preserve other term-backed relationships. | |
| 67 | + | |
| 68 | += Subforum counts in 2.6.17 = | |
| 69 | + | |
| 70 | +bbPress now maintains subforum counts when forums are trashed, restored, permanently deleted, or moved between parents. Recursive forum counts include public, private, and hidden subforums while excluding subforums with uncountable statuses. `bbp_forum_query_subforum_ids()` no longer inherits the broader `bbp_get_all_child_ids` result; extensions that customized subforum count membership through that lower-level filter should use `bbp_forum_query_subforum_ids`, `bbp_get_countable_forum_statuses`, or the forum-status filters. The new `bbp_post_updated` action receives the post ID, the updated `WP_Post` object, and the previous `WP_Post` object after any bbPress post type is updated. | |
| 71 | + | |
| 72 | +The upgrade does not synchronously recount every forum. Sites with known stale metadata can selectively run the applicable count and engagement tools under Tools > Forums > Repair Forums. These tools can be expensive on large sites. | |
| 73 | + | |
| 74 | +== Screenshots == | |
| 75 | + | |
| 76 | +1. Forums - Admin Interface | |
| 77 | +2. Topics - Admin Interface | |
| 78 | +3. Replies - Admin Interface | |
| 79 | +4. Settings - Admin Interface | |
| 80 | +5. Settings 2 - Admin Interface | |
| 81 | +6. Themes - Admin Interface | |
| 82 | +7. Single Forum - Default Theme | |
| 83 | + | |
| 84 | +== Changelog == | |
| 85 | + | |
| 86 | +Check out the [releases page](https://codex.bbpress.org/releases/) | |
| 87 | + | |
| 88 | +== Upgrade Notice == | |
| 89 | + | |
| 90 | += 2.6.17 = | |
| 91 | + | |
| 92 | +Count maintenance now uses the bbPress post-status transition action and conditional metadata writes. Extensions that attach count callbacks to creation or moderation actions, add custom statuses, filter count values, or customize subforum queries should review the Developer Notes. Sites with known stale counts can selectively run the repair tools after upgrading. | |
