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 |
||
| 17 | class Jetpack_CLI extends WP_CLI_Command { |
||
| 18 | // Aesthetics |
||
| 19 | public $green_open = "\033[32m"; |
||
| 20 | public $red_open = "\033[31m"; |
||
| 21 | public $yellow_open = "\033[33m"; |
||
| 22 | public $color_close = "\033[0m"; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * Get Jetpack Details |
||
| 26 | * |
||
| 27 | * ## OPTIONS |
||
| 28 | * |
||
| 29 | * empty: Leave it empty for basic stats |
||
| 30 | * |
||
| 31 | * full: View full stats. It's the data from the heartbeat |
||
| 32 | * |
||
| 33 | * ## EXAMPLES |
||
| 34 | * |
||
| 35 | * wp jetpack status |
||
| 36 | * wp jetpack status full |
||
| 37 | * |
||
| 38 | */ |
||
| 39 | public function status( $args, $assoc_args ) { |
||
| 40 | jetpack_require_lib( 'debugger' ); |
||
| 41 | |||
| 42 | /* translators: %s is the site URL */ |
||
| 43 | WP_CLI::line( sprintf( __( 'Checking status for %s', 'jetpack' ), esc_url( get_home_url() ) ) ); |
||
| 44 | |||
| 45 | View Code Duplication | if ( isset( $args[0] ) && 'full' !== $args[0] ) { |
|
| 46 | /* translators: %s is a command like "prompt" */ |
||
| 47 | WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $args[0] ) ); |
||
| 48 | } |
||
| 49 | |||
| 50 | $master_user_email = Jetpack::get_master_user_email(); |
||
| 51 | |||
| 52 | $cxntests = new Jetpack_Cxn_Tests(); |
||
| 53 | |||
| 54 | if ( $cxntests->pass() ) { |
||
| 55 | $cxntests->output_results_for_cli(); |
||
| 56 | |||
| 57 | WP_CLI::success( __( 'Jetpack is currently connected to WordPress.com', 'jetpack' ) ); |
||
| 58 | } else { |
||
| 59 | $error = array(); |
||
| 60 | foreach ( $cxntests->list_fails() as $fail ) { |
||
|
|
|||
| 61 | $error[] = $fail['name'] . ': ' . $fail['message']; |
||
| 62 | } |
||
| 63 | WP_CLI::error_multi_line( $error ); |
||
| 64 | |||
| 65 | $cxntests->output_results_for_cli(); |
||
| 66 | |||
| 67 | WP_CLI::error( __('Jetpack connection is broken.', 'jetpack' ) ); // Exit CLI. |
||
| 68 | } |
||
| 69 | |||
| 70 | /* translators: %s is current version of Jetpack, for example 7.3 */ |
||
| 71 | WP_CLI::line( sprintf( __( 'The Jetpack Version is %s', 'jetpack' ), JETPACK__VERSION ) ); |
||
| 72 | /* translators: %d is WP.com ID of this blog */ |
||
| 73 | WP_CLI::line( sprintf( __( 'The WordPress.com blog_id is %d', 'jetpack' ), Jetpack_Options::get_option( 'id' ) ) ); |
||
| 74 | /* translators: %s is the email address of the connection owner */ |
||
| 75 | WP_CLI::line( sprintf( __( 'The WordPress.com account for the primary connection is %s', 'jetpack' ), $master_user_email ) ); |
||
| 76 | |||
| 77 | /* |
||
| 78 | * Are they asking for all data? |
||
| 79 | * |
||
| 80 | * Loop through heartbeat data and organize by priority. |
||
| 81 | */ |
||
| 82 | $all_data = ( isset( $args[0] ) && 'full' == $args[0] ) ? 'full' : false; |
||
| 83 | if ( $all_data ) { |
||
| 84 | // Heartbeat data |
||
| 85 | WP_CLI::line( "\n" . __( 'Additional data: ', 'jetpack' ) ); |
||
| 86 | |||
| 87 | // Get the filtered heartbeat data. |
||
| 88 | // Filtered so we can color/list by severity |
||
| 89 | $stats = Jetpack::jetpack_check_heartbeat_data(); |
||
| 90 | |||
| 91 | // Display red flags first |
||
| 92 | foreach ( $stats['bad'] as $stat => $value ) { |
||
| 93 | printf( "$this->red_open%-'.16s %s $this->color_close\n", $stat, $value ); |
||
| 94 | } |
||
| 95 | |||
| 96 | // Display caution warnings next |
||
| 97 | foreach ( $stats['caution'] as $stat => $value ) { |
||
| 98 | printf( "$this->yellow_open%-'.16s %s $this->color_close\n", $stat, $value ); |
||
| 99 | } |
||
| 100 | |||
| 101 | // The rest of the results are good! |
||
| 102 | foreach ( $stats['good'] as $stat => $value ) { |
||
| 103 | |||
| 104 | // Modules should get special spacing for aestetics |
||
| 105 | if ( strpos( $stat, 'odule-' ) ) { |
||
| 106 | printf( "%-'.30s %s\n", $stat, $value ); |
||
| 107 | usleep( 4000 ); // For dramatic effect lolz |
||
| 108 | continue; |
||
| 109 | } |
||
| 110 | printf( "%-'.16s %s\n", $stat, $value ); |
||
| 111 | usleep( 4000 ); // For dramatic effect lolz |
||
| 112 | } |
||
| 113 | } else { |
||
| 114 | // Just the basics |
||
| 115 | WP_CLI::line( "\n" . _x( "View full status with 'wp jetpack status full'", '"wp jetpack status full" is a command - do not translate', 'jetpack' ) ); |
||
| 116 | } |
||
| 117 | } |
||
| 118 | |||
| 119 | /** |
||
| 120 | * Tests the active connection |
||
| 121 | * |
||
| 122 | * 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. |
||
| 123 | * |
||
| 124 | * ## EXAMPLES |
||
| 125 | * |
||
| 126 | * wp jetpack test-connection |
||
| 127 | * |
||
| 128 | * @subcommand test-connection |
||
| 129 | */ |
||
| 130 | public function test_connection( $args, $assoc_args ) { |
||
| 131 | |||
| 132 | /* translators: %s is the site URL */ |
||
| 133 | WP_CLI::line( sprintf( __( 'Testing connection for %s', 'jetpack' ), esc_url( get_site_url() ) ) ); |
||
| 134 | |||
| 135 | if ( ! Jetpack::is_active() ) { |
||
| 136 | WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) ); |
||
| 137 | } |
||
| 138 | |||
| 139 | $response = Client::wpcom_json_api_request_as_blog( |
||
| 140 | sprintf( '/jetpack-blogs/%d/test-connection', Jetpack_Options::get_option( 'id' ) ), |
||
| 141 | Client::WPCOM_JSON_API_VERSION |
||
| 142 | ); |
||
| 143 | |||
| 144 | View Code Duplication | if ( is_wp_error( $response ) ) { |
|
| 145 | /* translators: %1$s is the error code, %2$s is the error message */ |
||
| 146 | WP_CLI::error( sprintf( __( 'Failed to test connection (#%1$s: %2$s)', 'jetpack' ), $response->get_error_code(), $response->get_error_message() ) ); |
||
| 147 | } |
||
| 148 | |||
| 149 | $body = wp_remote_retrieve_body( $response ); |
||
| 150 | if ( ! $body ) { |
||
| 151 | WP_CLI::error( __( 'Failed to test connection (empty response body)', 'jetpack' ) ); |
||
| 152 | } |
||
| 153 | |||
| 154 | $result = json_decode( $body ); |
||
| 155 | $is_connected = (bool) $result->connected; |
||
| 156 | $message = $result->message; |
||
| 157 | |||
| 158 | if ( $is_connected ) { |
||
| 159 | WP_CLI::success( $message ); |
||
| 160 | } else { |
||
| 161 | WP_CLI::error( $message ); |
||
| 162 | } |
||
| 163 | } |
||
| 164 | |||
| 165 | /** |
||
| 166 | * Disconnect Jetpack Blogs or Users |
||
| 167 | * |
||
| 168 | * ## OPTIONS |
||
| 169 | * |
||
| 170 | * blog: Disconnect the entire blog. |
||
| 171 | * |
||
| 172 | * user <user_identifier>: Disconnect a specific user from WordPress.com. |
||
| 173 | * |
||
| 174 | * Please note, the primary account that the blog is connected |
||
| 175 | * to WordPress.com with cannot be disconnected without |
||
| 176 | * disconnecting the entire blog. |
||
| 177 | * |
||
| 178 | * ## EXAMPLES |
||
| 179 | * |
||
| 180 | * wp jetpack disconnect blog |
||
| 181 | * wp jetpack disconnect user 13 |
||
| 182 | * wp jetpack disconnect user username |
||
| 183 | * wp jetpack disconnect user [email protected] |
||
| 184 | * |
||
| 185 | * @synopsis <blog|user> [<user_identifier>] |
||
| 186 | */ |
||
| 187 | public function disconnect( $args, $assoc_args ) { |
||
| 188 | if ( ! Jetpack::is_active() ) { |
||
| 189 | WP_CLI::error( __( 'You cannot disconnect, without having first connected.', 'jetpack' ) ); |
||
| 190 | } |
||
| 191 | |||
| 192 | $action = isset( $args[0] ) ? $args[0] : 'prompt'; |
||
| 193 | if ( ! in_array( $action, array( 'blog', 'user', 'prompt' ) ) ) { |
||
| 194 | /* translators: %s is a command like "prompt" */ |
||
| 195 | WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) ); |
||
| 196 | } |
||
| 197 | |||
| 198 | if ( in_array( $action, array( 'user' ) ) ) { |
||
| 199 | if ( isset( $args[1] ) ) { |
||
| 200 | $user_id = $args[1]; |
||
| 201 | if ( ctype_digit( $user_id ) ) { |
||
| 202 | $field = 'id'; |
||
| 203 | $user_id = (int) $user_id; |
||
| 204 | } elseif ( is_email( $user_id ) ) { |
||
| 205 | $field = 'email'; |
||
| 206 | $user_id = sanitize_user( $user_id, true ); |
||
| 207 | } else { |
||
| 208 | $field = 'login'; |
||
| 209 | $user_id = sanitize_user( $user_id, true ); |
||
| 210 | } |
||
| 211 | if ( ! $user = get_user_by( $field, $user_id ) ) { |
||
| 212 | WP_CLI::error( __( 'Please specify a valid user.', 'jetpack' ) ); |
||
| 213 | } |
||
| 214 | } else { |
||
| 215 | WP_CLI::error( __( 'Please specify a user by either ID, username, or email.', 'jetpack' ) ); |
||
| 216 | } |
||
| 217 | } |
||
| 218 | |||
| 219 | switch ( $action ) { |
||
| 220 | case 'blog': |
||
| 221 | Jetpack::log( 'disconnect' ); |
||
| 222 | Jetpack::disconnect(); |
||
| 223 | WP_CLI::success( sprintf( |
||
| 224 | /* translators: %s is the site URL */ |
||
| 225 | __( 'Jetpack has been successfully disconnected for %s.', 'jetpack' ), |
||
| 226 | esc_url( get_site_url() ) |
||
| 227 | ) ); |
||
| 228 | break; |
||
| 229 | case 'user': |
||
| 230 | if ( Jetpack::unlink_user( $user->ID ) ) { |
||
| 231 | Jetpack::log( 'unlink', $user->ID ); |
||
| 232 | WP_CLI::success( __( 'User has been successfully disconnected.', 'jetpack' ) ); |
||
| 233 | } else { |
||
| 234 | /* translators: %s is a username */ |
||
| 235 | WP_CLI::error( sprintf( __( "User %s could not be disconnected. Are you sure they're connected currently?", 'jetpack' ), "{$user->login} <{$user->email}>" ) ); |
||
| 236 | } |
||
| 237 | break; |
||
| 238 | case 'prompt': |
||
| 239 | WP_CLI::error( __( 'Please specify if you would like to disconnect a blog or user.', 'jetpack' ) ); |
||
| 240 | break; |
||
| 241 | } |
||
| 242 | } |
||
| 243 | |||
| 244 | /** |
||
| 245 | * Reset Jetpack options and settings to default |
||
| 246 | * |
||
| 247 | * ## OPTIONS |
||
| 248 | * |
||
| 249 | * modules: Resets modules to default state ( get_default_modules() ) |
||
| 250 | * |
||
| 251 | * options: Resets all Jetpack options except: |
||
| 252 | * - All private options (Blog token, user token, etc...) |
||
| 253 | * - id (The Client ID/WP.com Blog ID of this site) |
||
| 254 | * - master_user |
||
| 255 | * - version |
||
| 256 | * - activated |
||
| 257 | * |
||
| 258 | * ## EXAMPLES |
||
| 259 | * |
||
| 260 | * wp jetpack reset options |
||
| 261 | * wp jetpack reset modules |
||
| 262 | * wp jetpack reset sync-checksum --dry-run --offset=0 |
||
| 263 | * |
||
| 264 | * @synopsis <modules|options|sync-checksum> [--dry-run] [--offset=<offset>] |
||
| 265 | * |
||
| 266 | */ |
||
| 267 | public function reset( $args, $assoc_args ) { |
||
| 268 | $action = isset( $args[0] ) ? $args[0] : 'prompt'; |
||
| 269 | View Code Duplication | if ( ! in_array( $action, array( 'options', 'modules', 'sync-checksum' ), true ) ) { |
|
| 270 | /* translators: %s is a command like "prompt" */ |
||
| 271 | WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) ); |
||
| 272 | } |
||
| 273 | |||
| 274 | $is_dry_run = ! empty( $assoc_args['dry-run'] ); |
||
| 275 | |||
| 276 | View Code Duplication | if ( $is_dry_run ) { |
|
| 277 | WP_CLI::warning( |
||
| 278 | __( "\nThis is a dry run.\n", 'jetpack' ) . |
||
| 279 | __( "No actions will be taken.\n", 'jetpack' ) . |
||
| 280 | __( "The following messages will give you preview of what will happen when you run this command.\n\n", 'jetpack' ) |
||
| 281 | ); |
||
| 282 | } else { |
||
| 283 | // We only need to confirm "Are you sure?" when we are not doing a dry run. |
||
| 284 | jetpack_cli_are_you_sure(); |
||
| 285 | } |
||
| 286 | |||
| 287 | switch ( $action ) { |
||
| 288 | case 'options': |
||
| 289 | $options_to_reset = Jetpack_Options::get_options_for_reset(); |
||
| 290 | // Reset the Jetpack options |
||
| 291 | WP_CLI::line( sprintf( |
||
| 292 | /* translators: %s is the site URL */ |
||
| 293 | __( "Resetting Jetpack Options for %s...\n", "jetpack" ), |
||
| 294 | esc_url( get_site_url() ) |
||
| 295 | ) ); |
||
| 296 | sleep(1); // Take a breath |
||
| 297 | View Code Duplication | foreach ( $options_to_reset['jp_options'] as $option_to_reset ) { |
|
| 298 | if ( ! $is_dry_run ) { |
||
| 299 | Jetpack_Options::delete_option( $option_to_reset ); |
||
| 300 | usleep( 100000 ); |
||
| 301 | } |
||
| 302 | |||
| 303 | /* translators: This is the result of an action. The option named %s was reset */ |
||
| 304 | WP_CLI::success( sprintf( __( '%s option reset', 'jetpack' ), $option_to_reset ) ); |
||
| 305 | } |
||
| 306 | |||
| 307 | // Reset the WP options |
||
| 308 | WP_CLI::line( __( "Resetting the jetpack options stored in wp_options...\n", "jetpack" ) ); |
||
| 309 | usleep( 500000 ); // Take a breath |
||
| 310 | View Code Duplication | foreach ( $options_to_reset['wp_options'] as $option_to_reset ) { |
|
| 311 | if ( ! $is_dry_run ) { |
||
| 312 | delete_option( $option_to_reset ); |
||
| 313 | usleep( 100000 ); |
||
| 314 | } |
||
| 315 | /* translators: This is the result of an action. The option named %s was reset */ |
||
| 316 | WP_CLI::success( sprintf( __( '%s option reset', 'jetpack' ), $option_to_reset ) ); |
||
| 317 | } |
||
| 318 | |||
| 319 | // Reset to default modules |
||
| 320 | WP_CLI::line( __( "Resetting default modules...\n", "jetpack" ) ); |
||
| 321 | usleep( 500000 ); // Take a breath |
||
| 322 | $default_modules = Jetpack::get_default_modules(); |
||
| 323 | if ( ! $is_dry_run ) { |
||
| 324 | Jetpack::update_active_modules( $default_modules ); |
||
| 325 | } |
||
| 326 | WP_CLI::success( __( 'Modules reset to default.', 'jetpack' ) ); |
||
| 327 | break; |
||
| 328 | View Code Duplication | case 'modules': |
|
| 329 | if ( ! $is_dry_run ) { |
||
| 330 | $default_modules = Jetpack::get_default_modules(); |
||
| 331 | Jetpack::update_active_modules( $default_modules ); |
||
| 332 | } |
||
| 333 | |||
| 334 | WP_CLI::success( __( 'Modules reset to default.', 'jetpack' ) ); |
||
| 335 | break; |
||
| 336 | case 'prompt': |
||
| 337 | WP_CLI::error( __( 'Please specify if you would like to reset your options, modules or sync-checksum', 'jetpack' ) ); |
||
| 338 | break; |
||
| 339 | case 'sync-checksum': |
||
| 340 | $option = 'jetpack_callables_sync_checksum'; |
||
| 341 | |||
| 342 | if ( is_multisite() ) { |
||
| 343 | $offset = isset( $assoc_args['offset'] ) ? (int) $assoc_args['offset'] : 0; |
||
| 344 | |||
| 345 | /* |
||
| 346 | * 1000 is a good limit since we don't expect the number of sites to be more than 1000 |
||
| 347 | * Offset can be used to paginate and try to clean up more sites. |
||
| 348 | */ |
||
| 349 | $sites = get_sites( array( 'number' => 1000, 'offset' => $offset ) ); |
||
| 350 | $count_fixes = 0; |
||
| 351 | foreach ( $sites as $site ) { |
||
| 352 | switch_to_blog( $site->blog_id ); |
||
| 353 | $count = self::count_option( $option ); |
||
| 354 | if ( $count > 1 ) { |
||
| 355 | if ( ! $is_dry_run ) { |
||
| 356 | delete_option( $option ); |
||
| 357 | } |
||
| 358 | WP_CLI::line( |
||
| 359 | sprintf( |
||
| 360 | /* translators: %1$d is a number, %2$s is the name of an option, %2$s is the site URL. */ |
||
| 361 | __( 'Deleted %1$d %2$s options from %3$s', 'jetpack' ), |
||
| 362 | $count, |
||
| 363 | $option, |
||
| 364 | "{$site->domain}{$site->path}" |
||
| 365 | ) |
||
| 366 | ); |
||
| 367 | $count_fixes++; |
||
| 368 | if ( ! $is_dry_run ) { |
||
| 369 | /* |
||
| 370 | * We could be deleting a lot of options rows at the same time. |
||
| 371 | * Allow some time for replication to catch up. |
||
| 372 | */ |
||
| 373 | sleep( 3 ); |
||
| 374 | } |
||
| 375 | } |
||
| 376 | |||
| 377 | restore_current_blog(); |
||
| 378 | } |
||
| 379 | if ( $count_fixes ) { |
||
| 380 | WP_CLI::success( |
||
| 381 | sprintf( |
||
| 382 | /* translators: %1$s is the name of an option, %2$d is a number of sites. */ |
||
| 383 | __( 'Successfully reset %1$s on %2$d sites.', 'jetpack' ), |
||
| 384 | $option, |
||
| 385 | $count_fixes |
||
| 386 | ) |
||
| 387 | ); |
||
| 388 | } else { |
||
| 389 | WP_CLI::success( __( 'No options were deleted.', 'jetpack' ) ); |
||
| 390 | } |
||
| 391 | return; |
||
| 392 | } |
||
| 393 | |||
| 394 | $count = self::count_option( $option ); |
||
| 395 | if ( $count > 1 ) { |
||
| 396 | if ( ! $is_dry_run ) { |
||
| 397 | delete_option( $option ); |
||
| 398 | } |
||
| 399 | WP_CLI::success( |
||
| 400 | sprintf( |
||
| 401 | /* translators: %1$d is a number, %2$s is the name of an option. */ |
||
| 402 | __( 'Deleted %1$d %2$s options', 'jetpack' ), |
||
| 403 | $count, |
||
| 404 | $option |
||
| 405 | ) |
||
| 406 | ); |
||
| 407 | return; |
||
| 408 | } |
||
| 409 | |||
| 410 | WP_CLI::success( __( 'No options were deleted.', 'jetpack' ) ); |
||
| 411 | break; |
||
| 412 | |||
| 413 | } |
||
| 414 | } |
||
| 415 | |||
| 416 | /** |
||
| 417 | * Return the number of times an option appears |
||
| 418 | * Normally an option would only appear 1 since the option key is supposed to be unique |
||
| 419 | * but if a site hasn't updated the DB schema then that would not be the case. |
||
| 420 | * |
||
| 421 | * @param string $option Option name. |
||
| 422 | * |
||
| 423 | * @return int |
||
| 424 | */ |
||
| 425 | private static function count_option( $option ) { |
||
| 435 | |||
| 436 | /** |
||
| 437 | * Manage Jetpack Modules |
||
| 438 | * |
||
| 439 | * ## OPTIONS |
||
| 440 | * |
||
| 441 | * <list|activate|deactivate|toggle> |
||
| 442 | * : The action to take. |
||
| 443 | * --- |
||
| 444 | * default: list |
||
| 445 | * options: |
||
| 446 | * - list |
||
| 447 | * - activate |
||
| 448 | * - deactivate |
||
| 449 | * - toggle |
||
| 450 | * --- |
||
| 451 | * |
||
| 452 | * [<module_slug>] |
||
| 453 | * : The slug of the module to perform an action on. |
||
| 454 | * |
||
| 455 | * [--format=<format>] |
||
| 456 | * : Allows overriding the output of the command when listing modules. |
||
| 457 | * --- |
||
| 458 | * default: table |
||
| 459 | * options: |
||
| 460 | * - table |
||
| 461 | * - json |
||
| 462 | * - csv |
||
| 463 | * - yaml |
||
| 464 | * - ids |
||
| 465 | * - count |
||
| 466 | * --- |
||
| 467 | * |
||
| 468 | * ## EXAMPLES |
||
| 469 | * |
||
| 470 | * wp jetpack module list |
||
| 471 | * wp jetpack module list --format=json |
||
| 472 | * wp jetpack module activate stats |
||
| 473 | * wp jetpack module deactivate stats |
||
| 474 | * wp jetpack module toggle stats |
||
| 475 | * wp jetpack module activate all |
||
| 476 | * wp jetpack module deactivate all |
||
| 477 | */ |
||
| 478 | public function module( $args, $assoc_args ) { |
||
| 552 | |||
| 553 | /** |
||
| 554 | * Manage Protect Settings |
||
| 555 | * |
||
| 556 | * ## OPTIONS |
||
| 557 | * |
||
| 558 | * whitelist: Whitelist an IP address. You can also read or clear the whitelist. |
||
| 559 | * |
||
| 560 | * |
||
| 561 | * ## EXAMPLES |
||
| 562 | * |
||
| 563 | * wp jetpack protect whitelist <ip address> |
||
| 564 | * wp jetpack protect whitelist list |
||
| 565 | * wp jetpack protect whitelist clear |
||
| 566 | * |
||
| 567 | * @synopsis <whitelist> [<ip|ip_low-ip_high|list|clear>] |
||
| 568 | */ |
||
| 569 | public function protect( $args, $assoc_args ) { |
||
| 674 | |||
| 675 | /** |
||
| 676 | * Manage Jetpack Options |
||
| 677 | * |
||
| 678 | * ## OPTIONS |
||
| 679 | * |
||
| 680 | * list : List all jetpack options and their values |
||
| 681 | * delete : Delete an option |
||
| 682 | * - can only delete options that are white listed. |
||
| 683 | * update : update an option |
||
| 684 | * - can only update option strings |
||
| 685 | * get : get the value of an option |
||
| 686 | * |
||
| 687 | * ## EXAMPLES |
||
| 688 | * |
||
| 689 | * wp jetpack options list |
||
| 690 | * wp jetpack options get <option_name> |
||
| 691 | * wp jetpack options delete <option_name> |
||
| 692 | * wp jetpack options update <option_name> [<option_value>] |
||
| 693 | * |
||
| 694 | * @synopsis <list|get|delete|update> [<option_name>] [<option_value>] |
||
| 695 | */ |
||
| 696 | public function options( $args, $assoc_args ) { |
||
| 792 | |||
| 793 | /** |
||
| 794 | * Get the status of or start a new Jetpack sync. |
||
| 795 | * |
||
| 796 | * ## OPTIONS |
||
| 797 | * |
||
| 798 | * status : Print the current sync status |
||
| 799 | * settings : Prints the current sync settings |
||
| 800 | * start : Start a full sync from this site to WordPress.com |
||
| 801 | * enable : Enables sync on the site |
||
| 802 | * disable : Disable sync on a site |
||
| 803 | * reset : Disables sync and Resets the sync queues on a site |
||
| 804 | * |
||
| 805 | * ## EXAMPLES |
||
| 806 | * |
||
| 807 | * wp jetpack sync status |
||
| 808 | * wp jetpack sync settings |
||
| 809 | * wp jetpack sync start --modules=functions --sync_wait_time=5 |
||
| 810 | * wp jetpack sync enable |
||
| 811 | * wp jetpack sync disable |
||
| 812 | * wp jetpack sync reset |
||
| 813 | * wp jetpack sync reset --queue=full or regular |
||
| 814 | * |
||
| 815 | * @synopsis <status|start> [--<field>=<value>] |
||
| 816 | */ |
||
| 817 | public function sync( $args, $assoc_args ) { |
||
| 1000 | |||
| 1001 | /** |
||
| 1002 | * List the contents of a specific Jetpack sync queue. |
||
| 1003 | * |
||
| 1004 | * ## OPTIONS |
||
| 1005 | * |
||
| 1006 | * peek : List the 100 front-most items on the queue. |
||
| 1007 | * |
||
| 1008 | * ## EXAMPLES |
||
| 1009 | * |
||
| 1010 | * wp jetpack sync_queue full_sync peek |
||
| 1011 | * |
||
| 1012 | * @synopsis <incremental|full_sync> <peek> |
||
| 1013 | */ |
||
| 1014 | public function sync_queue( $args, $assoc_args ) { |
||
| 1064 | |||
| 1065 | /** |
||
| 1066 | * Cancel's the current Jetpack plan granted by this partner, if applicable |
||
| 1067 | * |
||
| 1068 | * Returns success or error JSON |
||
| 1069 | * |
||
| 1070 | * <token_json> |
||
| 1071 | * : JSON blob of WPCOM API token |
||
| 1072 | * [--partner_tracking_id=<partner_tracking_id>] |
||
| 1073 | * : This is an optional ID that a host can pass to help identify a site in logs on WordPress.com |
||
| 1074 | * |
||
| 1075 | * * @synopsis <token_json> [--partner_tracking_id=<partner_tracking_id>] |
||
| 1076 | */ |
||
| 1077 | public function partner_cancel( $args, $named_args ) { |
||
| 1130 | |||
| 1131 | /** |
||
| 1132 | * Provision a site using a Jetpack Partner license |
||
| 1133 | * |
||
| 1134 | * Returns JSON blob |
||
| 1135 | * |
||
| 1136 | * ## OPTIONS |
||
| 1137 | * |
||
| 1138 | * <token_json> |
||
| 1139 | * : JSON blob of WPCOM API token |
||
| 1140 | * [--plan=<plan_name>] |
||
| 1141 | * : Slug of the requested plan, e.g. premium |
||
| 1142 | * [--wpcom_user_id=<user_id>] |
||
| 1143 | * : WordPress.com ID of user to connect as (must be whitelisted against partner key) |
||
| 1144 | * [--wpcom_user_email=<wpcom_user_email>] |
||
| 1145 | * : Override the email we send to WordPress.com for registration |
||
| 1146 | * [--onboarding=<onboarding>] |
||
| 1147 | * : Guide the user through an onboarding wizard |
||
| 1148 | * [--force_register=<register>] |
||
| 1149 | * : Whether to force a site to register |
||
| 1150 | * [--force_connect=<force_connect>] |
||
| 1151 | * : Force JPS to not reuse existing credentials |
||
| 1152 | * [--home_url=<home_url>] |
||
| 1153 | * : Overrides the home option via the home_url filter, or the WP_HOME constant |
||
| 1154 | * [--site_url=<site_url>] |
||
| 1155 | * : Overrides the siteurl option via the site_url filter, or the WP_SITEURL constant |
||
| 1156 | * [--partner_tracking_id=<partner_tracking_id>] |
||
| 1157 | * : This is an optional ID that a host can pass to help identify a site in logs on WordPress.com |
||
| 1158 | * |
||
| 1159 | * ## EXAMPLES |
||
| 1160 | * |
||
| 1161 | * $ wp jetpack partner_provision '{ some: "json" }' premium 1 |
||
| 1162 | * { success: true } |
||
| 1163 | * |
||
| 1164 | * @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>] |
||
| 1165 | */ |
||
| 1166 | public function partner_provision( $args, $named_args ) { |
||
| 1200 | |||
| 1201 | /** |
||
| 1202 | * Manages your Jetpack sitemap |
||
| 1203 | * |
||
| 1204 | * ## OPTIONS |
||
| 1205 | * |
||
| 1206 | * rebuild : Rebuild all sitemaps |
||
| 1207 | * --purge : if set, will remove all existing sitemap data before rebuilding |
||
| 1208 | * |
||
| 1209 | * ## EXAMPLES |
||
| 1210 | * |
||
| 1211 | * wp jetpack sitemap rebuild |
||
| 1212 | * |
||
| 1213 | * @subcommand sitemap |
||
| 1214 | * @synopsis <rebuild> [--purge] |
||
| 1215 | */ |
||
| 1216 | public function sitemap( $args, $assoc_args ) { |
||
| 1235 | |||
| 1236 | /** |
||
| 1237 | * Allows authorizing a user via the command line and will activate |
||
| 1238 | * |
||
| 1239 | * ## EXAMPLES |
||
| 1240 | * |
||
| 1241 | * wp jetpack authorize_user --token=123456789abcdef |
||
| 1242 | * |
||
| 1243 | * @synopsis --token=<value> |
||
| 1244 | */ |
||
| 1245 | public function authorize_user( $args, $named_args ) { |
||
| 1279 | |||
| 1280 | /** |
||
| 1281 | * Allows calling a WordPress.com API endpoint using the current blog's token. |
||
| 1282 | * |
||
| 1283 | * ## OPTIONS |
||
| 1284 | * --resource=<resource> |
||
| 1285 | * : The resource to call with the current blog's token, where `%d` represents the current blog's ID. |
||
| 1286 | * |
||
| 1287 | * [--api_version=<api_version>] |
||
| 1288 | * : The API version to query against. |
||
| 1289 | * |
||
| 1290 | * [--base_api_path=<base_api_path>] |
||
| 1291 | * : The base API path to query. |
||
| 1292 | * --- |
||
| 1293 | * default: rest |
||
| 1294 | * --- |
||
| 1295 | * |
||
| 1296 | * [--body=<body>] |
||
| 1297 | * : A JSON encoded string representing arguments to send in the body. |
||
| 1298 | * |
||
| 1299 | * [--field=<value>] |
||
| 1300 | * : Any number of arguments that should be passed to the resource. |
||
| 1301 | * |
||
| 1302 | * [--pretty] |
||
| 1303 | * : Will pretty print the results of a successful API call. |
||
| 1304 | * |
||
| 1305 | * [--strip-success] |
||
| 1306 | * : Will remove the green success label from successful API calls. |
||
| 1307 | * |
||
| 1308 | * ## EXAMPLES |
||
| 1309 | * |
||
| 1310 | * wp jetpack call_api --resource='/sites/%d' |
||
| 1311 | */ |
||
| 1312 | public function call_api( $args, $named_args ) { |
||
| 1378 | |||
| 1379 | /** |
||
| 1380 | * Allows uploading SSH Credentials to the current site for backups, restores, and security scanning. |
||
| 1381 | * |
||
| 1382 | * ## OPTIONS |
||
| 1383 | * |
||
| 1384 | * [--host=<host>] |
||
| 1385 | * : The SSH server's address. |
||
| 1386 | * |
||
| 1387 | * [--ssh-user=<user>] |
||
| 1388 | * : The username to use to log in to the SSH server. |
||
| 1389 | * |
||
| 1390 | * [--pass=<pass>] |
||
| 1391 | * : The password used to log in, if using a password. (optional) |
||
| 1392 | * |
||
| 1393 | * [--kpri=<kpri>] |
||
| 1394 | * : The private key used to log in, if using a private key. (optional) |
||
| 1395 | * |
||
| 1396 | * [--pretty] |
||
| 1397 | * : Will pretty print the results of a successful API call. (optional) |
||
| 1398 | * |
||
| 1399 | * [--strip-success] |
||
| 1400 | * : Will remove the green success label from successful API calls. (optional) |
||
| 1401 | * |
||
| 1402 | * ## EXAMPLES |
||
| 1403 | * |
||
| 1404 | * wp jetpack upload_ssh_creds --host=example.com --ssh-user=example --pass=password |
||
| 1405 | * wp jetpack updload_ssh_creds --host=example.com --ssh-user=example --kpri=key |
||
| 1406 | */ |
||
| 1407 | public function upload_ssh_creds( $args, $named_args ) { |
||
| 1460 | |||
| 1461 | /** |
||
| 1462 | * API wrapper for getting stats from the WordPress.com API for the current site. |
||
| 1463 | * |
||
| 1464 | * ## OPTIONS |
||
| 1465 | * |
||
| 1466 | * [--quantity=<quantity>] |
||
| 1467 | * : The number of units to include. |
||
| 1468 | * --- |
||
| 1469 | * default: 30 |
||
| 1470 | * --- |
||
| 1471 | * |
||
| 1472 | * [--period=<period>] |
||
| 1473 | * : The unit of time to query stats for. |
||
| 1474 | * --- |
||
| 1475 | * default: day |
||
| 1476 | * options: |
||
| 1477 | * - day |
||
| 1478 | * - week |
||
| 1479 | * - month |
||
| 1480 | * - year |
||
| 1481 | * --- |
||
| 1482 | * |
||
| 1483 | * [--date=<date>] |
||
| 1484 | * : The latest date to return stats for. Ex. - 2018-01-01. |
||
| 1485 | * |
||
| 1486 | * [--pretty] |
||
| 1487 | * : Will pretty print the results of a successful API call. |
||
| 1488 | * |
||
| 1489 | * [--strip-success] |
||
| 1490 | * : Will remove the green success label from successful API calls. |
||
| 1491 | * |
||
| 1492 | * ## EXAMPLES |
||
| 1493 | * |
||
| 1494 | * wp jetpack get_stats |
||
| 1495 | */ |
||
| 1496 | public function get_stats( $args, $named_args ) { |
||
| 1529 | |||
| 1530 | /** |
||
| 1531 | * Allows management of publicize connections. |
||
| 1532 | * |
||
| 1533 | * ## OPTIONS |
||
| 1534 | * |
||
| 1535 | * <list|disconnect> |
||
| 1536 | * : The action to perform. |
||
| 1537 | * --- |
||
| 1538 | * options: |
||
| 1539 | * - list |
||
| 1540 | * - disconnect |
||
| 1541 | * --- |
||
| 1542 | * |
||
| 1543 | * [<identifier>] |
||
| 1544 | * : The connection ID or service to perform an action on. |
||
| 1545 | * |
||
| 1546 | * [--format=<format>] |
||
| 1547 | * : Allows overriding the output of the command when listing connections. |
||
| 1548 | * --- |
||
| 1549 | * default: table |
||
| 1550 | * options: |
||
| 1551 | * - table |
||
| 1552 | * - json |
||
| 1553 | * - csv |
||
| 1554 | * - yaml |
||
| 1555 | * - ids |
||
| 1556 | * - count |
||
| 1557 | * --- |
||
| 1558 | * |
||
| 1559 | * ## EXAMPLES |
||
| 1560 | * |
||
| 1561 | * # List all publicize connections. |
||
| 1562 | * $ wp jetpack publicize list |
||
| 1563 | * |
||
| 1564 | * # List publicize connections for a given service. |
||
| 1565 | * $ wp jetpack publicize list twitter |
||
| 1566 | * |
||
| 1567 | * # List all publicize connections for a given user. |
||
| 1568 | * $ wp --user=1 jetpack publicize list |
||
| 1569 | * |
||
| 1570 | * # List all publicize connections for a given user and service. |
||
| 1571 | * $ wp --user=1 jetpack publicize list twitter |
||
| 1572 | * |
||
| 1573 | * # Display details for a given connection. |
||
| 1574 | * $ wp jetpack publicize list 123456 |
||
| 1575 | * |
||
| 1576 | * # Diconnection a given connection. |
||
| 1577 | * $ wp jetpack publicize disconnect 123456 |
||
| 1578 | * |
||
| 1579 | * # Disconnect all connections. |
||
| 1580 | * $ wp jetpack publicize disconnect all |
||
| 1581 | * |
||
| 1582 | * # Disconnect all connections for a given service. |
||
| 1583 | * $ wp jetpack publicize disconnect twitter |
||
| 1584 | */ |
||
| 1585 | public function publicize( $args, $named_args ) { |
||
| 1758 | |||
| 1759 | private function get_api_host() { |
||
| 1763 | |||
| 1764 | private function partner_provision_error( $error ) { |
||
| 1772 | |||
| 1773 | /** |
||
| 1774 | * Creates the essential files in Jetpack to start building a Gutenberg block or plugin. |
||
| 1775 | * |
||
| 1776 | * ## TYPES |
||
| 1777 | * |
||
| 1778 | * block: it creates a Jetpack block. All files will be created in a directory under extensions/blocks named based on the block title or a specific given slug. |
||
| 1779 | * |
||
| 1780 | * ## BLOCK TYPE OPTIONS |
||
| 1781 | * |
||
| 1782 | * The first parameter is the block title and it's not associative. Add it wrapped in quotes. |
||
| 1783 | * The title is also used to create the slug and the edit PHP class name. If it's something like "Logo gallery", the slug will be 'logo-gallery' and the class name will be LogoGalleryEdit. |
||
| 1784 | * --slug: Specific slug to identify the block that overrides the one generated based on the title. |
||
| 1785 | * --description: Allows to provide a text description of the block. |
||
| 1786 | * --keywords: Provide up to three keywords separated by comma so users can find this block when they search in Gutenberg's inserter. |
||
| 1787 | * |
||
| 1788 | * ## BLOCK TYPE EXAMPLES |
||
| 1789 | * |
||
| 1790 | * wp jetpack scaffold block "Cool Block" |
||
| 1791 | * wp jetpack scaffold block "Amazing Rock" --slug="good-music" --description="Rock the best music on your site" |
||
| 1792 | * wp jetpack scaffold block "Jukebox" --keywords="music, audio, media" |
||
| 1793 | * |
||
| 1794 | * @subcommand scaffold block |
||
| 1795 | * @synopsis <type> <title> [--slug] [--description] [--keywords] |
||
| 1796 | * |
||
| 1797 | * @param array $args Positional parameters, when strings are passed, wrap them in quotes. |
||
| 1798 | * @param array $assoc_args Associative parameters like --slug="nice-block". |
||
| 1799 | */ |
||
| 1800 | public function scaffold( $args, $assoc_args ) { |
||
| 1812 | |||
| 1813 | /** |
||
| 1814 | * Creates the essential files in Jetpack to build a Gutenberg block. |
||
| 1815 | * |
||
| 1816 | * @param array $args Positional parameters. Only one is used, that corresponds to the block title. |
||
| 1817 | * @param array $assoc_args Associative parameters defined in the scaffold() method. |
||
| 1818 | */ |
||
| 1819 | public function block( $args, $assoc_args ) { |
||
| 1936 | |||
| 1937 | /** |
||
| 1938 | * Built the file replacing the placeholders in the template with the data supplied. |
||
| 1939 | * |
||
| 1940 | * @param string $template |
||
| 1941 | * @param array $data |
||
| 1942 | * |
||
| 1943 | * @return string mixed |
||
| 1944 | */ |
||
| 1945 | private static function render_block_file( $template, $data = array() ) { |
||
| 1948 | } |
||
| 1949 | |||
| 1985 |
Loading history...
There are different options of fixing this problem.
If you want to be on the safe side, you can add an additional type-check:
If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:
Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.