Skip to content
Docs
Get RestroPress

Action

rpress_reports_contextual_help

Updated
On this page

Fires when the reports screen help tabs are loaded.

Runs on the load action of the reports admin screen, only when the current screen ID is restropress_page_rpress-reports. Use it to add help tabs or sidebar content to that screen.

Parameters#

ParameterTypeDescription
$screenWP_ScreenThe current admin screen object.

Example#

function my_reports_help( $screen ) {
	$screen->add_help_tab( array(
		'id'      => 'my-reports-help',
		'title'   => __( 'My reports', 'my-plugin' ),
		'content' => '<p>' . esc_html__( 'Custom report notes.', 'my-plugin' ) . '</p>',
	) );
}
add_action( 'rpress_reports_contextual_help', 'my_reports_help', 10, 1 );

Source#

Fired from:

  • includes/admin/reporting/contextual-help.php (line 24), in rpress_reporting_contextual_help()

See also#

Was this page helpful?