Hooks for post sticky status changes

[ojrask]

Currently sticky post status changes are hookable using the update_option hook variants which are fired when stick_post and unstick_post functions are called.

Getting the sticked post in those hooks is a little bit annoying, as you have to parse old and new values for an updated option.

I'd suggest adding action hooks to stick_post and unstick_post to fire some action called such as

<?php

do_action('post_sticked', $post->ID);
do_action('post_unsticked', $post->ID);

I could not find any straightforward hook that allows hooking as described above.

Let me know if there is a feature like the one above which I could not find, and whether the suggested enhancement would be good or bad, or in need of more discussion.

One thing I would like to know whether this would have broader benefits or whether this would be considered a small goal for a very small portion of developers.

Marked the version as latest stable, but I presume the feature is not available in any version which has included sticky posts.

[ojrask]

Patch for #35600, includes logic and tests.

[SergeyBiryukov]

New hooks need to be documented as per the ​documentation standards.

[ojrask]

Oh boy, completely forgot about that one. Let me adjust the patch and send a new one.

[ojrask]

Adjusted patch, adds inline hook PHP documentation.

[ojrask]

I used @since 4.5.0 as saw that one elsewhere too. Should be adjusted in case this is implemented to some earlier version.

[ojrask]

Changed the version to 2.7 as hooks in their current state were introduced in 2.1 and sticky posts arrived in version 2.7.

[ocean90]

@ojrask The tests must be compatible with PHP 5.2. For testing hooks I suggest to use MockAction from /tests/phpunit/includes/utils.php.

[ojrask]

I see, let me adjust the patch accordingly.

[screamingdev]

How is this different from using the action "update_option_sticky_posts" ? Just asking.

[voldemortensen]

@ojrask In addition to updating the unit tests to be PHP 5.2 compatible, the hook names should be post_stuck and post_unstuck as stuck is the past (past participle) of stick. The dead line for enhancements for 4.6 is about a month away (June 29) if you're still interested in pursuing this patch.

[ojrask]

@voldemortensen I'll see that the patch is updated accordingly. Stuck and unstuck do make sense.

@screamingdev Using the update_option_$key hook is cumbersome and requires the developer to do some option value juggling (to parse the difference before and after), instead of a hook providing the exact post ID which was stuck or unstuck. Please correct me if this is not the case. :)

[ojrask]

Rename hooks, make tests work in PHP 5.2

[ojrask]

Added a revised patch (35600-2.diff), which renames stick -> stuck and unstick -> unstuck, also adjusts tests so they should work fine in PHP 5.2. Additionally changed @since from 4.5.0 to 4.6.0.

Let me know if something is still in need of adjustments. :)

[netweb]

@ojrask The tests should also use the same Orwellian Newspeak unstuck rather than unstickied, unstick, unsticking etc :)

[ojrask]

Fix wording in tests

[ojrask]

@netweb patch 35600-3.diff should fix that issue.

[netweb]

35600-3.diff​ looks good @ojrask

[swissspidy]

In 37857:

Posts: Add hooks for post sticky status changes.

This adds a new post_stuck action that fires when a post is made sticky and a post_unstuck action that fires when the sticky flag is removed again.

Props ojrask.
Fixes #35600.