Automattic /
jetpack
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Jetpack_CLI often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Jetpack_CLI, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 8 | class Jetpack_CLI extends WP_CLI_Command { |
||
| 9 | |||
| 10 | // Aesthetics |
||
| 11 | public $green_open = "\033[32m"; |
||
| 12 | public $red_open = "\033[31m"; |
||
| 13 | public $yellow_open = "\033[33m"; |
||
| 14 | public $color_close = "\033[0m"; |
||
| 15 | |||
| 16 | /** |
||
| 17 | * Get Jetpack Details |
||
| 18 | * |
||
| 19 | * ## OPTIONS |
||
| 20 | * |
||
| 21 | * empty: Leave it empty for basic stats |
||
| 22 | * |
||
| 23 | * full: View full stats. It's the data from the heartbeat |
||
| 24 | * |
||
| 25 | * ## EXAMPLES |
||
| 26 | * |
||
| 27 | * wp jetpack status |
||
| 28 | * wp jetpack status full |
||
| 29 | * |
||
| 30 | */ |
||
| 31 | public function status( $args, $assoc_args ) { |
||
| 32 | |||
| 33 | WP_CLI::line( sprintf( __( 'Checking status for %s', 'jetpack' ), esc_url( get_site_url() ) ) ); |
||
| 34 | |||
| 35 | if ( ! Jetpack::is_active() ) { |
||
| 36 | WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) ); |
||
| 37 | } |
||
| 38 | |||
| 39 | View Code Duplication | if ( isset( $args[0] ) && 'full' !== $args[0] ) { |
|
| 40 | /* translators: %s is a command like "prompt" */ |
||
| 41 | WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $args[0] ) ); |
||
| 42 | } |
||
| 43 | |||
| 44 | $master_user_email = Jetpack::get_master_user_email(); |
||
| 45 | |||
| 46 | /* |
||
| 47 | * Are they asking for all data? |
||
| 48 | * |
||
| 49 | * Loop through heartbeat data and organize by priority. |
||
| 50 | */ |
||
| 51 | $all_data = ( isset( $args[0] ) && 'full' == $args[0] ) ? 'full' : false; |
||
| 52 | if ( $all_data ) { |
||
|
|
|||
| 53 | WP_CLI::success( __( 'Jetpack is currently connected to WordPress.com', 'jetpack' ) ); |
||
| 54 | WP_CLI::line( sprintf( __( "The Jetpack Version is %s", 'jetpack' ), JETPACK__VERSION ) ); |
||
| 55 | WP_CLI::line( sprintf( __( "The WordPress.com blog_id is %d", 'jetpack' ), Jetpack_Options::get_option( 'id' ) ) ); |
||
| 56 | WP_CLI::line( sprintf( __( 'The WordPress.com account for the primary connection is %s', 'jetpack' ), $master_user_email ) ); |
||
| 57 | |||
| 58 | // Heartbeat data |
||
| 59 | WP_CLI::line( "\n" . __( 'Additional data: ', 'jetpack' ) ); |
||
| 60 | |||
| 61 | // Get the filtered heartbeat data. |
||
| 62 | // Filtered so we can color/list by severity |
||
| 63 | $stats = Jetpack::jetpack_check_heartbeat_data(); |
||
| 64 | |||
| 65 | // Display red flags first |
||
| 66 | foreach ( $stats['bad'] as $stat => $value ) { |
||
| 67 | printf( "$this->red_open%-'.16s %s $this->color_close\n", $stat, $value ); |
||
| 68 | } |
||
| 69 | |||
| 70 | // Display caution warnings next |
||
| 71 | foreach ( $stats['caution'] as $stat => $value ) { |
||
| 72 | printf( "$this->yellow_open%-'.16s %s $this->color_close\n", $stat, $value ); |
||
| 73 | } |
||
| 74 | |||
| 75 | // The rest of the results are good! |
||
| 76 | foreach ( $stats['good'] as $stat => $value ) { |
||
| 77 | |||
| 78 | // Modules should get special spacing for aestetics |
||
| 79 | if ( strpos( $stat, 'odule-' ) ) { |
||
| 80 | printf( "%-'.30s %s\n", $stat, $value ); |
||
| 81 | usleep( 4000 ); // For dramatic effect lolz |
||
| 82 | continue; |
||
| 83 | } |
||
| 84 | printf( "%-'.16s %s\n", $stat, $value ); |
||
| 85 | usleep( 4000 ); // For dramatic effect lolz |
||
| 86 | } |
||
| 87 | } else { |
||
| 88 | // Just the basics |
||
| 89 | WP_CLI::success( __( 'Jetpack is currently connected to WordPress.com', 'jetpack' ) ); |
||
| 90 | WP_CLI::line( sprintf( __( 'The Jetpack Version is %s', 'jetpack' ), JETPACK__VERSION ) ); |
||
| 91 | WP_CLI::line( sprintf( __( 'The WordPress.com blog_id is %d', 'jetpack' ), Jetpack_Options::get_option( 'id' ) ) ); |
||
| 92 | WP_CLI::line( sprintf( __( 'The WordPress.com account for the primary connection is %s', 'jetpack' ), $master_user_email ) ); |
||
| 93 | WP_CLI::line( "\n" . _x( "View full status with 'wp jetpack status full'", '"wp jetpack status full" is a command - do not translate', 'jetpack' ) ); |
||
| 94 | } |
||
| 95 | } |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Tests the active connection |
||
| 99 | * |
||
| 100 | * Does a two-way test to verify that the local site can communicate with remote Jetpack/WP.com servers and that Jetpack/WP.com servers can talk to the local site. |
||
| 101 | * |
||
| 102 | * ## EXAMPLES |
||
| 103 | * |
||
| 104 | * wp jetpack test-connection |
||
| 105 | * |
||
| 106 | * @subcommand test-connection |
||
| 107 | */ |
||
| 108 | public function test_connection( $args, $assoc_args ) { |
||
| 109 | |||
| 110 | WP_CLI::line( sprintf( __( 'Testing connection for %s', 'jetpack' ), esc_url( get_site_url() ) ) ); |
||
| 111 | |||
| 112 | if ( ! Jetpack::is_active() ) { |
||
| 113 | WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) ); |
||
| 114 | } |
||
| 115 | |||
| 116 | $response = Jetpack_Client::wpcom_json_api_request_as_blog( |
||
| 117 | sprintf( '/jetpack-blogs/%d/test-connection', Jetpack_Options::get_option( 'id' ) ), |
||
| 118 | Jetpack_Client::WPCOM_JSON_API_VERSION |
||
| 119 | ); |
||
| 120 | |||
| 121 | View Code Duplication | if ( is_wp_error( $response ) ) { |
|
| 122 | /* translators: %1$s is the error code, %2$s is the error message */ |
||
| 123 | WP_CLI::error( sprintf( __( 'Failed to test connection (#%1$s: %2$s)', 'jetpack' ), $response->get_error_code(), $response->get_error_message() ) ); |
||
| 124 | } |
||
| 125 | |||
| 126 | $body = wp_remote_retrieve_body( $response ); |
||
| 127 | if ( ! $body ) { |
||
| 128 | WP_CLI::error( __( 'Failed to test connection (empty response body)', 'jetpack' ) ); |
||
| 129 | } |
||
| 130 | |||
| 131 | $result = json_decode( $body ); |
||
| 132 | $is_connected = (bool) $result->connected; |
||
| 133 | $message = $result->message; |
||
| 134 | |||
| 135 | if ( $is_connected ) { |
||
| 136 | WP_CLI::success( $message ); |
||
| 137 | } else { |
||
| 138 | WP_CLI::error( $message ); |
||
| 139 | } |
||
| 140 | } |
||
| 141 | |||
| 142 | /** |
||
| 143 | * Disconnect Jetpack Blogs or Users |
||
| 144 | * |
||
| 145 | * ## OPTIONS |
||
| 146 | * |
||
| 147 | * blog: Disconnect the entire blog. |
||
| 148 | * |
||
| 149 | * user <user_identifier>: Disconnect a specific user from WordPress.com. |
||
| 150 | * |
||
| 151 | * Please note, the primary account that the blog is connected |
||
| 152 | * to WordPress.com with cannot be disconnected without |
||
| 153 | * disconnecting the entire blog. |
||
| 154 | * |
||
| 155 | * ## EXAMPLES |
||
| 156 | * |
||
| 157 | * wp jetpack disconnect blog |
||
| 158 | * wp jetpack disconnect user 13 |
||
| 159 | * wp jetpack disconnect user username |
||
| 160 | * wp jetpack disconnect user [email protected] |
||
| 161 | * |
||
| 162 | * @synopsis <blog|user> [<user_identifier>] |
||
| 163 | */ |
||
| 164 | public function disconnect( $args, $assoc_args ) { |
||
| 219 | |||
| 220 | /** |
||
| 221 | * Reset Jetpack options and settings to default |
||
| 222 | * |
||
| 223 | * ## OPTIONS |
||
| 224 | * |
||
| 225 | * modules: Resets modules to default state ( get_default_modules() ) |
||
| 226 | * |
||
| 227 | * options: Resets all Jetpack options except: |
||
| 228 | * - All private options (Blog token, user token, etc...) |
||
| 229 | * - id (The Client ID/WP.com Blog ID of this site) |
||
| 230 | * - master_user |
||
| 231 | * - version |
||
| 232 | * - activated |
||
| 233 | * |
||
| 234 | * ## EXAMPLES |
||
| 235 | * |
||
| 236 | * wp jetpack reset options |
||
| 237 | * wp jetpack reset modules |
||
| 238 | * |
||
| 239 | * @synopsis <modules|options> |
||
| 240 | */ |
||
| 241 | public function reset( $args, $assoc_args ) { |
||
| 299 | |||
| 300 | /** |
||
| 301 | * Manage Jetpack Modules |
||
| 302 | * |
||
| 303 | * ## OPTIONS |
||
| 304 | * |
||
| 305 | * <list|activate|deactivate|toggle> |
||
| 306 | * : The action to take. |
||
| 307 | * --- |
||
| 308 | * default: list |
||
| 309 | * options: |
||
| 310 | * - list |
||
| 311 | * - activate |
||
| 312 | * - deactivate |
||
| 313 | * - toggle |
||
| 314 | * --- |
||
| 315 | * |
||
| 316 | * [<module_slug>] |
||
| 317 | * : The slug of the module to perform an action on. |
||
| 318 | * |
||
| 319 | * [--format=<format>] |
||
| 320 | * : Allows overriding the output of the command when listing modules. |
||
| 321 | * --- |
||
| 322 | * default: table |
||
| 323 | * options: |
||
| 324 | * - table |
||
| 325 | * - json |
||
| 326 | * - csv |
||
| 327 | * - yaml |
||
| 328 | * - ids |
||
| 329 | * - count |
||
| 330 | * --- |
||
| 331 | * |
||
| 332 | * ## EXAMPLES |
||
| 333 | * |
||
| 334 | * wp jetpack module list |
||
| 335 | * wp jetpack module list --format=json |
||
| 336 | * wp jetpack module activate stats |
||
| 337 | * wp jetpack module deactivate stats |
||
| 338 | * wp jetpack module toggle stats |
||
| 339 | * wp jetpack module activate all |
||
| 340 | * wp jetpack module deactivate all |
||
| 341 | */ |
||
| 342 | public function module( $args, $assoc_args ) { |
||
| 343 | $action = isset( $args[0] ) ? $args[0] : 'list'; |
||
| 344 | |||
| 345 | if ( isset( $args[1] ) ) { |
||
| 346 | $module_slug = $args[1]; |
||
| 347 | if ( 'all' !== $module_slug && ! Jetpack::is_module( $module_slug ) ) { |
||
| 348 | /* translators: %s is a module slug like "stats" */ |
||
| 349 | WP_CLI::error( sprintf( __( '%s is not a valid module.', 'jetpack' ), $module_slug ) ); |
||
| 350 | } |
||
| 351 | if ( 'toggle' === $action ) { |
||
| 352 | $action = Jetpack::is_module_active( $module_slug ) |
||
| 353 | ? 'deactivate' |
||
| 354 | : 'activate'; |
||
| 355 | } |
||
| 356 | if ( 'all' === $args[1] ) { |
||
| 357 | $action = ( 'deactivate' === $action ) |
||
| 358 | ? 'deactivate_all' |
||
| 359 | : 'activate_all'; |
||
| 360 | } |
||
| 361 | } elseif ( 'list' !== $action ) { |
||
| 362 | WP_CLI::line( __( 'Please specify a valid module.', 'jetpack' ) ); |
||
| 363 | $action = 'list'; |
||
| 364 | } |
||
| 365 | |||
| 366 | switch ( $action ) { |
||
| 367 | case 'list': |
||
| 368 | $modules_list = array(); |
||
| 369 | $modules = Jetpack::get_available_modules(); |
||
| 370 | sort( $modules ); |
||
| 371 | foreach ( (array) $modules as $module_slug ) { |
||
| 372 | if ( 'vaultpress' === $module_slug ) { |
||
| 373 | continue; |
||
| 374 | } |
||
| 375 | $modules_list[] = array( |
||
| 376 | 'slug' => $module_slug, |
||
| 377 | 'status' => Jetpack::is_module_active( $module_slug ) |
||
| 378 | ? __( 'Active', 'jetpack' ) |
||
| 379 | : __( 'Inactive', 'jetpack' ), |
||
| 380 | ); |
||
| 381 | } |
||
| 382 | WP_CLI\Utils\format_items( $assoc_args['format'], $modules_list, array( 'slug', 'status' ) ); |
||
| 383 | break; |
||
| 384 | case 'activate': |
||
| 385 | $module = Jetpack::get_module( $module_slug ); |
||
| 386 | Jetpack::log( 'activate', $module_slug ); |
||
| 387 | if ( Jetpack::activate_module( $module_slug, false, false ) ) { |
||
| 388 | WP_CLI::success( sprintf( __( '%s has been activated.', 'jetpack' ), $module['name'] ) ); |
||
| 389 | } else { |
||
| 390 | WP_CLI::error( sprintf( __( '%s could not be activated.', 'jetpack' ), $module['name'] ) ); |
||
| 391 | } |
||
| 392 | break; |
||
| 393 | View Code Duplication | case 'activate_all': |
|
| 394 | $modules = Jetpack::get_available_modules(); |
||
| 395 | Jetpack::update_active_modules( $modules ); |
||
| 396 | WP_CLI::success( __( 'All modules activated!', 'jetpack' ) ); |
||
| 397 | break; |
||
| 398 | case 'deactivate': |
||
| 399 | $module = Jetpack::get_module( $module_slug ); |
||
| 400 | Jetpack::log( 'deactivate', $module_slug ); |
||
| 401 | Jetpack::deactivate_module( $module_slug ); |
||
| 402 | WP_CLI::success( sprintf( __( '%s has been deactivated.', 'jetpack' ), $module['name'] ) ); |
||
| 403 | break; |
||
| 404 | case 'deactivate_all': |
||
| 405 | Jetpack::delete_active_modules(); |
||
| 406 | WP_CLI::success( __( 'All modules deactivated!', 'jetpack' ) ); |
||
| 407 | break; |
||
| 408 | case 'toggle': |
||
| 409 | // Will never happen, should have been handled above and changed to activate or deactivate. |
||
| 410 | break; |
||
| 411 | } |
||
| 412 | } |
||
| 413 | |||
| 414 | /** |
||
| 415 | * Manage Protect Settings |
||
| 416 | * |
||
| 417 | * ## OPTIONS |
||
| 418 | * |
||
| 419 | * whitelist: Whitelist an IP address. You can also read or clear the whitelist. |
||
| 420 | * |
||
| 421 | * |
||
| 422 | * ## EXAMPLES |
||
| 423 | * |
||
| 424 | * wp jetpack protect whitelist <ip address> |
||
| 425 | * wp jetpack protect whitelist list |
||
| 426 | * wp jetpack protect whitelist clear |
||
| 427 | * |
||
| 428 | * @synopsis <whitelist> [<ip|ip_low-ip_high|list|clear>] |
||
| 429 | */ |
||
| 430 | public function protect( $args, $assoc_args ) { |
||
| 534 | |||
| 535 | /** |
||
| 536 | * Manage Jetpack Options |
||
| 537 | * |
||
| 538 | * ## OPTIONS |
||
| 539 | * |
||
| 540 | * list : List all jetpack options and their values |
||
| 541 | * delete : Delete an option |
||
| 542 | * - can only delete options that are white listed. |
||
| 543 | * update : update an option |
||
| 544 | * - can only update option strings |
||
| 545 | * get : get the value of an option |
||
| 546 | * |
||
| 547 | * ## EXAMPLES |
||
| 548 | * |
||
| 549 | * wp jetpack options list |
||
| 550 | * wp jetpack options get <option_name> |
||
| 551 | * wp jetpack options delete <option_name> |
||
| 552 | * wp jetpack options update <option_name> [<option_value>] |
||
| 553 | * |
||
| 554 | * @synopsis <list|get|delete|update> [<option_name>] [<option_value>] |
||
| 555 | */ |
||
| 556 | public function options( $args, $assoc_args ) { |
||
| 557 | $action = isset( $args[0] ) ? $args[0] : 'list'; |
||
| 558 | $safe_to_modify = Jetpack_Options::get_options_for_reset(); |
||
| 559 | |||
| 560 | // Jumpstart is special |
||
| 561 | array_push( $safe_to_modify, 'jumpstart' ); |
||
| 562 | |||
| 563 | // Is the option flagged as unsafe? |
||
| 564 | $flagged = ! in_array( $args[1], $safe_to_modify ); |
||
| 565 | |||
| 566 | View Code Duplication | if ( ! in_array( $action, array( 'list', 'get', 'delete', 'update' ) ) ) { |
|
| 567 | /* translators: %s is a command like "prompt" */ |
||
| 568 | WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) ); |
||
| 569 | } |
||
| 570 | |||
| 571 | if ( isset( $args[0] ) ) { |
||
| 572 | if ( 'get' == $args[0] && isset( $args[1] ) ) { |
||
| 573 | $action = 'get'; |
||
| 574 | } else if ( 'delete' == $args[0] && isset( $args[1] ) ) { |
||
| 575 | $action = 'delete'; |
||
| 576 | View Code Duplication | } else if ( 'update' == $args[0] && isset( $args[1] ) ) { |
|
| 577 | $action = 'update'; |
||
| 578 | } else { |
||
| 579 | $action = 'list'; |
||
| 580 | } |
||
| 581 | } |
||
| 582 | |||
| 583 | // Bail if the option isn't found |
||
| 584 | $option = isset( $args[1] ) ? Jetpack_Options::get_option( $args[1] ) : false; |
||
| 585 | View Code Duplication | if ( isset( $args[1] ) && ! $option && 'update' !== $args[0] ) { |
|
| 586 | WP_CLI::error( __( 'Option not found or is empty. Use "list" to list option names', 'jetpack' ) ); |
||
| 587 | } |
||
| 588 | |||
| 589 | // Let's print_r the option if it's an array |
||
| 590 | // Used in the 'get' and 'list' actions |
||
| 591 | $option = is_array( $option ) ? print_r( $option ) : $option; |
||
| 592 | |||
| 593 | switch ( $action ) { |
||
| 594 | case 'get': |
||
| 595 | WP_CLI::success( "\t" . $option ); |
||
| 596 | break; |
||
| 597 | case 'delete': |
||
| 598 | jetpack_cli_are_you_sure( $flagged ); |
||
| 599 | |||
| 600 | Jetpack_Options::delete_option( $args[1] ); |
||
| 601 | WP_CLI::success( sprintf( __( 'Deleted option: %s', 'jetpack' ), $args[1] ) ); |
||
| 602 | break; |
||
| 603 | case 'update': |
||
| 604 | jetpack_cli_are_you_sure( $flagged ); |
||
| 605 | |||
| 606 | // Updating arrays would get pretty tricky... |
||
| 607 | $value = Jetpack_Options::get_option( $args[1] ); |
||
| 608 | if ( $value && is_array( $value ) ) { |
||
| 609 | WP_CLI::error( __( 'Sorry, no updating arrays at this time', 'jetpack' ) ); |
||
| 610 | } |
||
| 611 | |||
| 612 | Jetpack_Options::update_option( $args[1], $args[2] ); |
||
| 613 | WP_CLI::success( sprintf( _x( 'Updated option: %s to "%s"', 'Updating an option from "this" to "that".', 'jetpack' ), $args[1], $args[2] ) ); |
||
| 614 | break; |
||
| 615 | case 'list': |
||
| 616 | $options_compact = Jetpack_Options::get_option_names(); |
||
| 617 | $options_non_compact = Jetpack_Options::get_option_names( 'non_compact' ); |
||
| 618 | $options_private = Jetpack_Options::get_option_names( 'private' ); |
||
| 619 | $options = array_merge( $options_compact, $options_non_compact, $options_private ); |
||
| 620 | |||
| 621 | // Table headers |
||
| 622 | WP_CLI::line( "\t" . str_pad( __( 'Option', 'jetpack' ), 30 ) . __( 'Value', 'jetpack' ) ); |
||
| 623 | |||
| 624 | // List out the options and their values |
||
| 625 | // Tell them if the value is empty or not |
||
| 626 | // Tell them if it's an array |
||
| 627 | foreach ( $options as $option ) { |
||
| 628 | $value = Jetpack_Options::get_option( $option ); |
||
| 629 | if ( ! $value ) { |
||
| 630 | WP_CLI::line( "\t" . str_pad( $option, 30 ) . 'Empty' ); |
||
| 631 | continue; |
||
| 632 | } |
||
| 633 | |||
| 634 | if ( ! is_array( $value ) ) { |
||
| 635 | WP_CLI::line( "\t" . str_pad( $option, 30 ) . $value ); |
||
| 636 | } else if ( is_array( $value ) ) { |
||
| 637 | WP_CLI::line( "\t" . str_pad( $option, 30 ) . 'Array - Use "get <option>" to read option array.' ); |
||
| 638 | } |
||
| 639 | } |
||
| 640 | $option_text = '{' . _x( 'option', 'a variable command that a user can write, provided in the printed instructions', 'jetpack' ) . '}'; |
||
| 641 | $value_text = '{' . _x( 'value', 'the value that they want to update the option to', 'jetpack' ) . '}'; |
||
| 642 | |||
| 643 | WP_CLI::success( |
||
| 644 | _x( "Above are your options. You may 'get', 'delete', and 'update' them.", "'get', 'delete', and 'update' are commands - do not translate.", 'jetpack' ) . "\n" . |
||
| 645 | str_pad( 'wp jetpack options get', 26 ) . $option_text . "\n" . |
||
| 646 | str_pad( 'wp jetpack options delete', 26 ) . $option_text . "\n" . |
||
| 647 | str_pad( 'wp jetpack options update', 26 ) . "$option_text $value_text" . "\n" . |
||
| 648 | _x( "Type 'wp jetpack options' for more info.", "'wp jetpack options' is a command - do not translate.", 'jetpack' ) . "\n" |
||
| 649 | ); |
||
| 650 | break; |
||
| 651 | } |
||
| 652 | } |
||
| 653 | |||
| 654 | /** |
||
| 655 | * Get the status of or start a new Jetpack sync. |
||
| 656 | * |
||
| 657 | * ## OPTIONS |
||
| 658 | * |
||
| 659 | * status : Print the current sync status |
||
| 660 | * start : Start a full sync from this site to WordPress.com |
||
| 661 | * |
||
| 662 | * ## EXAMPLES |
||
| 663 | * |
||
| 664 | * wp jetpack sync status |
||
| 665 | * wp jetpack sync start --modules=functions --sync_wait_time=5 |
||
| 666 | * |
||
| 667 | * @synopsis <status|start> [--<field>=<value>] |
||
| 668 | */ |
||
| 669 | public function sync( $args, $assoc_args ) { |
||
| 778 | |||
| 779 | /** |
||
| 780 | * List the contents of a specific Jetpack sync queue. |
||
| 781 | * |
||
| 782 | * ## OPTIONS |
||
| 783 | * |
||
| 784 | * peek : List the 100 front-most items on the queue. |
||
| 785 | * |
||
| 786 | * ## EXAMPLES |
||
| 787 | * |
||
| 788 | * wp jetpack sync_queue full_sync peek |
||
| 789 | * |
||
| 790 | * @synopsis <incremental|full_sync> <peek> |
||
| 791 | */ |
||
| 792 | public function sync_queue( $args, $assoc_args ) { |
||
| 843 | |||
| 844 | /** |
||
| 845 | * Cancel's the current Jetpack plan granted by this partner, if applicable |
||
| 846 | * |
||
| 847 | * Returns success or error JSON |
||
| 848 | * |
||
| 849 | * <token_json> |
||
| 850 | * : JSON blob of WPCOM API token |
||
| 851 | * [--partner_tracking_id=<partner_tracking_id>] |
||
| 852 | * : This is an optional ID that a host can pass to help identify a site in logs on WordPress.com |
||
| 853 | * |
||
| 854 | * * @synopsis <token_json> [--partner_tracking_id=<partner_tracking_id>] |
||
| 855 | */ |
||
| 856 | public function partner_cancel( $args, $named_args ) { |
||
| 908 | |||
| 909 | /** |
||
| 910 | * Provision a site using a Jetpack Partner license |
||
| 911 | * |
||
| 912 | * Returns JSON blob |
||
| 913 | * |
||
| 914 | * ## OPTIONS |
||
| 915 | * |
||
| 916 | * <token_json> |
||
| 917 | * : JSON blob of WPCOM API token |
||
| 918 | * [--plan=<plan_name>] |
||
| 919 | * : Slug of the requested plan, e.g. premium |
||
| 920 | * [--wpcom_user_id=<user_id>] |
||
| 921 | * : WordPress.com ID of user to connect as (must be whitelisted against partner key) |
||
| 922 | * [--wpcom_user_email=<wpcom_user_email>] |
||
| 923 | * : Override the email we send to WordPress.com for registration |
||
| 924 | * [--onboarding=<onboarding>] |
||
| 925 | * : Guide the user through an onboarding wizard |
||
| 926 | * [--force_register=<register>] |
||
| 927 | * : Whether to force a site to register |
||
| 928 | * [--force_connect=<force_connect>] |
||
| 929 | * : Force JPS to not reuse existing credentials |
||
| 930 | * [--home_url=<home_url>] |
||
| 931 | * : Overrides the home option via the home_url filter, or the WP_HOME constant |
||
| 932 | * [--site_url=<site_url>] |
||
| 933 | * : Overrides the siteurl option via the site_url filter, or the WP_SITEURL constant |
||
| 934 | * [--partner_tracking_id=<partner_tracking_id>] |
||
| 935 | * : This is an optional ID that a host can pass to help identify a site in logs on WordPress.com |
||
| 936 | * |
||
| 937 | * ## EXAMPLES |
||
| 938 | * |
||
| 939 | * $ wp jetpack partner_provision '{ some: "json" }' premium 1 |
||
| 940 | * { success: true } |
||
| 941 | * |
||
| 942 | * @synopsis <token_json> [--wpcom_user_id=<user_id>] [--plan=<plan_name>] [--onboarding=<onboarding>] [--force_register=<register>] [--force_connect=<force_connect>] [--home_url=<home_url>] [--site_url=<site_url>] [--wpcom_user_email=<wpcom_user_email>] [--partner_tracking_id=<partner_tracking_id>] |
||
| 943 | */ |
||
| 944 | public function partner_provision( $args, $named_args ) { |
||
| 977 | |||
| 978 | /** |
||
| 979 | * Manages your Jetpack sitemap |
||
| 980 | * |
||
| 981 | * ## OPTIONS |
||
| 982 | * |
||
| 983 | * rebuild : Rebuild all sitemaps |
||
| 984 | * --purge : if set, will remove all existing sitemap data before rebuilding |
||
| 985 | * |
||
| 986 | * ## EXAMPLES |
||
| 987 | * |
||
| 988 | * wp jetpack sitemap rebuild |
||
| 989 | * |
||
| 990 | * @subcommand sitemap |
||
| 991 | * @synopsis <rebuild> [--purge] |
||
| 992 | */ |
||
| 993 | public function sitemap( $args, $assoc_args ) { |
||
| 1012 | |||
| 1013 | /** |
||
| 1014 | * Allows authorizing a user via the command line and will activate |
||
| 1015 | * |
||
| 1016 | * ## EXAMPLES |
||
| 1017 | * |
||
| 1018 | * wp jetpack authorize_user --token=123456789abcdef |
||
| 1019 | * |
||
| 1020 | * @synopsis --token=<value> |
||
| 1021 | */ |
||
| 1022 | public function authorize_user( $args, $named_args ) { |
||
| 1058 | |||
| 1059 | /** |
||
| 1060 | * Allows calling a WordPress.com API endpoint using the current blog's token. |
||
| 1061 | * |
||
| 1062 | * ## OPTIONS |
||
| 1063 | * --resource=<resource> |
||
| 1064 | * : The resource to call with the current blog's token, where `%d` represents the current blog's ID. |
||
| 1065 | * |
||
| 1066 | * [--api_version=<api_version>] |
||
| 1067 | * : The API version to query against. |
||
| 1068 | * |
||
| 1069 | * [--base_api_path=<base_api_path>] |
||
| 1070 | * : The base API path to query. |
||
| 1071 | * --- |
||
| 1072 | * default: rest |
||
| 1073 | * --- |
||
| 1074 | * |
||
| 1075 | * [--body=<body>] |
||
| 1076 | * : A JSON encoded string representing arguments to send in the body. |
||
| 1077 | * |
||
| 1078 | * [--field=<value>] |
||
| 1079 | * : Any number of arguments that should be passed to the resource. |
||
| 1080 | * |
||
| 1081 | * [--pretty] |
||
| 1082 | * : Will pretty print the results of a successful API call. |
||
| 1083 | * |
||
| 1084 | * [--strip-success] |
||
| 1085 | * : Will remove the green success label from successful API calls. |
||
| 1086 | * |
||
| 1087 | * ## EXAMPLES |
||
| 1088 | * |
||
| 1089 | * wp jetpack call_api --resource='/sites/%d' |
||
| 1090 | */ |
||
| 1091 | public function call_api( $args, $named_args ) { |
||
| 1157 | |||
| 1158 | /** |
||
| 1159 | * API wrapper for getting stats from the WordPress.com API for the current site. |
||
| 1160 | * |
||
| 1161 | * ## OPTIONS |
||
| 1162 | * |
||
| 1163 | * [--quantity=<quantity>] |
||
| 1164 | * : The number of units to include. |
||
| 1165 | * --- |
||
| 1166 | * default: 30 |
||
| 1167 | * --- |
||
| 1168 | * |
||
| 1169 | * [--period=<period>] |
||
| 1170 | * : The unit of time to query stats for. |
||
| 1171 | * --- |
||
| 1172 | * default: day |
||
| 1173 | * options: |
||
| 1174 | * - day |
||
| 1175 | * - week |
||
| 1176 | * - month |
||
| 1177 | * - year |
||
| 1178 | * --- |
||
| 1179 | * |
||
| 1180 | * [--date=<date>] |
||
| 1181 | * : The latest date to return stats for. Ex. - 2018-01-01. |
||
| 1182 | * |
||
| 1183 | * [--pretty] |
||
| 1184 | * : Will pretty print the results of a successful API call. |
||
| 1185 | * |
||
| 1186 | * [--strip-success] |
||
| 1187 | * : Will remove the green success label from successful API calls. |
||
| 1188 | * |
||
| 1189 | * ## EXAMPLES |
||
| 1190 | * |
||
| 1191 | * wp jetpack get_stats |
||
| 1192 | */ |
||
| 1193 | public function get_stats( $args, $named_args ) { |
||
| 1226 | |||
| 1227 | /* |
||
| 1228 | * Allows management of publicize connections. |
||
| 1229 | * |
||
| 1230 | * ## OPTIONS |
||
| 1231 | * |
||
| 1232 | * <list|disconnect> |
||
| 1233 | * : The action to perform. |
||
| 1234 | * --- |
||
| 1235 | * options: |
||
| 1236 | * - list |
||
| 1237 | * - disconnect |
||
| 1238 | * --- |
||
| 1239 | * |
||
| 1240 | * [<identifier>] |
||
| 1241 | * : The connection ID or service to perform an action on. |
||
| 1242 | * |
||
| 1243 | * [--format=<format>] |
||
| 1244 | * : Allows overriding the output of the command when listing connections. |
||
| 1245 | * --- |
||
| 1246 | * default: table |
||
| 1247 | * options: |
||
| 1248 | * - table |
||
| 1249 | * - json |
||
| 1250 | * - csv |
||
| 1251 | * - yaml |
||
| 1252 | * - ids |
||
| 1253 | * - count |
||
| 1254 | * --- |
||
| 1255 | * |
||
| 1256 | * ## EXAMPLES |
||
| 1257 | * |
||
| 1258 | * wp jetpack publicize list |
||
| 1259 | * wp jetpack publicize list twitter |
||
| 1260 | * wp --user=1 jetpack publicize list |
||
| 1261 | * wp --user=1 jetpack publicize list twitter |
||
| 1262 | * wp jetpack publicize list 123456 |
||
| 1263 | * wp jetpack publicize disconnect 123456 |
||
| 1264 | * wp jetpack publicize disconnect all |
||
| 1265 | * wp jetpack publicize disconnect twitter |
||
| 1266 | */ |
||
| 1267 | public function publicize( $args, $named_args ) { |
||
| 1406 | |||
| 1407 | private function get_api_host() { |
||
| 1411 | |||
| 1412 | private function partner_provision_error( $error ) { |
||
| 1420 | } |
||
| 1421 | |||
| 1458 |
Loading history...
In PHP, under loose comparison (like
==, or!=, orswitchconditions), values of different types might be equal.For
stringvalues, the empty string''is a special case, in particular the following results might be unexpected: