Skip to content

Conversation

@vapvarun
Copy link

Complete developer-level documentation for BuddyPress Embeds, including how to override templates, use cases, REST API endpoints, and extending support.

Trac ticket: buddypress/bp-documentation#116


This Pull Request is for code review only. Please keep all other discussions in the BuddyPress Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the WordPress Core Handbook for more details.

@imath imath self-assigned this Sep 18, 2024
@imath imath added the documentation Pull Request about documenting BuddyPress label Sep 18, 2024
Copy link
Contributor

@imath imath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First thanks a lot for your PR @vapvarun Great work!

I believe we should create 2 documentation pages out of this PR.

  1. docs/user/components/activity/embed.md and add at the bottom of it links to the Advanced user section (Customizing templates, styles).
  2. docs/developer/component/extend/activity/embed.md

In 1. we should put lines 1 to 7, then lines 23 to 27 and lines 154 to 173. In 2. we should put lines 88 to 151 and Lines 12 to 19.


---

## REST API Endpoints for Embeds
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Developer documentation really starts here imho

Comment on lines +13 to +19
## Disabling Activity Embeds

If you prefer not to use activity embeds on your BuddyPress site, you can disable the feature using the following code snippet:

```php
add_filter( 'bp_is_activity_embeds_active', '__return_false' );
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part should probably be in the hooks page @emaralive is thinking about, see buddypress/bp-documentation#292

dcavins pushed a commit to dcavins/buddypress-wp-svn that referenced this pull request Oct 7, 2024
- Split @vapvarun’s PR to create `docs/developer/components/activity/embeds` and `docs/user/components/activity/embeds`.
- Update the Activity Embed Block’s documentation link in favor of the updated one.
- Deprecate `docs/developer/group-extension/README.md` in favor of `docs/developer/components/groups/extension` leaving a link to the second documentation page in the first one.
- Initialize a documentation page to explain how to override BP Styles to advanced users, see buddypress/bp-documentation#297

Props vapvarun

Closes buddypress/buddypress#376



git-svn-id: http://buddypress.svn.wordpress.org/trunk@14038 cdf35c40-ae34-48e0-9cc9-0c9da1808c22
emaralive pushed a commit to emaralive/omt-buddypress-sync that referenced this pull request Nov 2, 2025
- Split @vapvarun’s PR to create `docs/developer/components/activity/embeds` and `docs/user/components/activity/embeds`.
- Update the Activity Embed Block’s documentation link in favor of the updated one.
- Deprecate `docs/developer/group-extension/README.md` in favor of `docs/developer/components/groups/extension` leaving a link to the second documentation page in the first one.
- Initialize a documentation page to explain how to override BP Styles to advanced users, see buddypress/bp-documentation#297

Props vapvarun

Closes buddypress/buddypress#376



git-svn-id: https://buddypress.svn.wordpress.org/trunk@14038 cdf35c40-ae34-48e0-9cc9-0c9da1808c22
emaralive pushed a commit to emaralive/buddypress-sync that referenced this pull request Nov 3, 2025
- Split @vapvarun’s PR to create `docs/developer/components/activity/embeds` and `docs/user/components/activity/embeds`.
- Update the Activity Embed Block’s documentation link in favor of the updated one.
- Deprecate `docs/developer/group-extension/README.md` in favor of `docs/developer/components/groups/extension` leaving a link to the second documentation page in the first one.
- Initialize a documentation page to explain how to override BP Styles to advanced users, see buddypress/bp-documentation#297

Props vapvarun

Closes buddypress/buddypress#376



git-svn-id: https://buddypress.svn.wordpress.org/trunk@14038 cdf35c40-ae34-48e0-9cc9-0c9da1808c22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull Request about documenting BuddyPress

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants