@@ -214,6 +214,11 @@ discard block |
||
| 214 | 214 | |
| 215 | 215 | // /sites/%s/posts/new -> $blog_id |
| 216 | 216 | // /sites/%s/posts/%d -> $blog_id, $post_id |
| 217 | + |
|
| 218 | + /** |
|
| 219 | + * @param string $path |
|
| 220 | + * @param integer $post_id |
|
| 221 | + */ |
|
| 217 | 222 | function write_post( $path, $blog_id, $post_id ) { |
| 218 | 223 | global $wpdb; |
| 219 | 224 | |
@@ -890,6 +895,10 @@ discard block |
||
| 890 | 895 | } |
| 891 | 896 | |
| 892 | 897 | // /sites/%s/posts/%d/delete -> $blog_id, $post_id |
| 898 | + |
|
| 899 | + /** |
|
| 900 | + * @param string $path |
|
| 901 | + */ |
|
| 893 | 902 | function delete_post( $path, $blog_id, $post_id ) { |
| 894 | 903 | $post = get_post( $post_id ); |
| 895 | 904 | if ( !$post || is_wp_error( $post ) ) { |
@@ -929,6 +938,10 @@ discard block |
||
| 929 | 938 | } |
| 930 | 939 | |
| 931 | 940 | // /sites/%s/posts/%d/restore -> $blog_id, $post_id |
| 941 | + |
|
| 942 | + /** |
|
| 943 | + * @param string $path |
|
| 944 | + */ |
|
| 932 | 945 | function restore_post( $path, $blog_id, $post_id ) { |
| 933 | 946 | $args = $this->query_args(); |
| 934 | 947 | $post = get_post( $post_id ); |
@@ -949,6 +962,10 @@ discard block |
||
| 949 | 962 | return $this->get_post_by( 'ID', $post->ID, $args['context'] ); |
| 950 | 963 | } |
| 951 | 964 | |
| 965 | + /** |
|
| 966 | + * @param boolean $delete_featured_image |
|
| 967 | + * @param string $featured_image |
|
| 968 | + */ |
|
| 952 | 969 | protected function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) { |
| 953 | 970 | if ( $delete_featured_image ) { |
| 954 | 971 | 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 ); |
@@ -115,6 +115,11 @@ discard block |
||
| 115 | 115 | } |
| 116 | 116 | |
| 117 | 117 | // /sites/%s/taxonomies/%s/terms/new -> $blog_id, $taxonomy |
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * @param string $path |
|
| 121 | + * @param string $taxonomy |
|
| 122 | + */ |
|
| 118 | 123 | function new_term( $path, $blog_id, $taxonomy ) { |
| 119 | 124 | $args = $this->query_args(); |
| 120 | 125 | $input = $this->input(); |
@@ -160,6 +165,12 @@ discard block |
||
| 160 | 165 | } |
| 161 | 166 | |
| 162 | 167 | // /sites/%s/taxonomies/%s/terms/slug:%s -> $blog_id, $taxonomy, $slug |
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * @param string $path |
|
| 171 | + * @param string $slug |
|
| 172 | + * @param string $taxonomy |
|
| 173 | + */ |
|
| 163 | 174 | function update_term( $path, $blog_id, $slug, $taxonomy ) { |
| 164 | 175 | $tax = get_taxonomy( $taxonomy ); |
| 165 | 176 | if ( ! current_user_can( $tax->cap->edit_terms ) ) { |
@@ -208,6 +219,12 @@ discard block |
||
| 208 | 219 | } |
| 209 | 220 | |
| 210 | 221 | // /sites/%s/taxonomies/%s/terms/slug:%s/delete -> $blog_id, $taxonomy, $slug |
| 222 | + |
|
| 223 | + /** |
|
| 224 | + * @param string $path |
|
| 225 | + * @param string $slug |
|
| 226 | + * @param string $taxonomy |
|
| 227 | + */ |
|
| 211 | 228 | function delete_term( $path, $blog_id, $slug, $taxonomy ) { |
| 212 | 229 | $term = get_term_by( 'slug', $slug, $taxonomy ); |
| 213 | 230 | $tax = get_taxonomy( $taxonomy ); |
@@ -24,6 +24,9 @@ discard block |
||
| 24 | 24 | return isset( $args['arguments'] ) ? json_decode( $args['arguments'] ) : array(); |
| 25 | 25 | } |
| 26 | 26 | |
| 27 | + /** |
|
| 28 | + * @param double $gmt_time |
|
| 29 | + */ |
|
| 27 | 30 | protected function is_cron_locked( $gmt_time ) { |
| 28 | 31 | // The cron lock: a unix timestamp from when the cron was spawned. |
| 29 | 32 | $doing_cron_transient = $this->get_cron_lock(); |
@@ -33,6 +36,9 @@ discard block |
||
| 33 | 36 | return $doing_cron_transient; |
| 34 | 37 | } |
| 35 | 38 | |
| 39 | + /** |
|
| 40 | + * @param string $doing_wp_cron |
|
| 41 | + */ |
|
| 36 | 42 | protected function maybe_unlock_cron( $doing_wp_cron ) { |
| 37 | 43 | if ( $this->get_cron_lock() == $doing_wp_cron ) { |
| 38 | 44 | delete_transient( 'doing_cron' ); |
@@ -170,6 +170,9 @@ |
||
| 170 | 170 | } |
| 171 | 171 | |
| 172 | 172 | |
| 173 | + /** |
|
| 174 | + * @param string $plugin |
|
| 175 | + */ |
|
| 173 | 176 | protected function validate_plugin( $plugin ) { |
| 174 | 177 | if ( ! isset( $plugin) || empty( $plugin ) ) { |
| 175 | 178 | return new WP_Error( 'missing_plugin', __( 'You are required to specify a plugin to activate.', 'jetpack' ), 400 ); |
@@ -244,6 +244,9 @@ |
||
| 244 | 244 | } |
| 245 | 245 | } |
| 246 | 246 | |
| 247 | + /** |
|
| 248 | + * @param string $capability |
|
| 249 | + */ |
|
| 247 | 250 | protected function current_user_can( $capability, $plugin = null ) { |
| 248 | 251 | if ( $plugin ) { |
| 249 | 252 | return current_user_can( $capability, $plugin ); |
@@ -228,6 +228,9 @@ |
||
| 228 | 228 | ); |
| 229 | 229 | } |
| 230 | 230 | |
| 231 | + /** |
|
| 232 | + * @param Queue $queue |
|
| 233 | + */ |
|
| 231 | 234 | protected function get_buffer( $queue, $number_of_items ) { |
| 232 | 235 | $start = time(); |
| 233 | 236 | $max_duration = 5; // this will try to get the buffer |
@@ -129,6 +129,9 @@ discard block |
||
| 129 | 129 | return apply_filters( 'jp_carousel_load_for_images_linked_to_file', false ); |
| 130 | 130 | } |
| 131 | 131 | |
| 132 | + /** |
|
| 133 | + * @param string $version |
|
| 134 | + */ |
|
| 132 | 135 | function asset_version( $version ) { |
| 133 | 136 | /** |
| 134 | 137 | * Filter the version string used when enqueuing Carousel assets. |
@@ -511,6 +514,9 @@ discard block |
||
| 511 | 514 | return $attr; |
| 512 | 515 | } |
| 513 | 516 | |
| 517 | + /** |
|
| 518 | + * @param string $html |
|
| 519 | + */ |
|
| 514 | 520 | function add_data_to_container( $html ) { |
| 515 | 521 | global $post; |
| 516 | 522 | if ( |
@@ -757,6 +763,9 @@ discard block |
||
| 757 | 763 | return ( 1 == $value ) ? 1 : 0; |
| 758 | 764 | } |
| 759 | 765 | |
| 766 | + /** |
|
| 767 | + * @param string $name |
|
| 768 | + */ |
|
| 760 | 769 | function settings_checkbox( $name, $label_text, $extra_text = '', $default_to_checked = true ) { |
| 761 | 770 | if ( empty( $name ) ) { |
| 762 | 771 | return; |
@@ -772,6 +781,9 @@ discard block |
||
| 772 | 781 | echo '</fieldset>'; |
| 773 | 782 | } |
| 774 | 783 | |
| 784 | + /** |
|
| 785 | + * @param string $name |
|
| 786 | + */ |
|
| 775 | 787 | function settings_select( $name, $values, $extra_text = '' ) { |
| 776 | 788 | if ( empty( $name ) || ! is_array( $values ) || empty( $values ) ) { |
| 777 | 789 | return; |
@@ -302,6 +302,9 @@ discard block |
||
| 302 | 302 | return Grunion_Contact_Form::parse( $atts, do_blocks( $content ) ); |
| 303 | 303 | } |
| 304 | 304 | |
| 305 | + /** |
|
| 306 | + * @param string $type |
|
| 307 | + */ |
|
| 305 | 308 | public static function block_attributes_to_shortcode_attributes( $atts, $type ) { |
| 306 | 309 | $atts['type'] = $type; |
| 307 | 310 | if ( isset( $atts['className'] ) ) { |
@@ -1925,7 +1928,6 @@ discard block |
||
| 1925 | 1928 | * |
| 1926 | 1929 | * @see ::style() |
| 1927 | 1930 | * @internal |
| 1928 | - * @param bool $style |
|
| 1929 | 1931 | */ |
| 1930 | 1932 | static function _style_on() { |
| 1931 | 1933 | return self::style( true ); |
@@ -2096,6 +2098,7 @@ discard block |
||
| 2096 | 2098 | * |
| 2097 | 2099 | * @param int $feedback_id |
| 2098 | 2100 | * @param object Grunion_Contact_Form $form |
| 2101 | + * @param Grunion_Contact_Form $form |
|
| 2099 | 2102 | * |
| 2100 | 2103 | * @return string $message |
| 2101 | 2104 | */ |
@@ -2220,7 +2223,7 @@ discard block |
||
| 2220 | 2223 | * |
| 2221 | 2224 | * @param array $attributes Key => Value pairs as parsed by shortcode_parse_atts() |
| 2222 | 2225 | * @param string|null $content The shortcode's inner content: [contact-field]$content[/contact-field] |
| 2223 | - * @return HTML for the contact form field |
|
| 2226 | + * @return string for the contact form field |
|
| 2224 | 2227 | */ |
| 2225 | 2228 | static function parse_contact_field( $attributes, $content ) { |
| 2226 | 2229 | // Don't try to parse contact form fields if not inside a contact form |
@@ -3260,6 +3263,9 @@ discard block |
||
| 3260 | 3263 | |
| 3261 | 3264 | } |
| 3262 | 3265 | |
| 3266 | + /** |
|
| 3267 | + * @param string $type |
|
| 3268 | + */ |
|
| 3263 | 3269 | function render_input_field( $type, $id, $value, $class, $placeholder, $required ) { |
| 3264 | 3270 | return "<input |
| 3265 | 3271 | type='". esc_attr( $type ) ."' |
@@ -3271,24 +3277,40 @@ discard block |
||
| 3271 | 3277 | />\n"; |
| 3272 | 3278 | } |
| 3273 | 3279 | |
| 3280 | + /** |
|
| 3281 | + * @param string $class |
|
| 3282 | + * @param string $placeholder |
|
| 3283 | + */ |
|
| 3274 | 3284 | function render_email_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) { |
| 3275 | 3285 | $field = $this->render_label( 'email', $id, $label, $required, $required_field_text ); |
| 3276 | 3286 | $field .= $this->render_input_field( 'email', $id, $value, $class, $placeholder, $required ); |
| 3277 | 3287 | return $field; |
| 3278 | 3288 | } |
| 3279 | 3289 | |
| 3290 | + /** |
|
| 3291 | + * @param string $class |
|
| 3292 | + * @param string $placeholder |
|
| 3293 | + */ |
|
| 3280 | 3294 | function render_telephone_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) { |
| 3281 | 3295 | $field = $this->render_label( 'telephone', $id, $label, $required, $required_field_text ); |
| 3282 | 3296 | $field .= $this->render_input_field( 'tel', $id, $value, $class, $placeholder, $required ); |
| 3283 | 3297 | return $field; |
| 3284 | 3298 | } |
| 3285 | 3299 | |
| 3300 | + /** |
|
| 3301 | + * @param string $class |
|
| 3302 | + * @param string $placeholder |
|
| 3303 | + */ |
|
| 3286 | 3304 | function render_url_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) { |
| 3287 | 3305 | $field = $this->render_label( 'url', $id, $label, $required, $required_field_text ); |
| 3288 | 3306 | $field .= $this->render_input_field( 'url', $id, $value, $class, $placeholder, $required ); |
| 3289 | 3307 | return $field; |
| 3290 | 3308 | } |
| 3291 | 3309 | |
| 3310 | + /** |
|
| 3311 | + * @param string $class |
|
| 3312 | + * @param string $placeholder |
|
| 3313 | + */ |
|
| 3292 | 3314 | function render_textarea_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) { |
| 3293 | 3315 | $field = $this->render_label( 'textarea', 'contact-form-comment-' . $id, $label, $required, $required_field_text ); |
| 3294 | 3316 | $field .= "<textarea |
@@ -3303,6 +3325,9 @@ discard block |
||
| 3303 | 3325 | return $field; |
| 3304 | 3326 | } |
| 3305 | 3327 | |
| 3328 | + /** |
|
| 3329 | + * @param string $class |
|
| 3330 | + */ |
|
| 3306 | 3331 | function render_radio_field( $id, $label, $value, $class, $required, $required_field_text ) { |
| 3307 | 3332 | $field = $this->render_label( '', $id, $label, $required, $required_field_text ); |
| 3308 | 3333 | foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) { |
@@ -3324,6 +3349,9 @@ discard block |
||
| 3324 | 3349 | return $field; |
| 3325 | 3350 | } |
| 3326 | 3351 | |
| 3352 | + /** |
|
| 3353 | + * @param string $class |
|
| 3354 | + */ |
|
| 3327 | 3355 | function render_checkbox_field( $id, $label, $value, $class, $required, $required_field_text ) { |
| 3328 | 3356 | $field = "<label class='grunion-field-label checkbox" . ( $this->is_error() ? ' form-error' : '' ) . "'>"; |
| 3329 | 3357 | $field .= "\t\t<input type='checkbox' name='" . esc_attr( $id ) . "' value='" . esc_attr__( 'Yes', 'jetpack' ) . "' " . $class . checked( (bool) $value, true, false ) . ' ' . ( $required ? "required aria-required='true'" : '' ) . "/> \n"; |
@@ -3333,6 +3361,9 @@ discard block |
||
| 3333 | 3361 | return $field; |
| 3334 | 3362 | } |
| 3335 | 3363 | |
| 3364 | + /** |
|
| 3365 | + * @param string $class |
|
| 3366 | + */ |
|
| 3336 | 3367 | function render_checkbox_multiple_field( $id, $label, $value, $class, $required, $required_field_text ) { |
| 3337 | 3368 | $field = $this->render_label( '', $id, $label, $required, $required_field_text ); |
| 3338 | 3369 | foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) { |
@@ -3348,6 +3379,9 @@ discard block |
||
| 3348 | 3379 | return $field; |
| 3349 | 3380 | } |
| 3350 | 3381 | |
| 3382 | + /** |
|
| 3383 | + * @param string $class |
|
| 3384 | + */ |
|
| 3351 | 3385 | function render_select_field( $id, $label, $value, $class, $required, $required_field_text ) { |
| 3352 | 3386 | $field = $this->render_label( 'select', $id, $label, $required, $required_field_text ); |
| 3353 | 3387 | $field .= "\t<select name='" . esc_attr( $id ) . "' id='" . esc_attr( $id ) . "' " . $class . ( $required ? "required aria-required='true'" : '' ) . ">\n"; |
@@ -3365,6 +3399,10 @@ discard block |
||
| 3365 | 3399 | return $field; |
| 3366 | 3400 | } |
| 3367 | 3401 | |
| 3402 | + /** |
|
| 3403 | + * @param string $class |
|
| 3404 | + * @param string $placeholder |
|
| 3405 | + */ |
|
| 3368 | 3406 | function render_date_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) { |
| 3369 | 3407 | |
| 3370 | 3408 | $field = $this->render_label( 'date', $id, $label, $required, $required_field_text ); |
@@ -3395,6 +3433,10 @@ discard block |
||
| 3395 | 3433 | return $field; |
| 3396 | 3434 | } |
| 3397 | 3435 | |
| 3436 | + /** |
|
| 3437 | + * @param string $class |
|
| 3438 | + * @param string $placeholder |
|
| 3439 | + */ |
|
| 3398 | 3440 | function render_default_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder, $type ) { |
| 3399 | 3441 | $field = $this->render_label( $type, $id, $label, $required, $required_field_text ); |
| 3400 | 3442 | $field .= $this->render_input_field( 'text', $id, $value, $class, $placeholder, $required ); |