@wpkernel/wp-json-ast v0.12.6-beta.3

---

@wpkernel/wp-json-ast / CreateWpPhpProgramBuilderOptions

Interface: CreateWpPhpProgramBuilderOptions<TContext, TInput, TOutput>

Options for creating a WordPress PHP program builder.

Example

import { createWpPhpProgramBuilder } from '@wpkernel/wp-json-ast';

const builder = createWpPhpProgramBuilder({
	metadata: {
		namespace: 'MyPlugin',
		pluginName: 'my-plugin',
		description: 'My plugin description.',
	},
	build: (builder) => {
		builder.appendProgramStatement(
			buildReturn(
				buildScalarString('Hello from my plugin!')
			)
		);
	}
});

Extends

• Omit<BaseCreatePhpProgramBuilderOptions<TContext, TInput, TOutput>, "metadata" | "build">

Type Parameters

TContext

TContext extends PipelineContext = PipelineContext

TInput

TInput extends BuilderInput = BuilderInput

TOutput

TOutput extends BuilderOutput = BuilderOutput

Properties

build()

readonly build: (builder, entry) => void | Promise<void>;

The build function that constructs the PHP AST.

Parameters

builder

PhpAstBuilderAdapter

The PHP AST builder adapter.

entry

PhpAstContextEntry

The PHP AST context entry.

Returns

void | Promise<void>

---

filePath

readonly filePath: string;

Inherited from

Omit.filePath

---

key

readonly key: string;

Inherited from

Omit.key

---

metadata

readonly metadata: WpPhpFileMetadata;

Metadata for the WordPress PHP file.

See

WpPhpFileMetadata

---

namespace

readonly namespace: string;

Inherited from

Omit.namespace

---

dependsOn?

readonly optional dependsOn: readonly string[];

Prerequisite helper keys.

Default Value

[]

Inherited from

Omit.dependsOn

---

mode?

readonly optional mode: HelperMode;

Duplicate-key policy.

Default Value

'extend'

Inherited from

Omit.mode

---

origin?

readonly optional origin: string;

Optional provenance label used in diagnostics.

Inherited from

Omit.origin

---

priority?

readonly optional priority: number;

Relative ordering hint.

Default Value

0

Inherited from

Omit.priority