the-markup/wp-shlink

Create and manage Shlink short links from WordPress

0.4.2 2024-07-30 19:28 UTC

Requires (Dev)

• phpunit/phpunit: ^9.6
• yoast/phpunit-polyfills: ^2.0

GPL-2.0-or-later

• The Markup

README

Create and manage Shlink short links from WordPress

Description

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:

• node.js (tested on v20)
• Docker Desktop

Build and start:

./bin/build
./bin/start

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.4.2

• Fix bug causing settings to not get saved
• Update dependencies

0.4.1

• Validate and sanitize settings

0.4.0

• Add search to manager interface
• URL validation on form inputs

0.3.1

• Remove Composer from installation

0.3.0

• Add pagination to Smol Links manager interface

0.2.0

• Update to Shlink v3 API

0.1.1

• Fix a bug with the Short Links manager
• Upgrade dependencies

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