Access to siteStatus

codemountain · May 27, 2021, 6:54pm

Hi, can’t figure out how to gain access to the siteStatus string documented in https://build.localwp.com/building/hooks/common-parameters

Tried to find it being used in other add-ons but did not find. any help welcome, basically wanna check if site is running before I attempt to run a method/function and if not then pop an alert to start the site.

Thanks!!

codemountain · June 2, 2021, 11:39pm

@Clay, anyway someone from Local can chime in… this should be a rather straightforward request since its mentionned in the docs that we should have access to it but would need a small code example or nudge… thanks!

ben.turner · June 3, 2021, 9:32pm

Hey! Sorry about the late reply!

It depends on where you are trying to use that parameter. If it’s in a hook, then right now, only the SiteInfo_Top_TopRight hook passes that for you to use:

However, Local does pass this along to you within either the main or renderer that you use for the addon. So for example, the Atlas addon’s renderer is an example of using the siteStatus parameter:

github.com

getflywheel/local-addon-atlas/blob/f728ab70e58e55856b27445e9cb3e6f15f0faf68/src/renderer.tsx#L10


import path from 'path';
import { HeadlessEnvironmentSelect } from './renderer/HeadlessEnvironmentSelect';
import SiteOverviewAddonSection from './renderer/SiteOverviewAddonSection';
import type { Site } from '@getflywheel/local';
const stylesheetPath = path.resolve(__dirname, '../style.css');
const title = `Front-end Node.js`;
export const atlasDocsUrl = `https://developers.wpengine.com`;
const nodeJSSiteOverviewHook = (site: Site, siteStatus: string) => {
	const hasNodeJSHeadlessSite = site?.services?.nodejs?.role;
	const nodeJSHeadlessLocalUrl = `localhost:${site?.services?.nodejs?.ports?.HTTP[0]}`;
	return (hasNodeJSHeadlessSite
		&& <SiteOverviewAddonSection
			key={nodeJSHeadlessLocalUrl}
			localUrl={nodeJSHeadlessLocalUrl}
			siteStatus={siteStatus}
			site={site}
		/>);

codemountain · June 28, 2021, 10:27pm

Awesome will give this a whirl, thanks

Topic		Replies	Views
Debugging a Local Add-on Local Add-ons	2	1369	September 10, 2018
Hooks Documentation Local Add-ons	2	1192	May 29, 2019
Documented action hooks are not working Local Add-ons mac	2	27	October 14, 2024
Push/Pull Actions Feature requests add-on	3	307	January 5, 2024
How to get site running status realtime in addon UI Local Add-ons	0	23	October 15, 2024

Access to siteStatus

Related topics