wpexec

Run a WirePlumber script

$ wpexec [path/to/file.lua]

$ wpexec --help

wpexec [<wrapper_options>] <command_to_execute> [<command_arguments>]
<wrapper_options> are specific to the wpexec script itself, often used to select a WordPress site, PHP version, or execution environment.
<command_to_execute> is typically a wp-cli command (e.g., "wp user list"), a PHP script, or another command intended to run within the WordPress context.
<command_arguments> are arguments passed to the <command_to_execute>.

(No standard parameters)
    As wpexec is a custom script, it does not have universally defined parameters like standard Linux commands. Any options or arguments it accepts are specific to its implementation by your hosting provider or system administrator. Common custom parameters might include options to specify a particular WordPress site in a multi-site environment, define a PHP version, or control output verbosity. You should consult the documentation or source code for the specific wpexec script you are using to understand its accepted parameters.

wpexec is not a standard Linux command found in typical distributions. Instead, it is commonly a custom shell script or utility developed by hosting providers or system administrators to facilitate the execution of WordPress-related commands, primarily wp-cli, within the context of a specific WordPress installation. Its primary purpose is to simplify command execution by abstracting away complexities such as specifying the correct PHP version, setting environment variables, navigating to the WordPress root directory, or ensuring commands run with appropriate user permissions. It often acts as a wrapper, ensuring that any subsequent command, like 'wp user list', is correctly directed to the intended WordPress instance, especially in environments hosting multiple WordPress sites. This ensures consistency and security for administrative tasks, making it easier for users to manage their WordPress installations via the command line.

Since wpexec is a custom script, its behavior, functionality, and available options are entirely dependent on its specific implementation. There is no standard documentation (like a man page) for it. Its presence and usage are typically specific to managed WordPress hosting environments or custom server setups. Always consult your host's documentation or the script's source code (if accessible) to understand its exact capabilities and limitations. Using it incorrectly or with a poorly configured script could lead to unintended changes to your WordPress installation or security vulnerabilities.

While specific implementations vary, wpexec typically functions by:
1. Determining the target WordPress installation based on command-line arguments, current working directory, or environment variables.
2. Setting up the correct environment for the WordPress site, such as configuring the appropriate PHP version and potentially setting crucial environment variables (e.g., `WP_CLI_ROOT`).
3. Potentially switching to the appropriate system user account with permissions for the WordPress installation.
4. Executing the provided command (often wp-cli) with the correct PHP binary and within the context of the WordPress installation's root directory.
This abstraction allows users to run powerful commands against a specific site without needing to manually manage paths or permissions.

There is no formal or publicly documented history for wpexec as it is not an open-source project or standard utility with a centralized development timeline. Its emergence is organic, stemming from the need of hosting providers and system administrators to streamline the management of multiple WordPress installations, especially in shared or managed hosting environments. It typically evolves as an internal tool within organizations to abstract the complexities of running wp-cli commands or other PHP scripts for specific WordPress sites, ensuring proper environment setup and user permissions. Its development is driven by practical operational needs rather than a formal project roadmap.

wp(1), php(1), bash(1), ssh(1)