Skip to content

Conversation

@Mamaduka
Copy link
Member

What?

Closes #70774.

PR adds guidelines for including new social services in the core and a section about extensibility.

The guideline borrows from the core oEmbed provider "rules" - https://make.wordpress.org/core/handbook/contribute/design-decisions/#adding-new-oembed-providers.

Testing Instructions

Review the proposed documentation.

@Mamaduka Mamaduka self-assigned this Jul 29, 2025
@Mamaduka Mamaduka added [Type] Developer Documentation Documentation for developers [Block] Social Affects the Social Block - used to display Social Media accounts labels Jul 29, 2025

## Adding custom social icons

Starting from WordPress 6.9, it's possible to add custom social icons to your site. Here's an example plugin: https://github.com/wptrainingteam/devblog-custom-social-icons.
Copy link
Member Author

Choose a reason for hiding this comment

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

We could include the dev block post when it's published.

Copy link
Contributor

@bph bph Jul 29, 2025

Choose a reason for hiding this comment

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

For now I would link to the PR that makes it possible in Gutenberg. And once the dev blog post is published add it to the readme. Although the example plugin is certainly educational it only goes together with the Developer Blog post.

@github-actions
Copy link

github-actions bot commented Jul 29, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: Mamaduka <[email protected]>
Co-authored-by: bph <[email protected]>
Co-authored-by: priethor <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Contributor

@bph bph left a comment

Choose a reason for hiding this comment

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

Hi @Mamaduka I have a few suggestions for rewording things.


## Adding custom social icons

Starting from WordPress 6.9, it's possible to add custom social icons to your site. Here's an example plugin: https://github.com/wptrainingteam/devblog-custom-social-icons.
Copy link
Contributor

@bph bph Jul 29, 2025

Choose a reason for hiding this comment

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

For now I would link to the PR that makes it possible in Gutenberg. And once the dev blog post is published add it to the readme. Although the example plugin is certainly educational it only goes together with the Developer Blog post.

@Mamaduka
Copy link
Member Author

Thanks, @bph!

A small note: I've used the oEmbed provider guidelines as a template. Some of your suggestions could apply there as well.

@Mamaduka
Copy link
Member Author

@bph, updated the new guidelines based on your feedback. Thank you!

Copy link
Contributor

@priethor priethor left a comment

Choose a reason for hiding this comment

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

Now that we have a readme file, should we add a section with a list of supported services? We have a file for each service, but is there any edge case (like Twitter and X) that it could help clarify?

@bph
Copy link
Contributor

bph commented Jul 30, 2025

@Mamaduka here is a screenshot of all variations in core, you could add to the readME...

Would that work @priethor
Screenshot 2025-07-30 at 12 39 22
I might have misunderstood what you envisioned, though.

@priethor
Copy link
Contributor

I worry that keeping an image with all the icons needs to be redone every time a variation is added/removed/updated, even if it's not common 😅 . I was thinking of adding a simple list with each service, a link, and maybe the version it was introduced at?

@Mamaduka
Copy link
Member Author

maybe the version it was introduced at?

This might be a bit hard to track down 😅

@priethor
Copy link
Contributor

I'm only thinking out loud, it's fine otherwise 😆

Copy link
Contributor

@priethor priethor left a comment

Choose a reason for hiding this comment

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

Looks good to me after addressing the feedback; my suggestion is not a blocker.

@Mamaduka
Copy link
Member Author

Thank you, @bph and @priethor!

Let's merge this for now. I would like to have guidelines to point to in the new PRs at hand when the time comes.

We can decide about maintaining the list of available services later.

@Mamaduka Mamaduka merged commit 4c3e4c4 into trunk Jul 30, 2025
61 checks passed
@Mamaduka Mamaduka deleted the add/social-link-block-guidelines branch July 30, 2025 15:14
@github-actions github-actions bot added this to the Gutenberg 21.4 milestone Jul 30, 2025
adamsilverstein pushed a commit to adamsilverstein/gutenberg that referenced this pull request Jul 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Block] Social Affects the Social Block - used to display Social Media accounts [Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Social: Document guidelines for adding new social services

4 participants