@@ -183,6 +183,9 @@ |
||
| 183 | 183 | } |
| 184 | 184 | } |
| 185 | 185 | |
| 186 | +/** |
|
| 187 | + * @param string $text |
|
| 188 | + */ |
|
| 186 | 189 | function jetpack_sha1_base64( $text ) { |
| 187 | 190 | return base64_encode( sha1( $text, true ) ); |
| 188 | 191 | } |
@@ -65,7 +65,6 @@ discard block |
||
| 65 | 65 | |
| 66 | 66 | /** |
| 67 | 67 | * @param string $file __FILE__ |
| 68 | - * @param string $option, Option name to sync |
|
| 69 | 68 | * @param string $option ... |
| 70 | 69 | */ |
| 71 | 70 | static function sync_options( $file, $option /*, $option, ... */ ) { |
@@ -76,8 +75,6 @@ discard block |
||
| 76 | 75 | } |
| 77 | 76 | /** |
| 78 | 77 | * @param string $file __FILE__ |
| 79 | - * @param string $option, Option name to sync |
|
| 80 | - * @param string $option ... |
|
| 81 | 78 | */ |
| 82 | 79 | static function sync_constant( $file, $constant ) { |
| 83 | 80 | if ( is_network_admin() ) return; |
@@ -353,6 +350,9 @@ discard block |
||
| 353 | 350 | $this->transition_post_status_action( 'delete', $post->post_status, $post ); |
| 354 | 351 | } |
| 355 | 352 | |
| 353 | + /** |
|
| 354 | + * @param string $new_status |
|
| 355 | + */ |
|
| 356 | 356 | function transition_post_status_action( $new_status, $old_status, $post ) { |
| 357 | 357 | $sync = $this->get_post_sync_operation( $new_status, $old_status, $post, $this->sync_conditions['posts'] ); |
| 358 | 358 | if ( !$sync ) { |
@@ -737,6 +737,11 @@ discard block |
||
| 737 | 737 | /* Options Sync */ |
| 738 | 738 | |
| 739 | 739 | /* Ah... so much simpler than Posts and Comments :) */ |
| 740 | + |
|
| 741 | + /** |
|
| 742 | + * @param string $file |
|
| 743 | + * @param string $option |
|
| 744 | + */ |
|
| 740 | 745 | function options( $file, $option /*, $option, ... */ ) { |
| 741 | 746 | $options = func_get_args(); |
| 742 | 747 | $file = array_shift( $options ); |
@@ -844,6 +849,7 @@ discard block |
||
| 844 | 849 | |
| 845 | 850 | /** |
| 846 | 851 | * Returns default values of Constants |
| 852 | + * @param string $constant |
|
| 847 | 853 | */ |
| 848 | 854 | function default_constant( $constant ) { |
| 849 | 855 | switch( $constant ) { |
@@ -1352,6 +1352,7 @@ discard block |
||
| 1352 | 1352 | * timezone set in the options table for the blog or the GMT offset. |
| 1353 | 1353 | * |
| 1354 | 1354 | * @param datetime string |
| 1355 | + * @param string $date_string |
|
| 1355 | 1356 | * |
| 1356 | 1357 | * @return array( $local_time_string, $gmt_time_string ) |
| 1357 | 1358 | */ |
@@ -1466,6 +1467,10 @@ discard block |
||
| 1466 | 1467 | do_action( 'restapi_theme_init' ); |
| 1467 | 1468 | } |
| 1468 | 1469 | |
| 1470 | + /** |
|
| 1471 | + * @param string $from_hook |
|
| 1472 | + * @param string $to_hook |
|
| 1473 | + */ |
|
| 1469 | 1474 | function copy_hooks( $from_hook, $to_hook, $base_paths ) { |
| 1470 | 1475 | global $wp_filter; |
| 1471 | 1476 | foreach ( $wp_filter as $hook => $actions ) { |
@@ -1520,7 +1525,7 @@ discard block |
||
| 1520 | 1525 | * |
| 1521 | 1526 | * This method is used in get_link() to construct meta links for API responses. |
| 1522 | 1527 | * |
| 1523 | - * @param $path string The current endpoint path, relative to the version |
|
| 1528 | + * @param string $path string The current endpoint path, relative to the version |
|
| 1524 | 1529 | * @param $method string Request method used to access the endpoint path |
| 1525 | 1530 | * @return string The current version, or otherwise the maximum version available |
| 1526 | 1531 | */ |
@@ -1648,7 +1653,6 @@ discard block |
||
| 1648 | 1653 | * |
| 1649 | 1654 | * Used to construct meta links in API responses |
| 1650 | 1655 | * |
| 1651 | - * @param mixed $args Optional arguments to be appended to URL |
|
| 1652 | 1656 | * @return string Endpoint URL |
| 1653 | 1657 | **/ |
| 1654 | 1658 | function get_link() { |
@@ -29,6 +29,9 @@ discard block |
||
| 29 | 29 | public $did_output = false; |
| 30 | 30 | |
| 31 | 31 | /** |
| 32 | + * @param string $method |
|
| 33 | + * @param string $url |
|
| 34 | + * @param string $post_body |
|
| 32 | 35 | * @return WPCOM_JSON_API instance |
| 33 | 36 | */ |
| 34 | 37 | static function init( $method = null, $url = null, $post_body = null ) { |
@@ -342,6 +345,9 @@ discard block |
||
| 342 | 345 | return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces ); |
| 343 | 346 | } |
| 344 | 347 | |
| 348 | + /** |
|
| 349 | + * @param integer $status_code |
|
| 350 | + */ |
|
| 345 | 351 | function output_early( $status_code, $response = null, $content_type = 'application/json' ) { |
| 346 | 352 | $exit = $this->exit; |
| 347 | 353 | $this->exit = false; |
@@ -536,6 +542,9 @@ discard block |
||
| 536 | 542 | return json_encode( $data ); |
| 537 | 543 | } |
| 538 | 544 | |
| 545 | + /** |
|
| 546 | + * @param string $needle |
|
| 547 | + */ |
|
| 539 | 548 | function ends_with( $haystack, $needle ) { |
| 540 | 549 | return $needle === substr( $haystack, -strlen( $needle ) ); |
| 541 | 550 | } |
@@ -563,6 +572,10 @@ discard block |
||
| 563 | 572 | } |
| 564 | 573 | |
| 565 | 574 | // Returns true if the specified blog ID is a restricted blog |
| 575 | + |
|
| 576 | + /** |
|
| 577 | + * @param integer $blog_id |
|
| 578 | + */ |
|
| 566 | 579 | function is_restricted_blog( $blog_id ) { |
| 567 | 580 | /** |
| 568 | 581 | * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs. |
@@ -626,6 +639,7 @@ discard block |
||
| 626 | 639 | * The result is always output, never returned. |
| 627 | 640 | * |
| 628 | 641 | * @param string|null $error_code. Call with string to start the trapping. Call with null to stop. |
| 642 | + * @param string $error_code |
|
| 629 | 643 | */ |
| 630 | 644 | function trap_wp_die( $error_code = null ) { |
| 631 | 645 | // Stop trapping |
@@ -7,6 +7,7 @@ |
||
| 7 | 7 | * |
| 8 | 8 | * @param string $image_url URL to the publicly accessible image you want to manipulate |
| 9 | 9 | * @param array|string $args An array of arguments, i.e. array( 'w' => '300', 'resize' => array( 123, 456 ) ), or in string form (w=123&h=456) |
| 10 | + * @param string $scheme |
|
| 10 | 11 | * @return string The raw final URL. You should run this through esc_url() before displaying it. |
| 11 | 12 | */ |
| 12 | 13 | function jetpack_photon_url( $image_url, $args = array(), $scheme = null ) { |
@@ -328,6 +328,9 @@ |
||
| 328 | 328 | return build_query( array( 'value' => urlencode($post[$column]), 'id' => $post['ID'] ) ); |
| 329 | 329 | } |
| 330 | 330 | |
| 331 | + /** |
|
| 332 | + * @param string $column |
|
| 333 | + */ |
|
| 331 | 334 | function _build_date_range_query( $column, $range, $where ) { |
| 332 | 335 | global $wpdb; |
| 333 | 336 | |
@@ -297,6 +297,7 @@ discard block |
||
| 297 | 297 | * @param array $items item tree |
| 298 | 298 | * @param array &$items_list output flat list of items |
| 299 | 299 | * @param int &$counter for creating temporary IDs |
| 300 | + * @param integer $counter |
|
| 300 | 301 | */ |
| 301 | 302 | protected function untreeify_items( $items, &$items_list, &$counter ) { |
| 302 | 303 | foreach( $items as $index => $item ) { |
@@ -546,6 +547,7 @@ discard block |
||
| 546 | 547 | * This function will create items that have a 'tmp_id' set, and |
| 547 | 548 | * update any items with a 'tmp_parent' to use the |
| 548 | 549 | * newly created item as a parent. |
| 550 | + * @param integer $menu_id |
|
| 549 | 551 | */ |
| 550 | 552 | function create_new_items( $data, $menu_id ) { |
| 551 | 553 | $tmp_to_actual_ids = array(); |
@@ -571,6 +573,7 @@ discard block |
||
| 571 | 573 | /** |
| 572 | 574 | * remove any existing menu items not present in the supplied array. |
| 573 | 575 | * returns wp_error if an item cannot be deleted. |
| 576 | + * @param integer $menu_id |
|
| 574 | 577 | */ |
| 575 | 578 | function delete_items_not_present( $menu_id, $menu_items ) { |
| 576 | 579 | |
@@ -45,6 +45,10 @@ |
||
| 45 | 45 | } |
| 46 | 46 | |
| 47 | 47 | class WPCOM_JSON_API_Get_Connection_Endpoint extends WPCOM_JSON_API_Endpoint { |
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * @param integer $connection_id |
|
| 51 | + */ |
|
| 48 | 52 | function get_connection_by_id( $connection_id ) { |
| 49 | 53 | $publicize = new Publicize(); |
| 50 | 54 | |
@@ -67,6 +67,7 @@ |
||
| 67 | 67 | /** |
| 68 | 68 | * Updates user data |
| 69 | 69 | * |
| 70 | + * @param integer $user_id |
|
| 70 | 71 | * @return (array) |
| 71 | 72 | */ |
| 72 | 73 | public function update_user( $user_id ) { |