Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 34 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,47 @@
## Dub Wordpress Plugin
# Dub Wordpress Plugin

Contributors:
Tags: tag1, tag2
Requires at least: 4.7
Tested up to: 6.6.2
Stable tag: 1.0.0
Requires PHP: 7.4
License: AGPLv3
License URI: https://www.gnu.org/licenses/agpl-3.0.en.html

Official WordPress integration for Dub. Create and manage your short links and track conversion events – directly inside Wordpress.
Official WordPress integration for Dub. Official WordPress integration for Dub. Shorten and manage your links directly in WordPress.

## Description

This is the official WordPress Integration for Dub.
This is the official WordPress plugin for Dub. You can use the plugin to shorten and manage your links directly in WordPress. Plugin supports both Post Types and Custom Post Types. You can also track conversion events from link click to account signups.

Here are the main features of the plugin:

Features:
- Automatically create short links when a new post is published
- Edit short link slugs directly inside WordPress
- Update short links for keys for existing posts
- Track [conversion events](https://dub.co/help/article/dub-conversions) from link click to account signups

## Frequently Asked Questions

1. How can I install the WordPress plugin?
## Installation

To install the WordPress plugin for Dub, follow these steps:
- Download the plugin from the [Official Github Repo](https://github.com/dubinc/wordpress/archive/refs/heads/main.zip)
- Follow the steps detailed in the [Installation](#installation) section below
1. Download the [latest version](https://github.com/dubinc/wordpress/tags) of the plugin.

2. Is the plugin free to use?
2. Go to your WordPress admin panel and click on the `Plugins` menu.

We have a generous [free plan](https://dub.co/pricing) at Dub that you can use to shorten and create up to 25 links a month. For higher limits, upgrade to our [Pro plan](https://dub.co/help/article/pro-plan).
3. Click on the `Add New Plugin` button and then click on the `Upload Plugin`.

## Installation
1. Once you have Downloaded the plugin, go to your WordPress admin panel and click on the `Plugins` menu.
2. Click on the `Add New` button.
3. Click on the `Upload Plugin` button which is located at the top near the Add Plugins header.
4. Click on the `Choose File` button and select the plugin zip file you downloaded.
5. Click on the `Install Now` button.
6. Once the plugin is installed, click on the `Activate Plugin` button.
7. You will see a new menu item called `Dub` in the WordPress admin panel under the `Settings` menu. Click on it to get started. ![Screenshot](screenshots/1.png)
8. Create an [API key](https://dub.co/docs/api-reference/tokens) in your Dub account and paste it in the `API Key` field. Click `Save Changes`![Screenshot](screenshots/2.png)
9. As you see in the image above, you will now be able to choose the Post Types that will be integrated with Dub. When a post type is selected, you will be able to create short links for old posts of that post type, while for new posts shortlinks will be automatically created. Click `Save Changes` to save your settings.
10. If you enter a onl Post, you will see a Dub meta box on the right side of the post editor. Here you can see the button to create a short link. ![Screenshot](screenshots/3.png)
11. Once a short link is created, you can edit the slug of the short link by clicking on the `Edit` button. The `Analytics for link` link will take you to the Analytics page on our website. ![Screenshot](screenshots/4.png)
12. Once you click on the `Edit` button you will be able to edit only the slug of the shortlink. Press `Update` to update it. ![Screenshot](screenshots/5.png)
12. If you create a new Post, the panel will show you a warning message, telling you that the short link will be created once the post is published. ![Screenshot](screenshots/6.png)

## Changelog

5. Install the plugin by clicking on the `Install Now` button.

6. Once the plugin is installed, click on the `Activate Plugin` button to activate it.

7. You will see a new menu item called `Dub` in the WordPress Admin panel under the `Settings` menu.

8. Create an [API key](https://dub.co/docs/api-reference/tokens) in your Dub account and paste it in the `API Key` field and click on the `Save Changes` button.

9. Choose the Post Types that will be integrated with Dub. When a post type is selected, you will be able to create short links for old posts of that post type, while for new posts shortlinks will be automatically created. Click `Save Changes` to save your settings.

![Screenshot](screenshots/1.png)

## Usage

You will now be able to see the Dub meta box on the right side of the post editor. Here you can see the button to create a short link for existing posts.

![Screenshot](screenshots/2.png)

Once a short link is created, you can edit the slug of the short link by clicking on the `Edit` button. The `Analytics for link` link will take you to the Analytics page on Dub.

![Screenshot](screenshots/3.png)

Once you click on the `Edit` button you will be able to edit only the slug of the shortlink.
Binary file modified screenshots/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed screenshots/4.png
Binary file not shown.
Binary file removed screenshots/5.png
Binary file not shown.
Binary file removed screenshots/6.png
Binary file not shown.