sectsect/wp-tag-order

Sort the tags manually in individual posts on wordpress.

v3.9.5 2024-11-23 07:19 UTC

Requires

• php: >=8.0

Requires (Dev)

• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^7.5 || ^9.5
• squizlabs/php_codesniffer: ^3.7
• szepeviktor/phpstan-wordpress: ^1.3
• wp-coding-standards/wpcs: ^3.0
• yoast/phpunit-polyfills: ^2.0

GPL-3.0+

• SECT WEB INTERACTIVE

• plugin
• wordpress
• order
• github
• tags

README

Order tags independently in each posts (not site-globally) on WordPress with simple Drag-and-Drop ↕︎ sortable feature.

Important

This plugin is NOT compatible with Gutenberg on WordPress 5.x. Consider using Classic Editor Plugin.

Important

Mutation events will no longer be supported in Google Chrome and Edge in July 2024 (Google Chrome on July 23, 2024, and Microsoft Edge the week of July 25, 2024). As a result, WP Tag Order versions 3.6.0 or less will not work with Chrome v127 and later, which will be released on July 23, 2024.
You have to update to v3.7.0 or later.
If you still need PHP7 support, see Troubleshooting below.
See Chrome for Developers Blog for more details.

Get Started

1. Clone this Repo into your wp-content/plugins directory.

cd /path-to-your/wp-content/plugins
git clone [e-mail]:sectsect/wp-tag-order.git

1. Activate the plugin through the Plugins menu in WordPress.
2. Go to Settings -> WP Tag Order page to select which taxonomies to enable ordering for.

Features

• 🏷️ Custom tag ordering for posts
• 🔍 Works with default WordPress tag and custom taxonomy systems
• 🔢 Drag-and-Drop interface for easy tag reordering
• 📊 Supports multiple post types and taxonomies
• 🌐 NEW: REST API Support
  • Retrieve ordered tags via GET endpoint
  • Update tag order programmatically
  • Supports authentication and permissions
• 🚀 Lightweight and performance-optimized

Notes

• When creating a new post, you need to save it once to enable tag ordering.
• To apply ordering to existing posts, "Add and Remove" any tag once.
• To bulk-update multiple posts at once, go to Settings -> WP Tag Order page and click 'Apply' under the Advanced Settings.

• Tested on WordPress v6.3.1.

Requirements

• WordPress 5.6+
• PHP 8.0+

APIs

Usage Example

get_the_tags_ordered()

<?php
$terms = get_the_tags_ordered();
if ( $terms && ! is_wp_error( $terms ) ) :
?>
<ul>
    <?php foreach ( $terms as $term ) : ?>
        <li>
            <a href="<?php echo get_term_link( $term->slug, 'post_tag' ); ?>">
                <?php echo $term->name; ?>
            </a>
        </li>
    <?php endforeach; ?>
</ul>
<?php endif; ?>

get_the_terms_ordered()

<?php
$terms = get_the_terms_ordered( $post->ID, 'post_tag' );
if ( $terms && ! is_wp_error( $terms ) ) :
?>
<ul>
    <?php foreach ( $terms as $term ) : ?>
        <li>
            <a href="<?php echo get_term_link( $term->slug, 'post_tag' ); ?>">
                <?php echo $term->name; ?>
            </a>
        </li>
    <?php endforeach; ?>
</ul>
<?php endif; ?>

get_the_tag_list_ordered()

<?php echo get_the_tag_list_ordered(); ?>

get_the_term_list_ordered()

<?php echo get_the_term_list_ordered( $post->ID, 'post_tag' ); ?>

the_tags_ordered()

<?php the_tags_ordered(); ?>

the_terms_ordered()

<?php the_terms_ordered( $post->ID, 'post_tag' ); ?>

REST API

The WP Tag Order plugin provides two REST API endpoints for managing tag order:

Get Tag Order

• Endpoint: /wp-json/wp-tag-order/v1/tags/order/{post_id}
• Method: GET
• Parameters:
  • post_id (required): The ID of the post
  • taxonomy (optional): Taxonomy name (defaults to 'post_tag')
• Permissions: Publicly accessible
• Response: Array of ordered tags with full term details

Example Request

GET /wp-json/wp-tag-order/v1/tags/order/123

w/ cURL

curl --location 'https://your-wordpress-site.com/wp-json/wp-tag-order/v1/tags/order/123'

Update Tag Order

• Endpoint: /wp-json/wp-tag-order/v1/tags/order/{post_id}
• Method: PUT or PATCH
• Parameters:
  • post_id (required): The ID of the post
  • taxonomy (required): Taxonomy name
  • tags (required): Comma-separated list of tag IDs in desired order
• Permissions: Requires user authentication and post edit capabilities
• Response: Success status and message

Example Request

PUT /wp-json/wp-tag-order/v1/tags/order/123
{
  "taxonomy": "post_tag",
  "tags": "5,3,1,4,2"
}

w/ cURL

curl --location --request PUT 'https://your-wordpress-site.com/wp-json/wp-tag-order/v1/tags/order/123' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_JWT_TOKEN' \
--data '{
  "taxonomy": "post_tag",
  "tags": "5,3,1,4,2"
}'

Example Response

{
  "success": true,
  "code": "tags_order_updated",
  "message": "Tag order updated successfully.",
  "data": {
    "status": 200,
    "post_id": 123,
    "taxonomy": "pickup_tag",
    "tags": [
      5,
      3,
      1,
      4,
      2
    ]
  }
}

Authentication

• GET requests are publicly accessible
• PUT/PATCH requests require:
  • User to be logged in
  • User to have edit permissions for the specific post
  • Post must be of an allowed type (default: 'post' or 'page')

For Developers

• The ordered tag data is serialized and stored in the wp_postmeta table under keys like wp-tag-order-{taxonomy}.

• This Plugin does not hosting on the wordpress.org repo in order to prevent a flood of support requests from wide audience. Your feedback is welcome.

Troubleshooting

Still need support for PHP 7.

I have a branch php7 to support PHP 7 and End-of-Life for JaveScript Mutation events.
The branch will not be maintained anymore, so I recommend you migrate to PHP 8.

Change log

See CHANGELOG file.

License

See LICENSE file.

✌️

_{^{A little project by @sectsect}}