Allow filtering of expiration in set_transient()

[wpsmith]

I recently needed to change an expiration of a transient and expected pre_set_site_transient_* filter to be able to do that. However, the filter only affects the value. I recommend adjusting this to affect both.

[obenland]

AFAIK, filters are only supposed to filter the first supplied argument. So $expirationprobably should get its own filter.

[wpsmith]

Replying to obenland:

AFAIK, filters are only supposed to filter the first supplied argument. So $expirationprobably should get its own filter.

Yes that's right. I knew that! Adjusted patch for one filter.

[wpsmith]

Site Transient Filter Adjustment, first pass

[nacin]

extract( $options, EXTR_OVERWRITE ); is dangerous and not something we're likely going to do here, as it doesn't fit patterns found throughout. Please do not replace patches, we can't see what changed — I actually can't tell if this was the original patch, or a replacement.

[wpsmith]

Replying to nacin:

extract( $options, EXTR_OVERWRITE ); is dangerous and not something we're likely going to do here, as it doesn't fit patterns found throughout. Please do not replace patches, we can't see what changed — I actually can't tell if this was the original patch, or a replacement.

My apologies. The first one was VERY much similiar to the one that's there now using extract. I've added a couple more options.

[wpsmith]

Option 3: New filter

[wpsmith]

Option 2: Same filter different 2nd value.

[wpsmith]

Option 1: Reworked, removed extract()

[nacin]

I don't understand how 21330_opt2.patch​ would work in a plugin.

Could you go a bit more into your use case, perhaps some sample code?

[wpsmith]

Replying to nacin:

I don't understand how 21330_opt2.patch​ would work in a plugin.

Could you go a bit more into your use case, perhaps some sample code?

The expiration time is always set (right? if not set, it's set to 0 by the time of the filter) and is always an integer. For example, wp_check_browser_version() has a set expiration that is known. So...assuming I knew the $key (93ce43dc55bd29ecc99e83ca12b5d7f4) in this example.

add_filter( 'pre_set_site_transient_browser_93ce43dc55bd29ecc99e83ca12b5d7f4', 'wps_change_browser_transient' );
function wps_change_browser_transient( $val ) {
    if ( is_int( $val ) && 604800 == $val )
        $val = 1209600;

    return $val;
}

However, I am not convinced that this is the best solution...

[wpsmith]

Option 4: Combo of Option 3 & modified Option 1

[obenland]

In 21330_opt4.patch​, what do you need the option part for? Value and expiration are both filterable at this point.

[nacin]

If we were to do this, it would probably look like 21330.diff​.

[mordauk]

I haven't personally had the need to do this, but it seems perfectly reasonable that a plugin would want to. For example, in ​Easy Digital Downloads we use transients for caching some earnings data. If our cache is too aggressive or too weak, a user could better tweak our transient expirations to better suit their site.

[wonderboymusic]

Let's decide soon in 3.9

[nacin]

As evidenced by IRC, naming this filter is a pain.

But also:

<?php
add_action( 'set_transient_my_transient', function( $value, $expiration ) {
    $desired_expiration = 600;
    if ( $expiration != $desired_expiration ) {
        set_transient( 'my_transient', $value, $desired_expiration );
    }
});

[chriscct7]

Refreshed and good to go

[DrewAPicture]

@chriscct7: Only one instance of the filter needs a hook doc, the second one needs a duplicate hook comment ;-)

[chriscct7]

@drewapicture my bad! Thanks

[obenland]

In 21330.diff​ the filters had two different names. Was that changed intentionally?

[chriscct7]

I can move it back to using the same filter. I thought it'd be easier to set the transients using a single filter. Just a sec

[chriscct7]

Ok, new patch moves it back to 2 filters and adds a full docbloc for the second one now that it's a unique filter.

[DrewAPicture]

I'm tempted to recommend that we skip adding the second filter pending the resolution of #28290. I don't want to end up in a situation where we introduce a new "site_transient" filter here in 4.4, and a version later end up having to introduce a new one to match the "network_transient" vernacular.

[DrewAPicture]

@jeremyfelt: What would be your preference on the naming of the site transient hook? Should we go with "site" or "network" following [34778]?

[jeremyfelt]

Replying to DrewAPicture:

@jeremyfelt: What would be your preference on the naming of the site transient hook? Should we go with "site" or "network" following [34778]?

I think sticking with site makes sense for consistency. I don't foresee a near term strategy for handling cross-network transients, so these functions will probably stay as is for a bit.

[wonderboymusic]

In 34865:

Transients, add filters for $expiration:

• 'expiration_pre_set_site_transient_' . $transient
• 'expiration_pre_set_transient_' . $transient

Props chriscct7, wpsmith, nacin.
Fixes #21330.

[chriscct7]

@ocean90 and I discussed right after this was committed to changing the filter names to expiration_of_transient_{transient} and expiration_of_site_transient_{transient}. Attached is a patch for that.

[chriscct7]

extra space in the previous patch

[chriscct7]

Updated filter names

[chriscct7]

Patch 7 uses pre_set_transient_{$transient}_expiration and pre_set_site_transient_{$transient}_expiration which @DrewAPicture preferred

[SergeyBiryukov]

Looking at the ​IRC discussion, pre_set_transient_{$transient}_expiration is still a potential namespace conflict, which we were trying to avoid.

Let's go with expiration_of_(site_)transient_{$transient}.

[chriscct7]

Per comment:32 closing as this is what is currently in, per [34865]

[chriscct7]

Actually its not.

[chriscct7]

21330.6.patch is the one requested in comment:32

[ocean90]

In 34877:

Transients: Rename filters added in [34865].

• expiration_pre_set_transient_$transient => expiration_of_transient_$transient
• expiration_pre_set_site_transient_$transient => expiration_of_site_transient_$transient

Fix hook docs.

Props chriscct7.
Fixes #21330.

[SergeyBiryukov]

In 34878:

Transients: Clarify the expiration_of_site_transient_$transient filter description.

See #21330.