https://github.com/ssnepenthe/wp-hashids
Hashids implementation for WordPress.
https://github.com/ssnepenthe/wp-hashids
hashids php wordpress wordpress-plugin
Last synced: 6 months ago
JSON representation
Hashids implementation for WordPress.
- Host: GitHub
- URL: https://github.com/ssnepenthe/wp-hashids
- Owner: ssnepenthe
- License: gpl-2.0
- Created: 2017-05-02T01:54:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-08T18:53:16.000Z (over 2 years ago)
- Last Synced: 2025-04-03T10:01:33.876Z (6 months ago)
- Topics: hashids, php, wordpress, wordpress-plugin
- Language: PHP
- Size: 118 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wp-hashids
This plugin provides a [Hashids](http://hashids.org/php/) implementation for WordPress.
## Requirements
WordPress 4.7 or greater, PHP 5.6 or greater and Composer.
## Installation
Install using Composer:
```
$ composer require ssnepenthe/wp-hashids
```
## Usage
Once the plugin is activated, browse to `wp-admin > settings > permalinks` and set a custom structure which contains the tag `%hashid%`.
If you need to manually interact with the underlying Hashids instance for some reason, it can be accessed by calling `_wph_instance( 'hashids' )`.
## Configuration
Sensible defaults are automatically set for you.
If you wish to set custom values, there are two methods for doing so:
1) Define any number of `WP_HASHIDS_*` constants (preferred)
2) Browse to `wp-admin > settings > wp hashids` and set the values via the provided interface.
The following constants can be used for configuration:
* `WP_HASHIDS_ALPHABET` - valid options are `lower`, `upper`, `lowerupper`, `lowernumber`, `uppernumber`, and `all`. You will need to manually flush rewrite rules after changing this constant by going to `settings > permalinks`.
* `WP_HASHIDS_MIN_LENGTH` - can be any integer >= 0.
* `WP_HASHIDS_SALT` - should be a unique string to ensure hashids are unique to your site.
Keep in mind that any changes to the plugin settings will immediately change all post URLs that use the `%hashid%` rewrite tag, and as such, should only be modified immediately after plugin activation.
If all three constants are configured, the `WP Hashids` settings page will not be visible.
## Considerations
As mentioned previously, changing any config value will result in all of your post URLs changing. This should only be done immediately after installing the plugin.
This plugin provides a method of obfuscating post IDs in URLs, however it makes no attempt to hide them anywhere else. If you need to completely mask post IDs from your users, look elsewhere.
Custom post types are supported but you will need to configure a custom permastruct using `add_permastruct()` if you want to remove the post name from the URL.
## Warning
**HASHIDS ONLY PROVIDES OBFUSCATION OF IDS IN PERMALINKS.**
**IT DOES NOT PROVIDE ENCRYPTION AND IT IS NOT SECURE.**
**YOU SHOULD ASSUME THAT YOUR SALT CAN AND WILL BE READ BY ANYONE THAT CAN VIEW YOUR SITE!**
**FOR THIS REASON, YOU SHOULD NOT (RE)USE ANY SENSITIVE INFORMATION (LIKE PASSWORDS OR CORE SALTS) FOR YOUR HASHIDS SALT.**
**YOUR SALT SHOULD BE A UNIQUE VALUE THAT IS ONLY USED BY THIS PLUGIN.**
**FOR MORE INFORMATION, CHECK THE LINKS LISTED [HERE](http://hashids.org/#decoding).**