# elasticpress/5.3.5/includes/classes/DeprecatedCommand.php

ElasticPress, version 5.3.5. 278 lines.

- Page: https://pluginprobe.com/plugins/elasticpress/5.3.5/code/includes/classes/DeprecatedCommand.php
- Raw: https://pluginprobe.com/plugins/elasticpress/5.3.5/raw/includes/classes/DeprecatedCommand.php
- Modified: 2024-12-12T15:06:52+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/elasticpress/5.3.5/code/includes/classes/DeprecatedCommand.php#L10-L20`.

```php
<?php
/**
 * WP-CLI deprecated commands for ElasticPress
 *
 * @since  4.4.0
 * @package elasticpress
 */

namespace ElasticPress;

use WP_CLI;

if ( ! defined( 'ABSPATH' ) ) {
	// @codeCoverageIgnoreStart
	exit; // Exit if accessed directly.
	// @codeCoverageIgnoreEnd
}

/**
 * Deprecated CLI Commands for ElasticPress
 */
trait DeprecatedCommand {

	/**
	 * DEPRECATED. Return all index names as a JSON object.
	 *
	 * This command is deprecated. Please use `get-indices` instead.
	 *
	 * ## OPTIONS
	 *
	 * [--pretty]
	 * : Use this flag to render a pretty-printed version of the JSON response.
	 *
	 * @subcommand get-indexes
	 * @since      3.2, `--pretty` introduced in 4.1.0
	 * @param array $args Positional CLI args.
	 * @param array $assoc_args Associative CLI args.
	 * @deprecated 4.4.0
	 * @see Command\get_indices()
	 */
	public function get_indexes( $args, $assoc_args ) {
		_deprecated_function( 'get-indexes', '4.4.0', 'get-indices' );
		WP_CLI::warning(
			sprintf(
				/* translators: New command name */
				esc_html__( 'This command is deprecated. Please use %s instead.', 'elasticpress' ),
				'get-indices'
			)
		);
		$this->get_indices( $args, $assoc_args );
	}

	/**
	 * DEPRECATED. Return all indexes from the cluster as a JSON object.
	 *
	 * This command is deprecated. Please use `get-cluster-indices` instead.
	 *
	 * ## OPTIONS
	 *
	 * [--pretty]
	 * : Use this flag to render a pretty-printed version of the JSON response.
	 *
	 * @subcommand get-cluster-indexes
	 * @since      3.2, `--pretty` introduced in 4.1.0
	 * @param array $args Positional CLI args.
	 * @param array $assoc_args Associative CLI args.
	 * @deprecated 4.4.0
	 * @see Command\get_cluster_indices()
	 */
	public function get_cluster_indexes( $args, $assoc_args ) {
		_deprecated_function( 'get-cluster-indexes', '4.4.0', 'get-cluster-indices' );
		WP_CLI::warning(
			sprintf(
				/* translators: New command name */
				esc_html__( 'This command is deprecated. Please use %s instead.', 'elasticpress' ),
				'get-cluster-indices'
			)
		);
		$this->get_cluster_indices( $args, $assoc_args );
	}

	/**
	 * DEPRECATED. Index all posts for a site or network wide.
	 *
	 * This command is deprecated. Please use `sync` instead.
	 *
	 * ## OPTIONS
	 *
	 * [--network-wide]
	 * : Force indexing on all the blogs in the network. `--network-wide` takes an optional argument to limit the number of blogs to be indexed across where 0 is no limit. For example, `--network-wide=5` would limit indexing to only 5 blogs on the network
	 *
	 * [--setup]
	 * : Clear the index first and re-send the put mapping. Use `--yes` to skip the confirmation
	 *
	 * [--per-page=<per_page_number>]
	 * : Determine the amount of posts to be indexed per bulk index (or cycle)
	 *
	 * [--nobulk]
	 * : Disable bulk indexing
	 *
	 * [--static-bulk]
	 * : Do not use dynamic bulk requests, i.e., send only one request per batch of documents.
	 *
	 * [--show-errors]
	 * : Show all errors
	 *
	 * [--show-bulk-errors]
	 * : Display the error message returned from Elasticsearch when a post fails to index using the /_bulk endpoint
	 *
	 * [--show-nobulk-errors]
	 * : Display the error message returned from Elasticsearch when a post fails to index while not using the /_bulk endpoint
	 *
	 * [--offset=<offset_number>]
	 * : Skip the first n posts (don't forget to remove the `--setup` flag when resuming or the index will be emptied before starting again).
	 *
	 * [--indexables=<indexables>]
	 * : Specify the Indexable(s) which will be indexed
	 *
	 * [--post-type=<post_types>]
	 * : Specify which post types will be indexed (by default: all indexable post types are indexed). For example, `--post-type="my_custom_post_type"` would limit indexing to only posts from the post type "my_custom_post_type". Accepts multiple post types separated by comma
	 *
	 * [--include=<IDs>]
	 * : Choose which object IDs to include in the index
	 *
	 * [--post-ids=<IDs>]
	 * : Choose which post_ids to include when indexing the Posts Indexable (deprecated)
	 *
	 * [--upper-limit-object-id=<ID>]
	 * : Upper limit of a range of IDs to be indexed. If indexing IDs from 30 to 45, this should be 45
	 *
	 * [--lower-limit-object-id=<ID>]
	 * : Lower limit of a range of IDs to be indexed. If indexing IDs from 30 to 45, this should be 30
	 *
	 * [--ep-host=<host>]
	 * : Custom Elasticsearch host
	 *
	 * [--ep-prefix=<prefix>]
	 * : Custom ElasticPress prefix
	 *
	 * [--yes]
	 * : Skip confirmation needed by `--setup`
	 *
	 * @param array $args Positional CLI args.
	 * @since 0.1.2
	 * @param array $assoc_args Associative CLI args.
	 * @deprecated 4.4.0
	 * @see Command\sync()
	 */
	public function index( $args, $assoc_args ) {
		_deprecated_function( 'index', '4.4.0', 'sync' );
		WP_CLI::warning(
			sprintf(
				/* translators: New command name */
				esc_html__( 'This command is deprecated. Please use %s instead.', 'elasticpress' ),
				'sync'
			)
		);
		$this->sync( $args, $assoc_args );
	}

	/**
	 * DEPRECATED. Clear a sync/index process.
	 *
	 * This command is deprecated. Please use `clear-sync` instead.
	 *
	 * If an index was stopped prematurely and won't start again, this will clear this cached data such that a new index can start.
	 *
	 * @subcommand clear-index
	 * @param array $args Positional CLI args.
	 * @param array $assoc_args Associative CLI args.
	 * @since      3.4
	 * @deprecated 4.4.0
	 * @see Command\clear_sync()
	 */
	public function clear_index( $args, $assoc_args ) {
		_deprecated_function( 'clear-index', '4.4.0', 'clear-sync' );
		WP_CLI::warning(
			sprintf(
				/* translators: New command name */
				esc_html__( 'This command is deprecated. Please use %s instead.', 'elasticpress' ),
				'clear-sync'
			)
		);
		$this->clear_sync( $args, $assoc_args );
	}

	/**
	 * DEPRECATED. Returns the status of an ongoing index operation in JSON array.
	 *
	 * This command is deprecated. Please use `get-ongoing-sync-status` instead.
	 *
	 * Returns the status of an ongoing index operation in JSON array with the following fields:
	 * indexing | boolean | True if index operation is ongoing or false
	 * method | string | 'cli', 'web' or 'none'
	 * items_indexed | integer | Total number of items indexed
	 * total_items | integer | Total number of items indexed or -1 if not yet determined
	 *
	 * ## OPTIONS
	 *
	 * [--pretty]
	 * : Use this flag to render a pretty-printed version of the JSON response.
	 *
	 * @subcommand get-indexing-status
	 * @since 3.5.1, `--pretty` introduced in 4.1.0
	 * @param array $args Positional CLI args.
	 * @param array $assoc_args Associative CLI args.
	 * @deprecated 4.4.0
	 * @see Command\get_ongoing_sync_status()
	 */
	public function get_indexing_status( $args, $assoc_args ) {
		_deprecated_function( 'get-indexing-status', '4.4.0', 'get-ongoing-sync-status' );
		WP_CLI::warning(
			sprintf(
				/* translators: New command name */
				esc_html__( 'This command is deprecated. Please use %s instead.', 'elasticpress' ),
				'get-ongoing-sync-status'
			)
		);
		$this->get_ongoing_sync_status( $args, $assoc_args );
	}

	/**
	 * DEPRECATED. Returns a JSON array with the results of the last CLI index (if present) or an empty array.
	 *
	 * This command is deprecated. Please use `get-last-cli-sync` instead.
	 *
	 * ## OPTIONS
	 *
	 * [--clear]
	 * : Clear the `ep_last_cli_index` option.
	 *
	 * [--pretty]
	 * : Use this flag to render a pretty-printed version of the JSON response.
	 *
	 * @subcommand get-last-cli-index
	 * @since 3.5.1, `--pretty` introduced in 4.1.0
	 * @param array $args Positional CLI args.
	 * @param array $assoc_args Associative CLI args.
	 * @deprecated 4.4.0
	 * @see Command\get_last_cli_sync()
	 */
	public function get_last_cli_index( $args, $assoc_args ) {
		_deprecated_function( 'get-last-cli-index', '4.4.0', 'get-last-cli-sync' );
		WP_CLI::warning(
			sprintf(
				/* translators: New command name */
				esc_html__( 'This command is deprecated. Please use %s instead.', 'elasticpress' ),
				'get-last-cli-sync'
			)
		);
		$this->get_last_cli_sync( $args, $assoc_args );
	}

	/**
	 * DEPRECATED. Stop the indexing operation started from the dashboard.
	 *
	 * This command is deprecated. Please use `stop-sync` instead.
	 *
	 * @subcommand stop-indexing
	 * @since      3.5.2
	 * @param array $args Positional CLI args.
	 * @param array $assoc_args Associative CLI args.
	 * @deprecated 4.4.0
	 * @see Command\stop_sync()
	 */
	public function stop_indexing( $args, $assoc_args ) {
		_deprecated_function( 'stop-indexing', '4.4.0', 'stop-sync' );
		WP_CLI::warning(
			sprintf(
				/* translators: New command name */
				esc_html__( 'This command is deprecated. Please use %s instead.', 'elasticpress' ),
				'stop-sync'
			)
		);
		$this->stop_sync( $args, $assoc_args );
	}
}

```