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 Publicize_Base 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 Publicize_Base, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 3 | abstract class Publicize_Base { |
||
| 4 | |||
| 5 | /** |
||
| 6 | * Services that are currently connected to the given user |
||
| 7 | * through publicize. |
||
| 8 | */ |
||
| 9 | public $connected_services = array(); |
||
| 10 | |||
| 11 | /** |
||
| 12 | * Services that are supported by publicize. They don't |
||
| 13 | * necessarily need to be connected to the current user. |
||
| 14 | */ |
||
| 15 | public $services; |
||
| 16 | |||
| 17 | /** |
||
| 18 | * key names for post meta |
||
| 19 | */ |
||
| 20 | public $ADMIN_PAGE = 'wpas'; |
||
| 21 | public $POST_MESS = '_wpas_mess'; |
||
| 22 | public $POST_SKIP = '_wpas_skip_'; // connection id appended to indicate that a connection should NOT be publicized to |
||
| 23 | public $POST_DONE = '_wpas_done_'; // connection id appended to indicate a connection has already been publicized to |
||
| 24 | public $USER_AUTH = 'wpas_authorize'; |
||
| 25 | public $USER_OPT = 'wpas_'; |
||
| 26 | public $PENDING = '_publicize_pending'; // ready for Publicize to do its thing |
||
| 27 | public $POST_SERVICE_DONE = '_publicize_done_external'; // array of external ids where we've Publicized |
||
| 28 | |||
| 29 | /** |
||
| 30 | * default pieces of the message used in constructing the |
||
| 31 | * content pushed out to other social networks |
||
| 32 | */ |
||
| 33 | |||
| 34 | public $default_prefix = ''; |
||
| 35 | public $default_message = '%title%'; |
||
| 36 | public $default_suffix = ' '; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * What WP capability is require to create/delete global connections? |
||
| 40 | * All users with this cap can un-globalize all other global connections, and globalize any of their own |
||
| 41 | * Globalized connections cannot be unselected by users without this capability when publishing |
||
| 42 | */ |
||
| 43 | public $GLOBAL_CAP = 'publish_posts'; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * Sets up the basics of Publicize |
||
| 47 | */ |
||
| 48 | function __construct() { |
||
| 49 | $this->default_message = self::build_sprintf( array( |
||
| 50 | /** |
||
| 51 | * Filter the default Publicize message. |
||
| 52 | * |
||
| 53 | * @module publicize |
||
| 54 | * |
||
| 55 | * @since 2.0.0 |
||
| 56 | * |
||
| 57 | * @param string $this->default_message Publicize's default message. Default is the post title. |
||
| 58 | */ |
||
| 59 | apply_filters( 'wpas_default_message', $this->default_message ), |
||
| 60 | 'title', |
||
| 61 | 'url', |
||
| 62 | ) ); |
||
| 63 | |||
| 64 | $this->default_prefix = self::build_sprintf( array( |
||
| 65 | /** |
||
| 66 | * Filter the message prepended to the Publicize custom message. |
||
| 67 | * |
||
| 68 | * @module publicize |
||
| 69 | * |
||
| 70 | * @since 2.0.0 |
||
| 71 | * |
||
| 72 | * @param string $this->default_prefix String prepended to the Publicize custom message. |
||
| 73 | */ |
||
| 74 | apply_filters( 'wpas_default_prefix', $this->default_prefix ), |
||
| 75 | 'url', |
||
| 76 | ) ); |
||
| 77 | |||
| 78 | $this->default_suffix = self::build_sprintf( array( |
||
| 79 | /** |
||
| 80 | * Filter the message appended to the Publicize custom message. |
||
| 81 | * |
||
| 82 | * @module publicize |
||
| 83 | * |
||
| 84 | * @since 2.0.0 |
||
| 85 | * |
||
| 86 | * @param string $this->default_suffix String appended to the Publicize custom message. |
||
| 87 | */ |
||
| 88 | apply_filters( 'wpas_default_suffix', $this->default_suffix ), |
||
| 89 | 'url', |
||
| 90 | ) ); |
||
| 91 | |||
| 92 | /** |
||
| 93 | * Filter the capability to change global Publicize connection options. |
||
| 94 | * |
||
| 95 | * All users with this cap can un-globalize all other global connections, and globalize any of their own |
||
| 96 | * Globalized connections cannot be unselected by users without this capability when publishing. |
||
| 97 | * |
||
| 98 | * @module publicize |
||
| 99 | * |
||
| 100 | * @since 2.2.1 |
||
| 101 | * |
||
| 102 | * @param string $this->GLOBAL_CAP default capability in control of global Publicize connection options. Default to edit_others_posts. |
||
| 103 | */ |
||
| 104 | $this->GLOBAL_CAP = apply_filters( 'jetpack_publicize_global_connections_cap', $this->GLOBAL_CAP ); |
||
| 105 | |||
| 106 | // stage 1 and 2 of 3-stage Publicize. Flag for Publicize on creation, save meta, |
||
| 107 | // then check meta and publicize based on that. stage 3 implemented on wpcom |
||
| 108 | add_action( 'transition_post_status', array( $this, 'flag_post_for_publicize' ), 10, 3 ); |
||
| 109 | add_action( 'save_post', array( &$this, 'save_meta' ), 20, 2 ); |
||
| 110 | |||
| 111 | // Default checkbox state for each Connection |
||
| 112 | add_filter( 'publicize_checkbox_default', array( $this, 'publicize_checkbox_default' ), 10, 4 ); |
||
| 113 | |||
| 114 | // Alter the "Post Publish" admin notice to mention the Connections we Publicized to. |
||
| 115 | add_filter( 'post_updated_messages', array( $this, 'update_published_message' ), 20, 1 ); |
||
| 116 | |||
| 117 | // Connection test callback |
||
| 118 | add_action( 'wp_ajax_test_publicize_conns', array( $this, 'test_publicize_conns' ) ); |
||
| 119 | |||
| 120 | add_action( 'init', array( $this, 'add_post_type_support' ) ); |
||
| 121 | add_action( 'init', array( $this, 'register_post_meta' ), 20 ); |
||
| 122 | add_action( 'jetpack_register_gutenberg_extensions', array( $this, 'register_gutenberg_extension' ) ); |
||
| 123 | } |
||
| 124 | |||
| 125 | /* |
||
| 126 | * Services: Facebook, Twitter, etc. |
||
| 127 | */ |
||
| 128 | |||
| 129 | /** |
||
| 130 | * Get services for the given blog and user. |
||
| 131 | * |
||
| 132 | * Can return all available services or just the ones with an active connection. |
||
| 133 | * |
||
| 134 | * @param string $filter |
||
| 135 | * 'all' (default) - Get all services available for connecting |
||
| 136 | * 'connected' - Get all services currently connected |
||
| 137 | * @param false|int $_blog_id The blog ID. Use false (default) for the current blog |
||
| 138 | * @param false|int $_user_id The user ID. Use false (default) for the current user |
||
| 139 | * @return array |
||
| 140 | */ |
||
| 141 | abstract function get_services( $filter = 'all', $_blog_id = false, $_user_id = false ); |
||
| 142 | |||
| 143 | function can_connect_service( $service_name ) { |
||
| 144 | return true; |
||
| 145 | } |
||
| 146 | |||
| 147 | /** |
||
| 148 | * Does the given user have a connection to the service on the given blog? |
||
| 149 | * |
||
| 150 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 151 | * @param false|int $_blog_id The blog ID. Use false (default) for the current blog |
||
| 152 | * @param false|int $_user_id The user ID. Use false (default) for the current user |
||
| 153 | * @return bool |
||
| 154 | */ |
||
| 155 | function is_enabled( $service_name, $_blog_id = false, $_user_id = false ) { |
||
| 156 | if ( !$_blog_id ) |
||
|
|
|||
| 157 | $_blog_id = $this->blog_id(); |
||
| 158 | |||
| 159 | if ( !$_user_id ) |
||
| 160 | $_user_id = $this->user_id(); |
||
| 161 | |||
| 162 | $connections = $this->get_connections( $service_name, $_blog_id, $_user_id ); |
||
| 163 | return ( is_array( $connections ) && count( $connections ) > 0 ? true : false ); |
||
| 164 | } |
||
| 165 | |||
| 166 | /** |
||
| 167 | * Generates a connection URL. |
||
| 168 | * |
||
| 169 | * This is the URL, which, when visited by the user, starts the authentication |
||
| 170 | * process required to forge a connection. |
||
| 171 | * |
||
| 172 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 173 | * @return string |
||
| 174 | */ |
||
| 175 | abstract function connect_url( $service_name ); |
||
| 176 | |||
| 177 | /** |
||
| 178 | * Generates a Connection refresh URL. |
||
| 179 | * |
||
| 180 | * This is the URL, which, when visited by the user, re-authenticates their |
||
| 181 | * connection to the service. |
||
| 182 | * |
||
| 183 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 184 | * @return string |
||
| 185 | */ |
||
| 186 | abstract function refresh_url( $service_name ); |
||
| 187 | |||
| 188 | /** |
||
| 189 | * Generates a disconnection URL. |
||
| 190 | * |
||
| 191 | * This is the URL, which, when visited by the user, breaks their connection |
||
| 192 | * with the service. |
||
| 193 | * |
||
| 194 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 195 | * @param string $connection_id Connection ID |
||
| 196 | * @return string |
||
| 197 | */ |
||
| 198 | abstract function disconnect_url( $service_name, $connection_id ); |
||
| 199 | |||
| 200 | /** |
||
| 201 | * Returns a display name for the Service |
||
| 202 | * |
||
| 203 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 204 | * @return string |
||
| 205 | */ |
||
| 206 | public static function get_service_label( $service_name ) { |
||
| 207 | switch ( $service_name ) { |
||
| 208 | case 'linkedin': |
||
| 209 | return 'LinkedIn'; |
||
| 210 | break; |
||
| 211 | case 'google_drive': // google-drive used to be called google_drive. |
||
| 212 | case 'google-drive': |
||
| 213 | return 'Google Drive'; |
||
| 214 | break; |
||
| 215 | case 'twitter': |
||
| 216 | case 'facebook': |
||
| 217 | case 'tumblr': |
||
| 218 | default: |
||
| 219 | return ucfirst( $service_name ); |
||
| 220 | break; |
||
| 221 | } |
||
| 222 | } |
||
| 223 | |||
| 224 | /* |
||
| 225 | * Connections: For each Service, there can be multiple connections |
||
| 226 | * for a given user. For example, one user could be connected to Twitter |
||
| 227 | * as both @jetpack and as @wordpressdotcom |
||
| 228 | * |
||
| 229 | * For historical reasons, Connections are represented as an object |
||
| 230 | * on WordPress.com and as an array in Jetpack. |
||
| 231 | */ |
||
| 232 | |||
| 233 | /** |
||
| 234 | * Get the active Connections of a Service |
||
| 235 | * |
||
| 236 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 237 | * @param false|int $_blog_id The blog ID. Use false (default) for the current blog |
||
| 238 | * @param false|int $_user_id The user ID. Use false (default) for the current user |
||
| 239 | * @return false|object[]|array[] false if no connections exist |
||
| 240 | */ |
||
| 241 | abstract function get_connections( $service_name, $_blog_id = false, $_user_id = false ); |
||
| 242 | |||
| 243 | /** |
||
| 244 | * Get a single Connection of a Service |
||
| 245 | * |
||
| 246 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 247 | * @param string $connection_id Connection ID |
||
| 248 | * @param false|int $_blog_id The blog ID. Use false (default) for the current blog |
||
| 249 | * @param false|int $_user_id The user ID. Use false (default) for the current user |
||
| 250 | * @return false|object[]|array[] false if no connections exist |
||
| 251 | */ |
||
| 252 | abstract function get_connection( $service_name, $connection_id, $_blog_id = false, $_user_id = false ); |
||
| 253 | |||
| 254 | /** |
||
| 255 | * Get the Connection ID. |
||
| 256 | * |
||
| 257 | * Note that this is different than the Connection's uniqueid. |
||
| 258 | * |
||
| 259 | * Via a quirk of history, ID is globally unique and unique_id |
||
| 260 | * is only unique per site. |
||
| 261 | * |
||
| 262 | * @param object|array The Connection object (WordPress.com) or array (Jetpack) |
||
| 263 | * @return string |
||
| 264 | */ |
||
| 265 | abstract function get_connection_id( $connection ); |
||
| 266 | |||
| 267 | /** |
||
| 268 | * Get the Connection unique_id |
||
| 269 | * |
||
| 270 | * Note that this is different than the Connections ID. |
||
| 271 | * |
||
| 272 | * Via a quirk of history, ID is globally unique and unique_id |
||
| 273 | * is only unique per site. |
||
| 274 | * |
||
| 275 | * @param object|array The Connection object (WordPress.com) or array (Jetpack) |
||
| 276 | * @return string |
||
| 277 | */ |
||
| 278 | abstract function get_connection_unique_id( $connection ); |
||
| 279 | |||
| 280 | /** |
||
| 281 | * Get the Connection's Meta data |
||
| 282 | * |
||
| 283 | * @param object|array Connection |
||
| 284 | * @return array Connection Meta |
||
| 285 | */ |
||
| 286 | abstract function get_connection_meta( $connection ); |
||
| 287 | |||
| 288 | /** |
||
| 289 | * Disconnect a Connection |
||
| 290 | * |
||
| 291 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 292 | * @param string $connection_id Connection ID |
||
| 293 | * @param false|int $_blog_id The blog ID. Use false (default) for the current blog |
||
| 294 | * @param false|int $_user_id The user ID. Use false (default) for the current user |
||
| 295 | * @param bool $force_delete Whether to skip permissions checks |
||
| 296 | * @return false|void False on failure. Void on success. |
||
| 297 | */ |
||
| 298 | abstract function disconnect( $service_name, $connection_id, $_blog_id = false, $_user_id = false, $force_delete = false ); |
||
| 299 | |||
| 300 | /** |
||
| 301 | * Globalizes a Connection |
||
| 302 | * |
||
| 303 | * @param string $connection_id Connection ID |
||
| 304 | * @return bool Falsey on failure. Truthy on success. |
||
| 305 | */ |
||
| 306 | abstract function globalize_connection( $connection_id ); |
||
| 307 | |||
| 308 | /** |
||
| 309 | * Unglobalizes a Connection |
||
| 310 | * |
||
| 311 | * @param string $connection_id Connection ID |
||
| 312 | * @return bool Falsey on failure. Truthy on success. |
||
| 313 | */ |
||
| 314 | abstract function unglobalize_connection( $connection_id ); |
||
| 315 | |||
| 316 | /** |
||
| 317 | * Returns an external URL to the Connection's profile |
||
| 318 | * |
||
| 319 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 320 | * @param object|array The Connection object (WordPress.com) or array (Jetpack) |
||
| 321 | * @return false|string False on failure. URL on success. |
||
| 322 | */ |
||
| 323 | function get_profile_link( $service_name, $connection ) { |
||
| 324 | $cmeta = $this->get_connection_meta( $connection ); |
||
| 325 | |||
| 326 | if ( isset( $cmeta['connection_data']['meta']['link'] ) ) { |
||
| 327 | if ( 'facebook' == $service_name && 0 === strpos( wp_parse_url( $cmeta['connection_data']['meta']['link'], PHP_URL_PATH ), '/app_scoped_user_id/' ) ) { |
||
| 328 | // App-scoped Facebook user IDs are not usable profile links |
||
| 329 | return false; |
||
| 330 | } |
||
| 331 | |||
| 332 | return $cmeta['connection_data']['meta']['link']; |
||
| 333 | View Code Duplication | } elseif ( 'facebook' == $service_name && isset( $cmeta['connection_data']['meta']['facebook_page'] ) ) { |
|
| 334 | return 'https://facebook.com/' . $cmeta['connection_data']['meta']['facebook_page']; |
||
| 335 | } elseif ( 'tumblr' == $service_name && isset( $cmeta['connection_data']['meta']['tumblr_base_hostname'] ) ) { |
||
| 336 | return 'https://' . $cmeta['connection_data']['meta']['tumblr_base_hostname']; |
||
| 337 | } elseif ( 'twitter' == $service_name ) { |
||
| 338 | return 'https://twitter.com/' . substr( $cmeta['external_display'], 1 ); // Has a leading '@' |
||
| 339 | } else if ( 'linkedin' == $service_name ) { |
||
| 340 | if ( !isset( $cmeta['connection_data']['meta']['profile_url'] ) ) { |
||
| 341 | return false; |
||
| 342 | } |
||
| 343 | |||
| 344 | $profile_url_query = wp_parse_url( $cmeta['connection_data']['meta']['profile_url'], PHP_URL_QUERY ); |
||
| 345 | wp_parse_str( $profile_url_query, $profile_url_query_args ); |
||
| 346 | if ( isset( $profile_url_query_args['key'] ) ) { |
||
| 347 | $id = $profile_url_query_args['key']; |
||
| 348 | } elseif ( isset( $profile_url_query_args['id'] ) ) { |
||
| 349 | $id = $profile_url_query_args['id']; |
||
| 350 | } else { |
||
| 351 | return false; |
||
| 352 | } |
||
| 353 | |||
| 354 | return esc_url_raw( add_query_arg( 'id', urlencode( $id ), 'https://www.linkedin.com/profile/view' ) ); |
||
| 355 | } else { |
||
| 356 | return false; // no fallback. we just won't link it |
||
| 357 | } |
||
| 358 | } |
||
| 359 | |||
| 360 | /** |
||
| 361 | * Returns a display name for the Connection |
||
| 362 | * |
||
| 363 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 364 | * @param object|array The Connection object (WordPress.com) or array (Jetpack) |
||
| 365 | * @return string |
||
| 366 | */ |
||
| 367 | function get_display_name( $service_name, $connection ) { |
||
| 383 | |||
| 384 | /** |
||
| 385 | * Whether the user needs to select additional options after connecting |
||
| 386 | * |
||
| 387 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 388 | * @param object|array The Connection object (WordPress.com) or array (Jetpack) |
||
| 389 | * @return bool |
||
| 390 | */ |
||
| 391 | function show_options_popup( $service_name, $connection ) { |
||
| 414 | |||
| 415 | /** |
||
| 416 | * Whether the Connection is "valid" wrt Facebook's requirements. |
||
| 417 | * |
||
| 418 | * Must be connected to a Page (not a Profile). |
||
| 419 | * (Also returns true if we're in the middle of the connection process) |
||
| 420 | * |
||
| 421 | * @param object|array The Connection object (WordPress.com) or array (Jetpack) |
||
| 422 | * @return bool |
||
| 423 | */ |
||
| 424 | function is_valid_facebook_connection( $connection ) { |
||
| 432 | |||
| 433 | /** |
||
| 434 | * LinkedIn needs to be reauthenticated to use v2 of their API. |
||
| 435 | * If it's using LinkedIn old API, it's an 'invalid' connection |
||
| 436 | * |
||
| 437 | * @param object|array The Connection object (WordPress.com) or array (Jetpack) |
||
| 438 | * @return bool |
||
| 439 | */ |
||
| 440 | function is_invalid_linkedin_connection( $connection ) { |
||
| 441 | // LinkedIn API v1 included the profile link in the connection data. |
||
| 442 | $connection_meta = $this->get_connection_meta( $connection ); |
||
| 443 | return isset( $connection_meta['connection_data']['meta']['profile_url'] ); |
||
| 444 | } |
||
| 445 | |||
| 446 | /** |
||
| 447 | * Whether the Connection currently being connected |
||
| 448 | * |
||
| 449 | * @param object|array The Connection object (WordPress.com) or array (Jetpack) |
||
| 450 | * @return bool |
||
| 451 | */ |
||
| 452 | function is_connecting_connection( $connection ) { |
||
| 457 | |||
| 458 | /** |
||
| 459 | * AJAX Handler to run connection tests on all Connections |
||
| 460 | * @return void |
||
| 461 | */ |
||
| 462 | function test_publicize_conns() { |
||
| 465 | |||
| 466 | /** |
||
| 467 | * Run connection tests on all Connections |
||
| 468 | * |
||
| 469 | * @return array { |
||
| 470 | * Array of connection test results. |
||
| 471 | * |
||
| 472 | * @type string 'connectionID' Connection identifier string that is unique for each connection |
||
| 473 | * @type string 'serviceName' Slug of the connection's service (facebook, twitter, ...) |
||
| 474 | * @type bool 'connectionTestPassed' Whether the connection test was successful |
||
| 475 | * @type string 'connectionTestMessage' Test success or error message |
||
| 476 | * @type bool 'userCanRefresh' Whether the user can re-authenticate their connection to the service |
||
| 477 | * @type string 'refreshText' Message instructing user to re-authenticate their connection to the service |
||
| 478 | * @type string 'refreshURL' URL, which, when visited by the user, re-authenticates their connection to the service. |
||
| 479 | * @type string 'unique_id' ID string representing connection |
||
| 480 | * } |
||
| 481 | */ |
||
| 482 | function get_publicize_conns_test_results() { |
||
| 548 | |||
| 549 | /** |
||
| 550 | * Run the connection test for the Connection |
||
| 551 | * |
||
| 552 | * @param string $service_name 'facebook', 'twitter', etc. |
||
| 553 | * @param object|array The Connection object (WordPress.com) or array (Jetpack) |
||
| 554 | * @return WP_Error|true WP_Error on failure. True on success |
||
| 555 | */ |
||
| 556 | abstract function test_connection( $service_name, $connection ); |
||
| 557 | |||
| 558 | /** |
||
| 559 | * Retrieves current list of connections and applies filters. |
||
| 560 | * |
||
| 561 | * Retrieves current available connections and checks if the connections |
||
| 562 | * have already been used to share current post. Finally, the checkbox |
||
| 563 | * form UI fields are calculated. This function exposes connection form |
||
| 564 | * data directly as array so it can be retrieved for static HTML generation |
||
| 565 | * or JSON consumption. |
||
| 566 | * |
||
| 567 | * @since 6.7.0 |
||
| 568 | * |
||
| 569 | * @param integer $selected_post_id Optional. Post ID to query connection status for. |
||
| 570 | * |
||
| 571 | * @return array { |
||
| 572 | * Array of UI setup data for connection list form. |
||
| 573 | * |
||
| 574 | * @type string 'unique_id' ID string representing connection |
||
| 575 | * @type string 'service_name' Slug of the connection's service (facebook, twitter, ...) |
||
| 576 | * @type string 'service_label' Service Label (Facebook, Twitter, ...) |
||
| 577 | * @type string 'display_name' Connection's human-readable Username: "@jetpack" |
||
| 578 | * @type bool 'enabled' Default value for the connection (e.g., for a checkbox). |
||
| 579 | * @type bool 'done' Has this connection already been publicized to? |
||
| 580 | * @type bool 'toggleable' Is the user allowed to change the value for the connection? |
||
| 581 | * @type bool 'global' Is this connection a global one? |
||
| 582 | * } |
||
| 583 | */ |
||
| 584 | public function get_filtered_connection_data( $selected_post_id = null ) { |
||
| 719 | |||
| 720 | /** |
||
| 721 | * Checks if post has already been shared by Publicize in the past. |
||
| 722 | * |
||
| 723 | * @since 6.7.0 |
||
| 724 | * |
||
| 725 | * @param integer $post_id Optional. Post ID to query connection status for: will use current post if missing. |
||
| 726 | * |
||
| 727 | * @return bool True if post has already been shared by Publicize, false otherwise. |
||
| 728 | */ |
||
| 729 | abstract public function post_is_done_sharing( $post_id = null ); |
||
| 730 | |||
| 731 | /** |
||
| 732 | * Retrieves full list of available Publicize connection services. |
||
| 733 | * |
||
| 734 | * Retrieves current available publicize service connections |
||
| 735 | * with associated labels and URLs. |
||
| 736 | * |
||
| 737 | * @since 6.7.0 |
||
| 738 | * |
||
| 739 | * @return array { |
||
| 740 | * Array of UI service connection data for all services |
||
| 741 | * |
||
| 742 | * @type string 'name' Name of service. |
||
| 743 | * @type string 'label' Display label for service. |
||
| 744 | * @type string 'url' URL for adding connection to service. |
||
| 745 | * } |
||
| 746 | */ |
||
| 747 | function get_available_service_data() { |
||
| 761 | |||
| 762 | /* |
||
| 763 | * Site Data |
||
| 764 | */ |
||
| 765 | |||
| 766 | function user_id() { |
||
| 769 | |||
| 770 | function blog_id() { |
||
| 773 | |||
| 774 | /* |
||
| 775 | * Posts |
||
| 776 | */ |
||
| 777 | |||
| 778 | /** |
||
| 779 | * Checks old and new status to see if the post should be flagged as |
||
| 780 | * ready to Publicize. |
||
| 781 | * |
||
| 782 | * Attached to the `transition_post_status` filter. |
||
| 783 | * |
||
| 784 | * @param string $new_status |
||
| 785 | * @param string $old_status |
||
| 786 | * @param WP_Post $post |
||
| 787 | * @return void |
||
| 788 | */ |
||
| 789 | abstract function flag_post_for_publicize( $new_status, $old_status, $post ); |
||
| 790 | |||
| 791 | /** |
||
| 792 | * Ensures the Post internal post-type supports `publicize` |
||
| 793 | * |
||
| 794 | * This feature support flag is used by the REST API. |
||
| 795 | */ |
||
| 796 | function add_post_type_support() { |
||
| 799 | |||
| 800 | /** |
||
| 801 | * Register the Publicize Gutenberg extension |
||
| 802 | */ |
||
| 803 | function register_gutenberg_extension() { |
||
| 814 | |||
| 815 | /** |
||
| 816 | * Can the current user access Publicize Data. |
||
| 817 | * |
||
| 818 | * @param int $post_id. 0 for general access. Post_ID for specific access. |
||
| 819 | * @return bool |
||
| 820 | */ |
||
| 821 | function current_user_can_access_publicize_data( $post_id = 0 ) { |
||
| 839 | |||
| 840 | /** |
||
| 841 | * Auth callback for the protected ->POST_MESS post_meta |
||
| 842 | * |
||
| 843 | * @param bool $allowed |
||
| 844 | * @param string $meta_key |
||
| 845 | * @param int $object_id Post ID |
||
| 846 | * @return bool |
||
| 847 | */ |
||
| 848 | function message_meta_auth_callback( $allowed, $meta_key, $object_id ) { |
||
| 851 | |||
| 852 | /** |
||
| 853 | * Registers the ->POST_MESS post_meta for use in the REST API. |
||
| 854 | * |
||
| 855 | * Registers for each post type that with `publicize` feature support. |
||
| 856 | */ |
||
| 857 | function register_post_meta() { |
||
| 879 | |||
| 880 | /** |
||
| 881 | * Fires when a post is saved, checks conditions and saves state in postmeta so that it |
||
| 882 | * can be picked up later by @see ::publicize_post() on WordPress.com codebase. |
||
| 883 | * |
||
| 884 | * Attached to the `save_post` action. |
||
| 885 | * |
||
| 886 | * @param int $post_id |
||
| 887 | * @param WP_Post $post |
||
| 888 | * @return void |
||
| 889 | */ |
||
| 890 | function save_meta( $post_id, $post ) { |
||
| 1045 | |||
| 1046 | /** |
||
| 1047 | * Alters the "Post Published" message to include information about where the post |
||
| 1048 | * was Publicized to. |
||
| 1049 | * |
||
| 1050 | * Attached to the `post_updated_messages` filter |
||
| 1051 | * |
||
| 1052 | * @param string[] $messages |
||
| 1053 | * @return string[] |
||
| 1054 | */ |
||
| 1055 | public function update_published_message( $messages ) { |
||
| 1121 | |||
| 1122 | /** |
||
| 1123 | * Get the Connections the Post was just Publicized to. |
||
| 1124 | * |
||
| 1125 | * Only reliable just after the Post was published. |
||
| 1126 | * |
||
| 1127 | * @param int $post_id |
||
| 1128 | * @return string[] Array of Service display name => Connection display name |
||
| 1129 | */ |
||
| 1130 | function get_publicizing_services( $post_id ) { |
||
| 1152 | |||
| 1153 | /** |
||
| 1154 | * Is the post Publicize-able? |
||
| 1155 | * |
||
| 1156 | * Only valid prior to Publicizing a Post. |
||
| 1157 | * |
||
| 1158 | * @param WP_Post $post |
||
| 1159 | * @return bool |
||
| 1160 | */ |
||
| 1161 | function post_is_publicizeable( $post ) { |
||
| 1176 | |||
| 1177 | /** |
||
| 1178 | * Is a given post type Publicize-able? |
||
| 1179 | * |
||
| 1180 | * Not every CPT lends itself to Publicize-ation. Allow CPTs to register by adding their CPT via |
||
| 1181 | * the publicize_post_types array filter. |
||
| 1182 | * |
||
| 1183 | * @param string $post_type The post type to check. |
||
| 1184 | * @return bool True if the post type can be Publicized. |
||
| 1185 | */ |
||
| 1186 | function post_type_is_publicizeable( $post_type ) { |
||
| 1192 | |||
| 1193 | /** |
||
| 1194 | * Already-published posts should not be Publicized by default. This filter sets checked to |
||
| 1195 | * false if a post has already been published. |
||
| 1196 | * |
||
| 1197 | * Attached to the `publicize_checkbox_default` filter |
||
| 1198 | * |
||
| 1199 | * @param bool $checked |
||
| 1200 | * @param int $post_id |
||
| 1201 | * @param string $service_name 'facebook', 'twitter', etc |
||
| 1202 | * @param object|array The Connection object (WordPress.com) or array (Jetpack) |
||
| 1203 | * @return bool |
||
| 1204 | */ |
||
| 1205 | function publicize_checkbox_default( $checked, $post_id, $service_name, $connection ) { |
||
| 1212 | |||
| 1213 | /* |
||
| 1214 | * Util |
||
| 1215 | */ |
||
| 1216 | |||
| 1217 | /** |
||
| 1218 | * Converts a Publicize message template string into a sprintf format string |
||
| 1219 | * |
||
| 1220 | * @param string[] $args |
||
| 1221 | * 0 - The Publicize message template: 'Check out my post: %title% @ %url' |
||
| 1222 | * ... - The template tags 'title', 'url', etc. |
||
| 1223 | * @return string |
||
| 1224 | */ |
||
| 1225 | protected static function build_sprintf( $args ) { |
||
| 1238 | } |
||
| 1239 | |||
| 1254 |
Loading history...
In PHP, under loose comparison (like
==, or!=, orswitchconditions), values of different types might be equal.For
integervalues, zero is a special case, in particular the following results might be unexpected: