Skip to content
Docs
Get RestroPress

Filter

rpress_pickup_show_free_label

Updated
On this page

Filters whether the pickup chip shows a 'Free' sublabel.

Runs in the pickup branch of the checkout service chip sublabel logic. Return true to show 'Free', false to show no sublabel, or null (the default) to let core decide from fee-extension state.

Parameters#

ParameterTypeDescription
$show_freenullDefault null, meaning core decides.

Return value#

bool|null. True to show 'Free', false to hide it, null for the default behaviour.

Example#

function my_pickup_hide_free_label( $show_free ) {
	return false;
}
add_filter( 'rpress_pickup_show_free_label', 'my_pickup_hide_free_label' );

Source#

Applied in:

  • includes/rp-delivery-fee-basic.php (line 177), in rpress_get_checkout_service_fee_sublabel()

See also#

Was this page helpful?