Content type: Handbook

  • Given a misconfigured WP_CONTENT_DIR constant directory

    Modify wp-config.php to set WP_CONTENT_DIR to an empty string. Usage Scenario: My example scenario Given a WP install And a misconfigured WP_CONTENT_DIR constant directory Behat steps documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request. Related Given an empty directory – Creates an empty directory. Given…

  • Given /^a new Phar with (?:the same version|version "([^"]+)")$/

    Build a new WP-CLI Phar file with a given version. Usage Scenario: My example scenario Given an empty directory And a new Phar with version “2.11.0” Behat steps documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request. Related Given an empty directory – Creates an empty…

  • Given a WP install(ation) in :subdir

    Installs WordPress in a given directory. Usage Scenario: My example scenario Given a WP installation in ‘foo’ … Scenario: My other scenario Given a WP install in ‘bar’ … Behat steps documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request. Related Given an empty directory –…

  • Given a PHP built-in web server to serve :subdir

    Start a PHP built-in web server in the given subdirectory. Usage Scenario: My example scenario Given a WP installation And a PHP built-in web server to serve ‘WordPress’ Behat steps documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request. Related Given an empty directory – Creates…

  • Given a PHP built-in web server

    Start a PHP built-in web server in the current directory. Usage Scenario: My example scenario Given a WP installation And a PHP built-in web server Behat steps documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request. Related Given an empty directory – Creates an empty directory.…

  • Given a WP install(ation) with Composer and a custom vendor directory :vendor_directory

    Installs WordPress with Composer and a custom vendor directory. Usage Scenario: My example scenario Given a WP installation with Composer and a custom vendor directory ‘vendor-custom’ … Scenario: My other scenario Given a WP install with Composer with Composer and a custom vendor directory ‘vendor-custom’ … Behat steps documentation is generated from the WP-CLI codebase…

  • Given a WP install(ation) with Composer

    Installs WordPress with Composer. Usage Scenario: My example scenario Given a WP installation with Composer … Scenario: My other scenario Given a WP install with Composer … Behat steps documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request. Related Given an empty directory – Creates an…

  • WP_CLIUtilsreport_batch_operation_results()

    Report the results of the same operation against multiple resources. Usage WP_CLI\Utils\report_batch_operation_results( $noun, $verb, $total, $successes, $failures, $skips = null ) $noun (string) Resource being affected (e.g. plugin). $verb (string) Type of action happening to the noun (e.g. activate). $total (integer) Total number of resource being affected. $successes (integer) Number of successful operations. $failures (integer)…

  • WP_CLIUtilstrailingslashit()

    Appends a trailing slash. Usage WP_CLI\Utils\trailingslashit( $string ) $string (string) What to add the trailing slash to. @return (string) with trailing slash added. Internal API documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request. Related WP_CLI\Utils\get_home_dir() – Get the home directory. WP_CLI\Utils\normalize_path() – Normalize a filesystem…

  • WP_CLIUtilsformat_items()

    Render a collection of items as an ASCII table, JSON, CSV, YAML, list of ids, or count. Usage WP_CLI\Utils\format_items( $format, $items, $fields ) $format (string) Format to use: ‘table’, ‘json’, ‘csv’, ‘yaml’, ‘ids’, ‘count’. $items (array<mixed>) An array of items to output. $fields (array<string>|string) Named fields for each item of data. Can be array or…