https://github.com/rtcamp/mention-links
Plugin which brings Github style user @mentions and article #links to the WordPress
https://github.com/rtcamp/mention-links
Last synced: 4 months ago
JSON representation
Plugin which brings Github style user @mentions and article #links to the WordPress
- Host: GitHub
- URL: https://github.com/rtcamp/mention-links
- Owner: rtCamp
- Created: 2020-05-29T07:32:16.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-13T12:32:55.000Z (6 months ago)
- Last Synced: 2026-01-13T15:36:51.995Z (6 months ago)
- Language: TypeScript
- Homepage:
- Size: 3.91 MB
- Stars: 5
- Watchers: 27
- Forks: 2
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mention Links
[](https://www.repostatus.org/#active)
This plugin lets you mention a user or a post (including Custom Post Types) in a post content from the Block editor. Type `@` to link to an author or `#` to link to a post, page, or custom post type.
**Author:** rtCamp
**Contributors:** rtcamp, sid177, dharmin, vaishu.agola27, pavanpatil1, mukulsingh27
**Tags:** Mentions, User mentions, Post mentions, Custom post types mentions, CPT mentions
**Requires at least:** 5.0
**Tested up to:** 6.4.1
**Requires PHP version:** 7.0
**Stable tag:** 1.0.4
**License:** GPLv2 or later (of course!)
**License URI:** http://www.gnu.org/licenses/gpl-2.0.html
## Description ##
While writing contents from the Block editor, type `@` to get suggestions of users. On selecting a user it'll create a link to authors page of that user.
To mention a post, type `#` and it'll give you the list of all matching posts. On selecting a post it'll create a link to the single post page.
### Screenshots ###
Plugin features:
Settings page (wp-admin -> Settings -> Mention Links):
### Settings ###
This plugins adds a settings page under Settings -> Mention Links.
1. **Display username or display-name:** This setting allows you choose whether to show user's display-name or username when mentioning a user in a post.
2. **Custom Post Types support:** Checking post types here will give you suggestions of posts from these post types.
**Note:** The posts suggestion list is retrieved from the WordPress' REST API, so if a particular post type doesn't support REST API then you might not see it in **Custom Post Types support** setting.
## Installation ##
1. Extract the zip file.
2. Upload it to the `/wp-content/plugins/` directory in your WordPress installation.
3. Activate the Mention Links from your Plugins page.
## Contribute
### Reporting a bug 🐞
Before creating a new issue, do browse through the [existing issues](https://github.com/rtCamp/mention-links/issues) for resolution or upcoming fixes.
If you still need to [log an issue](https://github.com/rtCamp/mention-links/issues/new), making sure to include as much detail as you can, including clear steps to reproduce your issue if possible.
### Creating a pull request
Want to contribute a new feature? Start a conversation by logging an [issue](https://github.com/rtCamp/mention-links/issues).
Once you're ready to send a pull request, please run through the following checklist:
1. Browse through the [existing issues](https://github.com/rtCamp/mention-links/issues) for anything related to what you want to work on. If you don't find any related issues, open a new one.
1. Fork this repository.
1. Create a branch from `develop` for each issue you'd like to address and commit your changes.
1. Push the code changes from your local clone to your fork.
1. Open a pull request and that's it! We'll with feedback as soon as possible (Isn't collaboration a great thing? 😌)
1. Once your pull request has passed final code review and tests, it will be merged into `develop` and be in the pipeline for the next release. Props to you! 🎉
# BTW, We're Hiring!
