the-markup/wp-shlink

Create and manage Shlink short links from WordPress

Installs: 23

Dependents: 0

Suggesters: 0

Security: 0

Stars: 8

Watchers: 3

Forks: 1

Type:wordpress-plugin

v0.1.0 2022-10-26 18:25 UTC

This package is not auto-updated.

Last update: 2024-03-24 06:48:44 UTC


README

Contributors: dphiffer
Donate link: https://themarkup.org/donate
Tags: short url, shlink
Requires at least: 4.5
Tested up to: 6.0.0
Requires PHP: 7.3
Stable tag: 0.1.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Create and manage Shlink short links from WordPress

Description

This plugin is a work in progress; development is ongoing.

A WordPress dashboard interface for managing a self-hosted Shlink URL shortener instance.

  • Create and edit Shlinks short links from a manager interface
  • Optionally generate new short URLs upon saving new posts
  • Manage multiple short URL domains, with an assigned default
  • Automatically tag each short link, configurable with a filter hook
  • Customize long URLs automatically using a filter hook (e.g., to add query arguments)
  • Integrates with WordPress Sentry plugin, if installed

Filter hooks

  • smol_links_tags - assigns tags to each saved short link (default: ["smol-links-server:$hostname", "smol-links-user:$username"])
  • smol_links_long_url - automatically adjust the long URL redirect
  • smol_links_manager_tabs - customizes the manager tabs (array: ["Tab label" => [Shlink API query]])

Developer setup

Developer dependencies:

Build and start:

./bin/build.sh
./bin/start.sh

Running tests:

docker-compose exec web composer --working-dir="/var/www/html/wp-content/plugins/smol-links" test

Installation

  1. Upload smol-links folder to the /wp-content/plugins/ directory
  2. Activate the plugin through the 'Plugins' menu in WordPress
  3. Configure the Smol Links settings from your WordPress dashboard

Screenshots

  1. Create and manage Shlink short links from WordPress.
  2. Configure your self-hosted Shlink server and optionally generate a short URL whenever a post is published.
  3. The post editor includes the short URL in the sidebar.

Changelog

0.1.0

  • Release to WordPress plugin directory
  • Security improvements

0.0.1

  • Generate short URLs upon saving a post
  • Create/edit short URLs from a manager

Upgrade Notice