@@ -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( |
@@ -92,6 +92,9 @@ discard block |
||
| 92 | 92 | exit; |
| 93 | 93 | } |
| 94 | 94 | |
| 95 | + /** |
|
| 96 | + * @param string $version |
|
| 97 | + */ |
|
| 95 | 98 | function asset_version( $version ) { |
| 96 | 99 | /** |
| 97 | 100 | * Filter the version string used when enqueuing Carousel assets. |
@@ -542,6 +545,9 @@ discard block |
||
| 542 | 545 | return ( 1 == $value ) ? 1 : 0; |
| 543 | 546 | } |
| 544 | 547 | |
| 548 | + /** |
|
| 549 | + * @param string $name |
|
| 550 | + */ |
|
| 545 | 551 | function settings_checkbox($name, $label_text, $extra_text = '', $default_to_checked = true) { |
| 546 | 552 | if ( empty( $name ) ) |
| 547 | 553 | return; |
@@ -555,6 +561,9 @@ discard block |
||
| 555 | 561 | echo '</fieldset>'; |
| 556 | 562 | } |
| 557 | 563 | |
| 564 | + /** |
|
| 565 | + * @param string $name |
|
| 566 | + */ |
|
| 558 | 567 | function settings_select($name, $values, $extra_text = '') { |
| 559 | 568 | if ( empty( $name ) || ! is_array( $values ) || empty( $values ) ) |
| 560 | 569 | return; |
@@ -1020,7 +1020,6 @@ discard block |
||
| 1020 | 1020 | * Turn on printing of grunion.css stylesheet |
| 1021 | 1021 | * @see ::style() |
| 1022 | 1022 | * @internal |
| 1023 | - * @param bool $style |
|
| 1024 | 1023 | */ |
| 1025 | 1024 | static function _style_on() { |
| 1026 | 1025 | return self::style( true ); |
@@ -1157,6 +1156,7 @@ discard block |
||
| 1157 | 1156 | * |
| 1158 | 1157 | * @param int $feedback_id |
| 1159 | 1158 | * @param object Grunion_Contact_Form $form |
| 1159 | + * @param Grunion_Contact_Form $form |
|
| 1160 | 1160 | * |
| 1161 | 1161 | * @return string $message |
| 1162 | 1162 | */ |
@@ -1252,7 +1252,7 @@ discard block |
||
| 1252 | 1252 | * |
| 1253 | 1253 | * @param array $attributes Key => Value pairs as parsed by shortcode_parse_atts() |
| 1254 | 1254 | * @param string|null $content The shortcode's inner content: [contact-field]$content[/contact-field] |
| 1255 | - * @return HTML for the contact form field |
|
| 1255 | + * @return string for the contact form field |
|
| 1256 | 1256 | */ |
| 1257 | 1257 | static function parse_contact_field( $attributes, $content ) { |
| 1258 | 1258 | // Don't try to parse contact form fields if not inside a contact form |
@@ -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 | |
@@ -38,6 +38,9 @@ |
||
| 38 | 38 | /* ctype_alpha Check for alphabetic character(s) */ |
| 39 | 39 | if (!function_exists('ctype_alpha')) { |
| 40 | 40 | |
| 41 | + /** |
|
| 42 | + * @param string $text |
|
| 43 | + */ |
|
| 41 | 44 | function ctype_alpha($text) { |
| 42 | 45 | return preg_match("/[a-zA-Z]/", $text); |
| 43 | 46 | } |