@@ -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 | |
@@ -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(); |
@@ -610,6 +615,11 @@ discard block |
||
| 610 | 615 | } |
| 611 | 616 | |
| 612 | 617 | // /sites/%s/posts/%d/delete -> $blog_id, $post_id |
| 618 | + |
|
| 619 | + /** |
|
| 620 | + * @param string $path |
|
| 621 | + * @param integer $post_id |
|
| 622 | + */ |
|
| 613 | 623 | function delete_post( $path, $blog_id, $post_id ) { |
| 614 | 624 | $post = get_post( $post_id ); |
| 615 | 625 | if ( !$post || is_wp_error( $post ) ) { |
@@ -645,6 +655,11 @@ discard block |
||
| 645 | 655 | } |
| 646 | 656 | |
| 647 | 657 | // /sites/%s/posts/%d/restore -> $blog_id, $post_id |
| 658 | + |
|
| 659 | + /** |
|
| 660 | + * @param string $path |
|
| 661 | + * @param integer $post_id |
|
| 662 | + */ |
|
| 648 | 663 | function restore_post( $path, $blog_id, $post_id ) { |
| 649 | 664 | $args = $this->query_args(); |
| 650 | 665 | $post = get_post( $post_id ); |
@@ -665,6 +680,10 @@ discard block |
||
| 665 | 680 | return $this->get_post_by( 'ID', $post->ID, $args['context'] ); |
| 666 | 681 | } |
| 667 | 682 | |
| 683 | + /** |
|
| 684 | + * @param boolean $delete_featured_image |
|
| 685 | + * @param string $featured_image |
|
| 686 | + */ |
|
| 668 | 687 | private function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) { |
| 669 | 688 | if ( $delete_featured_image ) { |
| 670 | 689 | 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 ); |
@@ -289,7 +289,7 @@ discard block |
||
| 289 | 289 | * Get the value of a setting. |
| 290 | 290 | * @param string $setting |
| 291 | 291 | * @access public |
| 292 | - * @return mixed |
|
| 292 | + * @return string |
|
| 293 | 293 | * @version 1.0 |
| 294 | 294 | */ |
| 295 | 295 | function get_cfg($setting) { |
@@ -358,7 +358,7 @@ discard block |
||
| 358 | 358 | |
| 359 | 359 | /** |
| 360 | 360 | * Adds a token to $this->tokens |
| 361 | - * @param mixed $type |
|
| 361 | + * @param integer $type |
|
| 362 | 362 | * @param string $data |
| 363 | 363 | * @param bool $do add a token even if preserve_css is off |
| 364 | 364 | * @access private |
@@ -1189,6 +1189,7 @@ discard block |
||
| 1189 | 1189 | * format("abc, def, ghi") => format("abc, def, ghi") |
| 1190 | 1190 | * |
| 1191 | 1191 | * @param string |
| 1192 | + * @param string $value |
|
| 1192 | 1193 | * @return array |
| 1193 | 1194 | */ |
| 1194 | 1195 | |
@@ -27,6 +27,9 @@ |
||
| 27 | 27 | } |
| 28 | 28 | |
| 29 | 29 | |
| 30 | + /** |
|
| 31 | + * @param string $key |
|
| 32 | + */ |
|
| 30 | 33 | protected function get_locale( $key ) { |
| 31 | 34 | if ( 'locale' == $key ) { |
| 32 | 35 | if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) { |
@@ -120,6 +120,9 @@ discard block |
||
| 120 | 120 | return $response; |
| 121 | 121 | } |
| 122 | 122 | |
| 123 | + /** |
|
| 124 | + * @param string $field |
|
| 125 | + */ |
|
| 123 | 126 | protected function get_sal_post_by( $field, $field_value, $context ) { |
| 124 | 127 | global $blog_id; |
| 125 | 128 | |
@@ -132,6 +135,9 @@ discard block |
||
| 132 | 135 | return $post; |
| 133 | 136 | } |
| 134 | 137 | |
| 138 | + /** |
|
| 139 | + * @param string $context |
|
| 140 | + */ |
|
| 135 | 141 | private function render_response_keys( $post, $context, $keys ) { |
| 136 | 142 | foreach ( $keys as $key ) { |
| 137 | 143 | switch ( $key ) { |
@@ -69,11 +69,17 @@ |
||
| 69 | 69 | return $args; |
| 70 | 70 | } |
| 71 | 71 | |
| 72 | + /** |
|
| 73 | + * @param string $taxonomy |
|
| 74 | + */ |
|
| 72 | 75 | function get_found( $taxonomy, $args ) { |
| 73 | 76 | unset( $args['offset'] ); |
| 74 | 77 | return wp_count_terms( $taxonomy, $args ); |
| 75 | 78 | } |
| 76 | 79 | |
| 80 | + /** |
|
| 81 | + * @param string $taxonomy |
|
| 82 | + */ |
|
| 77 | 83 | function get_formatted_terms( $taxonomy, $args ) { |
| 78 | 84 | $terms = get_terms( $taxonomy, $args ); |
| 79 | 85 | |
@@ -699,8 +699,7 @@ discard block |
||
| 699 | 699 | * Render the events |
| 700 | 700 | * |
| 701 | 701 | * @param string $url (default: '') |
| 702 | - * @param string $context (default: 'widget') or 'shortcode' |
|
| 703 | - * @return mixed bool|string false on failure, rendered HTML string on success. |
|
| 702 | + * @return false|string bool|string false on failure, rendered HTML string on success. |
|
| 704 | 703 | */ |
| 705 | 704 | public function render( $url = '', $args = array() ) { |
| 706 | 705 | |
@@ -857,8 +856,7 @@ discard block |
||
| 857 | 856 | * Wrapper function for iCalendarReader->render() |
| 858 | 857 | * |
| 859 | 858 | * @param string $url (default: '') |
| 860 | - * @param string $context (default: 'widget') or 'shortcode' |
|
| 861 | - * @return mixed bool|string false on failure, rendered HTML string on success. |
|
| 859 | + * @return false|string bool|string false on failure, rendered HTML string on success. |
|
| 862 | 860 | */ |
| 863 | 861 | function icalendar_render_events( $url = '', $args = array() ) { |
| 864 | 862 | $ical = new iCalendarReader(); |