Fix fatal error for Post_Meta hook return type #39

r-a-y · 2020-10-09T01:32:29Z

This PR switches the return type for Post_Meta\remove_schedule() and Post_Meta\update_schedule() from bool to void because those functions:

Are hooked to an action, not a filter; and
Returns Unpublish\unschedule_unpublish(), which can be an integer, not a bool:

Unpublish/inc/namespace.php

Lines 42 to 48 in 21a3126

    
            * @return mixed On success an integer indicating number of events unscheduled 
        
            *               (0 indicates no events were registered with the hook and 
        
            *               arguments combination), false if unscheduling one or more events fail. 
        
            */ 
        
           function unschedule_unpublish( int $post_id ) { 
        
           	return wp_clear_scheduled_hook( CRON_KEY, [ $post_id ] ); 
        
           }

This can throw the following fatal error when deleting or updating a post that has an unpublish timestamp:

PHP Fatal error: Uncaught TypeError: Return value of HM\Unpublish\Post_Meta\remove_schedule() must be of the type bool, int returned in /wp-content/plugins/Unpublish/inc/post-meta.php:71

Stack trace:
#0 /wp-includes/class-wp-hook.php(289): HM\Unpublish\Post_Meta\remove_schedule(Array, 354, 'unpublish_times...')
#1 /wp-includes/class-wp-hook.php(311): WP_Hook->apply_filters(NULL, Array)
#2 /wp-includes/plugin.php(478): WP_Hook->do_action(Array)
#3 /wp-includes/meta.php(965): do_action('deleted_post_me...', Array, 354, 'unpublish_times...', '1602519250')
#4 /wp-includes/post.php(3066): delete_metadata_by_mid('post', 1046)
#5 /wp-admin/post.php(318): wp_delete_post(354, true)
#6 {main} thrown in /wp-content/plugins/Unpublish/inc/post-meta.php on line 71

This commit switches the return type from bool to void, since remove_schedule() is hooked to an action, not a filter. Also, Unpublish\unschedule_unpublish() can return an integer and not a bool, which can throw a fatal error.

Same as remove_schedule() fix, but for update_schedule().

Fix fatal error for Post_Meta\remove_schedule() return type.

2be32d5

This commit switches the return type from bool to void, since remove_schedule() is hooked to an action, not a filter. Also, Unpublish\unschedule_unpublish() can return an integer and not a bool, which can throw a fatal error.

hm-linter bot approved these changes Oct 9, 2020

View reviewed changes

Fix fatal error for Post_Meta\update_schedule() return type.

4e27253

Same as remove_schedule() fix, but for update_schedule().

r-a-y changed the title ~~Fix fatal error for Post_Meta\remove_schedule() return type~~ Fix fatal error for Post_Meta hook return type Mar 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix fatal error for Post_Meta hook return type #39

Fix fatal error for Post_Meta hook return type #39

r-a-y commented Oct 9, 2020 •

edited

Loading

	* @return mixed On success an integer indicating number of events unscheduled
	* (0 indicates no events were registered with the hook and
	* arguments combination), false if unscheduling one or more events fail.
	*/
	function unschedule_unpublish( int $post_id ) {
	return wp_clear_scheduled_hook( CRON_KEY, [ $post_id ] );
	}

Fix fatal error for Post_Meta hook return type #39

Are you sure you want to change the base?

Fix fatal error for Post_Meta hook return type #39

Conversation

r-a-y commented Oct 9, 2020 • edited Loading

r-a-y commented Oct 9, 2020 •

edited

Loading