Skip to content
Docs
Get RestroPress

Filter

rpress_sepcial_instruction

Updated
On this page

Filters the special instruction text read from a cart item.

Applied when a cart item's special instruction is retrieved. The value comes from the item's options instruction key, or its top-level instruction key. The hook name keeps the original misspelling.

Parameters#

ParameterTypeDescription
$instructionstringThe special instruction; empty string if none.

Return value#

string. The instruction text.

Example#

function my_special_instruction( $instruction ) {
	return wp_strip_all_tags( $instruction );
}
add_filter( 'rpress_sepcial_instruction', 'my_special_instruction' );

Notes#

The name contains the misspelling 'sepcial'.

Source#

Applied in:

  • includes/rp-core-functions.php (line 290), in get_special_instruction()
Was this page helpful?