post_stuck

Fires once a post has been added to the sticky list.

Description

do_action( 'post_stuck', (int) $post_id ); 

Parameters (1)

0. $post_id (int)
ID of the post that was stuck.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'post_stuck', $post_id ); 
The following example is for adding a hook callback.
  1. // define the post_stuck callback 
  2. function action_post_stuck( $post_id ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'post_stuck', 'action_post_stuck', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'post_stuck', 'action_post_stuck', 10, 1 ); 

Defined (1)

The action is defined in the following location(s).

/wp-includes/post.php  
  1. do_action( 'post_stuck', $post_id );