@@ -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 ) { |
@@ -35,6 +35,12 @@ discard block |
||
35 | 35 | |
36 | 36 | // /sites/%s/posts/%d/replies/new -> $blog_id, $post_id |
37 | 37 | // /sites/%s/comments/%d/replies/new -> $blog_id, $comment_id |
38 | + |
|
39 | + /** |
|
40 | + * @param string $path |
|
41 | + * @param integer $post_id |
|
42 | + * @param integer $comment_parent_id |
|
43 | + */ |
|
38 | 44 | function new_comment( $path, $blog_id, $post_id, $comment_parent_id ) { |
39 | 45 | if ( !$post_id ) { |
40 | 46 | $comment_parent = get_comment( $comment_parent_id ); |
@@ -146,6 +152,11 @@ discard block |
||
146 | 152 | } |
147 | 153 | |
148 | 154 | // /sites/%s/comments/%d -> $blog_id, $comment_id |
155 | + |
|
156 | + /** |
|
157 | + * @param string $path |
|
158 | + * @param integer $comment_id |
|
159 | + */ |
|
149 | 160 | function update_comment( $path, $blog_id, $comment_id ) { |
150 | 161 | $comment = get_comment( $comment_id ); |
151 | 162 | if ( !$comment || is_wp_error( $comment ) ) { |
@@ -235,6 +246,11 @@ discard block |
||
235 | 246 | } |
236 | 247 | |
237 | 248 | // /sites/%s/comments/%d/delete -> $blog_id, $comment_id |
249 | + |
|
250 | + /** |
|
251 | + * @param string $path |
|
252 | + * @param integer $comment_id |
|
253 | + */ |
|
238 | 254 | function delete_comment( $path, $blog_id, $comment_id ) { |
239 | 255 | $comment = get_comment( $comment_id ); |
240 | 256 | if ( !$comment || is_wp_error( $comment ) ) { |
@@ -28,6 +28,11 @@ discard block |
||
28 | 28 | |
29 | 29 | // /sites/%s/posts/new -> $blog_id |
30 | 30 | // /sites/%s/posts/%d -> $blog_id, $post_id |
31 | + |
|
32 | + /** |
|
33 | + * @param string $path |
|
34 | + * @param integer $post_id |
|
35 | + */ |
|
31 | 36 | function write_post( $path, $blog_id, $post_id ) { |
32 | 37 | $new = $this->api->ends_with( $path, '/new' ); |
33 | 38 | $args = $this->query_args(); |
@@ -621,6 +626,11 @@ discard block |
||
621 | 626 | } |
622 | 627 | |
623 | 628 | // /sites/%s/posts/%d/delete -> $blog_id, $post_id |
629 | + |
|
630 | + /** |
|
631 | + * @param string $path |
|
632 | + * @param integer $post_id |
|
633 | + */ |
|
624 | 634 | function delete_post( $path, $blog_id, $post_id ) { |
625 | 635 | $post = get_post( $post_id ); |
626 | 636 | if ( !$post || is_wp_error( $post ) ) { |
@@ -656,6 +666,11 @@ discard block |
||
656 | 666 | } |
657 | 667 | |
658 | 668 | // /sites/%s/posts/%d/restore -> $blog_id, $post_id |
669 | + |
|
670 | + /** |
|
671 | + * @param string $path |
|
672 | + * @param integer $post_id |
|
673 | + */ |
|
659 | 674 | function restore_post( $path, $blog_id, $post_id ) { |
660 | 675 | $args = $this->query_args(); |
661 | 676 | $post = get_post( $post_id ); |
@@ -676,6 +691,10 @@ discard block |
||
676 | 691 | return $this->get_post_by( 'ID', $post->ID, $args['context'] ); |
677 | 692 | } |
678 | 693 | |
694 | + /** |
|
695 | + * @param boolean $delete_featured_image |
|
696 | + * @param string $featured_image |
|
697 | + */ |
|
679 | 698 | protected function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) { |
680 | 699 | if ( $delete_featured_image ) { |
681 | 700 | delete_post_thumbnail( $post_id ); |
@@ -26,6 +26,11 @@ discard block |
||
26 | 26 | } |
27 | 27 | |
28 | 28 | // /sites/%s/tags|categories/new -> $blog_id |
29 | + |
|
30 | + /** |
|
31 | + * @param string $path |
|
32 | + * @param string $taxonomy_type |
|
33 | + */ |
|
29 | 34 | function new_taxonomy( $path, $blog_id, $taxonomy_type ) { |
30 | 35 | $args = $this->query_args(); |
31 | 36 | $input = $this->input(); |
@@ -77,6 +82,12 @@ discard block |
||
77 | 82 | } |
78 | 83 | |
79 | 84 | // /sites/%s/tags|categories/slug:%s -> $blog_id, $taxonomy_id |
85 | + |
|
86 | + /** |
|
87 | + * @param string $path |
|
88 | + * @param integer $object_id |
|
89 | + * @param string $taxonomy_type |
|
90 | + */ |
|
80 | 91 | function update_taxonomy( $path, $blog_id, $object_id, $taxonomy_type ) { |
81 | 92 | $taxonomy = get_term_by( 'slug', $object_id, $taxonomy_type ); |
82 | 93 | $tax = get_taxonomy( $taxonomy_type ); |
@@ -122,6 +133,12 @@ discard block |
||
122 | 133 | } |
123 | 134 | |
124 | 135 | // /sites/%s/tags|categories/%s/delete -> $blog_id, $taxonomy_id |
136 | + |
|
137 | + /** |
|
138 | + * @param string $path |
|
139 | + * @param integer $object_id |
|
140 | + * @param string $taxonomy_type |
|
141 | + */ |
|
125 | 142 | function delete_taxonomy( $path, $blog_id, $object_id, $taxonomy_type ) { |
126 | 143 | $taxonomy = get_term_by( 'slug', $object_id, $taxonomy_type ); |
127 | 144 | $tax = get_taxonomy( $taxonomy_type ); |
@@ -30,7 +30,7 @@ discard block |
||
30 | 30 | * Make deprecated properties checkable for backwards compatibility. |
31 | 31 | * |
32 | 32 | * @param string $name Property to check if set. |
33 | - * @return bool Whether the property is set. |
|
33 | + * @return boolean|null Whether the property is set. |
|
34 | 34 | */ |
35 | 35 | public function __isset( $name ) { |
36 | 36 | if ( 'rtl' == $name ) { |
@@ -42,7 +42,7 @@ discard block |
||
42 | 42 | * Make deprecated properties readable for backwards compatibility. |
43 | 43 | * |
44 | 44 | * @param string $name Property to get. |
45 | - * @return mixed Property. |
|
45 | + * @return boolean|null Property. |
|
46 | 46 | */ |
47 | 47 | public function __get( $name ) { |
48 | 48 | if ( 'rtl' == $name ) { |
@@ -71,6 +71,9 @@ discard block |
||
71 | 71 | return $numbers; |
72 | 72 | } |
73 | 73 | |
74 | + /** |
|
75 | + * @param integer $number |
|
76 | + */ |
|
74 | 77 | public function index_for_number( $number ) { |
75 | 78 | if ( ! isset( $this->_index_for_number ) ) { |
76 | 79 | $gettext = new Gettext_Translations; |
@@ -2093,6 +2096,9 @@ discard block |
||
2093 | 2096 | return isset( $instance->locales[ $slug ] )? $instance->locales[ $slug ] : null; |
2094 | 2097 | } |
2095 | 2098 | |
2099 | + /** |
|
2100 | + * @param string $field_name |
|
2101 | + */ |
|
2096 | 2102 | public static function by_field( $field_name, $field_value ) { |
2097 | 2103 | $instance = GP_Locales::instance(); |
2098 | 2104 | $result = false; |
@@ -6,6 +6,9 @@ discard block |
||
6 | 6 | /* |
7 | 7 | * A convienence function to display the HTML for an AtD option |
8 | 8 | */ |
9 | +/** |
|
10 | + * @param string $name |
|
11 | + */ |
|
9 | 12 | function AtD_print_option( $name, $value, $options ) { |
10 | 13 | // Attribute-safe version of $name |
11 | 14 | $attr_name = sanitize_title($name); // Using sanitize_title since there's no comparable function for attributes |
@@ -99,6 +102,9 @@ discard block |
||
99 | 102 | /* |
100 | 103 | * Returns an array of AtD user options specified by $name |
101 | 104 | */ |
105 | +/** |
|
106 | + * @param string $name |
|
107 | + */ |
|
102 | 108 | function AtD_get_options( $user_id, $name ) { |
103 | 109 | $options_raw = AtD_get_setting( $user_id, $name, 'single' ); |
104 | 110 | |
@@ -115,6 +121,9 @@ discard block |
||
115 | 121 | /* |
116 | 122 | * Saves set of user options specified by $name from POST data |
117 | 123 | */ |
124 | +/** |
|
125 | + * @param string $name |
|
126 | + */ |
|
118 | 127 | function AtD_update_options( $user_id, $name ) { |
119 | 128 | /* We should probably run $_POST[name] through an esc_*() function... */ |
120 | 129 | if ( isset( $_POST[$name] ) && is_array( $_POST[$name] ) ) { |
@@ -6,6 +6,7 @@ |
||
6 | 6 | /** |
7 | 7 | * Returns array with headers in $response[0] and body in $response[1] |
8 | 8 | * Based on a function from Akismet |
9 | + * @param string $request |
|
9 | 10 | */ |
10 | 11 | function AtD_http_post( $request, $host, $path, $port = 80 ) { |
11 | 12 | $http_args = array( |