Skip to content

Latest commit

 

History

History
69 lines (39 loc) · 3.05 KB

DEVELOPER-DOCS.md

File metadata and controls

69 lines (39 loc) · 3.05 KB
Raw

Developer Documentation

Hooks

The plugin is further customizable via four hooks. Such code should ideally be put into a mu-plugin or site-specific plugin (which is beyond the scope of this readme to explain).

c2c_years_ago_today-email_cron_time (filter)

The c2c_years_ago_today-email_cron_time hook allows you to customize the time of day to email the Years Ago Today email to those who have opted-in to it. By default this is "9:00 am".

Arguments:

  • $time (string): The time of day to email the Years Ago Today email to those who have opted-in to it. Default "9:00 am".

Example:

// Send daily Years Ago Today emails at end of day.
add_filter( 'c2c_years_ago_today-email_cron_time', function ( $time ) { return "6:00 pm"; } );

c2c_years_ago_today-email-if-no-posts (filter)

The c2c_years_ago_today-email-if-no-posts filter is used to override whether the daily Years Ago Today email is sent out on days that don't have any posts in prior years. By default this value is false, meaning no email is sent in such circumstances.

Arguments:

  • $send (boolean): Send the daily Years Ago Today email on days that have no prior year posts? Default false.

Example:

// Send daily Years Ago Today email even if there aren't any posts posted in prior years.
add_filter( 'c2c_years_ago_today-email-if-no-posts', '__return_true' );

c2c_years_ago_today-email-body-no-posts (filter)

The c2c_years_ago_today-email-body-no-posts filter is used to customize the content of the body of the daily Years Ago Today email when it is sent on days that had no posts in prior years.

Arguments:

  • $text (string): The content of the email. You can optionally include "%1$s" as a placeholder for the site name and "%2$s" as a placeholder for the date. Default 'No posts were published to the site %1$s on <strong>%2$s</strong> in any past year.'.

Example:

// Define custom email text for daily Years Ago Today email when there are no posts to list.
add_filter( 'c2c_years_ago_today-email-body-no-posts', function ( $text ) { return "Sorry, no posts were made on this day in any prior year."; } );

c2c_years_ago_today-first_published_year (filter)

The c2c_years_ago_today-first_published_year filter allows defining the earliest year to be considered when finding earlier published posts. By default this is false, which causes the plugin to determine the earliest year via a database query. The queried value does get cached, though may not persist depending on your site setup. This filter can be used to prevent the need for the query or to set a year later than the earliest published year (in case you'd prefer not to feature or be reminded of the early years).

Arguments:

  • $year (string|false): The year of the first published post. False indicates the year should be queried for. Default false.

Example:

// Set the earliest published post year for Years Ago Today.
add_filter( 'c2c_years_ago_today-first_published_year', function ( $year ) { return '2009'; } );