WordPress (PHP) / Utilities

get_component.php

/************************************
* Include component file.
* @param		string		$sFilePath			The component to include
* @param		array		$aScopeVariables		An array of variables to make available in the component
* @param		boolean		$bReturn			Return the markup instead off outputting it?
************************************/
function get_component( $sFilePath, $aScopeVariables = [], $bReturn = false ) {

	ob_start();

	extract( $aScopeVariables, EXTR_OVERWRITE );

	$sTemplateSlug = sprintf( '/templates/_components/%s.php', $sFilePath );
	$sTemplateLocation = locate_template($sTemplateSlug);

	if ( ! is_readable( $sTemplateLocation ) ) {
		throw new \Exception( sprintf( 'Missing component: %s', $sFilePath ) );
	}

	include $sTemplateLocation;

	$sComponent = ob_get_clean();

	if ( $bReturn === true) return $sComponent;

	echo $sComponent;

}