@@ -4,16 +4,29 @@ |
||
4 | 4 | require_once dirname( __FILE__ ) . '/class.json-api-site-base.php'; |
5 | 5 | |
6 | 6 | abstract class Abstract_Jetpack_Site extends SAL_Site { |
7 | + |
|
8 | + /** |
|
9 | + * @param string $name |
|
10 | + */ |
|
7 | 11 | abstract protected function get_constant( $name ); |
8 | 12 | |
13 | + /** |
|
14 | + * @param string $feature_name |
|
15 | + */ |
|
9 | 16 | abstract protected function current_theme_supports( $feature_name ); |
10 | 17 | |
18 | + /** |
|
19 | + * @param string $feature_name |
|
20 | + */ |
|
11 | 21 | abstract protected function get_theme_support( $feature_name ); |
12 | 22 | |
13 | 23 | abstract protected function get_jetpack_version(); |
14 | 24 | |
15 | 25 | abstract protected function get_updates(); |
16 | 26 | |
27 | + /** |
|
28 | + * @return string |
|
29 | + */ |
|
17 | 30 | abstract protected function main_network_site(); |
18 | 31 | |
19 | 32 | abstract protected function wp_version(); |
@@ -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 |
@@ -44,6 +44,11 @@ discard block |
||
44 | 44 | } |
45 | 45 | |
46 | 46 | // /sites/%s/taxonomies/%s/terms/new -> $blog_id, $taxonomy |
47 | + |
|
48 | + /** |
|
49 | + * @param string $path |
|
50 | + * @param string $taxonomy |
|
51 | + */ |
|
47 | 52 | function new_term( $path, $blog_id, $taxonomy ) { |
48 | 53 | $args = $this->query_args(); |
49 | 54 | $input = $this->input(); |
@@ -90,6 +95,12 @@ discard block |
||
90 | 95 | } |
91 | 96 | |
92 | 97 | // /sites/%s/taxonomies/%s/terms/slug:%s -> $blog_id, $taxonomy, $slug |
98 | + |
|
99 | + /** |
|
100 | + * @param string $path |
|
101 | + * @param integer $slug |
|
102 | + * @param string $taxonomy |
|
103 | + */ |
|
93 | 104 | function update_term( $path, $blog_id, $slug, $taxonomy ) { |
94 | 105 | $tax = get_taxonomy( $taxonomy ); |
95 | 106 | if ( ! current_user_can( $tax->cap->edit_terms ) ) { |
@@ -134,6 +145,12 @@ discard block |
||
134 | 145 | } |
135 | 146 | |
136 | 147 | // /sites/%s/taxonomies/%s/terms/slug:%s/delete -> $blog_id, $taxonomy, $slug |
148 | + |
|
149 | + /** |
|
150 | + * @param string $path |
|
151 | + * @param integer $slug |
|
152 | + * @param string $taxonomy |
|
153 | + */ |
|
137 | 154 | function delete_term( $path, $blog_id, $slug, $taxonomy ) { |
138 | 155 | $term = get_term_by( 'slug', $slug, $taxonomy ); |
139 | 156 | $tax = get_taxonomy( $taxonomy ); |
@@ -16,6 +16,9 @@ discard block |
||
16 | 16 | public $context; |
17 | 17 | public $site; |
18 | 18 | |
19 | + /** |
|
20 | + * @param Jetpack_Site $site |
|
21 | + */ |
|
19 | 22 | function __construct( $site, $post, $context ) { |
20 | 23 | $this->post = $post; |
21 | 24 | $this->context = $context; |
@@ -508,6 +511,9 @@ discard block |
||
508 | 511 | return $suggestions; |
509 | 512 | } |
510 | 513 | |
514 | + /** |
|
515 | + * @param string $context |
|
516 | + */ |
|
511 | 517 | private function format_taxonomy( $taxonomy, $taxonomy_type, $context ) { |
512 | 518 | // Permissions |
513 | 519 | switch ( $context ) { |
@@ -281,8 +281,6 @@ |
||
281 | 281 | /** |
282 | 282 | * Builds map display HTML code from the supplied latitude and longitude. |
283 | 283 | * |
284 | - * @param float $lat Map Latitude |
|
285 | - * @param float $lon Map Longitude |
|
286 | 284 | * |
287 | 285 | * @return string HTML of the map |
288 | 286 | */ |
@@ -62,7 +62,7 @@ |
||
62 | 62 | |
63 | 63 | /** |
64 | 64 | * Constructor |
65 | - * @param array $css contains the class csstidy |
|
65 | + * @param csstidy $css contains the class csstidy |
|
66 | 66 | * @access private |
67 | 67 | * @version 1.0 |
68 | 68 | */ |
@@ -85,7 +85,7 @@ |
||
85 | 85 | * |
86 | 86 | * @param string $cron_name |
87 | 87 | * |
88 | - * @return bool |
|
88 | + * @return false|null |
|
89 | 89 | */ |
90 | 90 | public function activate_cron( $cron_name ) { |
91 | 91 |
@@ -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(); |
@@ -107,7 +107,6 @@ |
||
107 | 107 | /** |
108 | 108 | * Record an event in Tracks - this is the preferred way to record events from PHP. |
109 | 109 | * |
110 | - * @param mixed $identity username, user_id, or WP_user object |
|
111 | 110 | * @param string $event_name The name of the event |
112 | 111 | * @param array $properties Custom properties to send with the event |
113 | 112 | * @param int $event_timestamp_millis The time in millis since 1970-01-01 00:00:00 when the event occurred |