alleyinteractive/expiring-posts

Automatically Expire Posts

v0.2.0 2023-10-28 02:21 UTC

Requires (Dev)

• alleyinteractive/alley-coding-standards: ^1.0
• mantle-framework/testkit: ^0.9
• nunomaduro/collision: ^5.0
• phpunit/phpunit: ^9.3.3

GPL-2.0-or-later

• Alley Interactive

README

Automatically expire posts after a certain period of time. Checks the post's published and modified date to see if the post is expired and will perform an action on the post (draft/trash/delete it).

Usage

Registering Post Types

Posts that are expired can be made into draft or trash posts or outright deleted.

Register a post type to be drafted after a month

expiring_posts_add_post_type(
	$post_type,
	[
		'action'       => 'draft',
		'expire_after' => MONTH_IN_SECONDS,
	],
);

Register a post type to be trashed after a week

expiring_posts_add_post_type(
	$post_type,
	[
		'action'       => 'trash',
		'expire_after' => WEEK_IN_SECONDS,
	],
);

Register a post type to be deleted after a week

expiring_posts_add_post_type(
	$post_type,
	[
		'action'       => 'delete',
		'expire_after' => WEEK_IN_SECONDS,
	],
);

Register a post type to be updated after a week

expiring_posts_add_post_type(
	$post_type,
	[
		'action'       => 'update',
		'expire_after' => WEEK_IN_SECONDS,
		'update_args'  => [
			'meta_input' => [
				'key' => 'value',
			],
		],
	],
);

// Or use a callback to define the arguments. The callback
// is passed an instance of WP_Post.
expiring_posts_add_post_type(
	$post_type,
	[
		'action'       => 'update',
		'expire_after' => WEEK_IN_SECONDS,
		'update_args'  => fn ( WP_Post $post ) => [
			'post_title' => 'Expired: ' . $post->post_title,
		],
	],
);

By default, the post type will be set to be drafted after a year.

Hooks

expiring_posts_is_post_expired

Filter applied to check if a post is expired.

Props:

• $is_expired: bool Whether the post is expired.
• $post: WP_Post Post to check.
• $threshold: int Threshold to check against (unix timestamp).
• $now: int Current timestamp.

expiring_posts_cron_interval

Interval to run the expiration check. Defaults to every hour.

expiring_posts_expired

Action fired when a post was expired.

Props:

• $post_id: int Post ID
• $post: WP_Post Post object.

expiring_posts_query_args

Filter applied to the query arguments used to find expired posts.

Props:

• $args: array Query arguments.
• $now: int Current timestamp.

Unregister a post type

expiring_posts_remove_post_type( $post_type );

Testing

composer test

License

Released under the GPL v2 license.