htmlburger / carbon-fields

core/Container/Post_Meta_Container.php

Doc Comments +10 added lines, -10 removed lines

@@ -267,7 +267,7 @@ 
 	 *
 	 * @deprecated
 	 * @param int|string $page page ID or page path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 */
 	public function show_on_page( $page ) {
 		$page_id = absint( $page );
@@ -289,7 +289,7 @@ 
 	 *
 	 * @deprecated
 	 * @param string $parent_page_path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 */
 	public function show_on_page_children( $parent_page_path ) {
 		$page = get_page_by_path( $parent_page_path );
@@ -303,7 +303,7 @@ 
 	 *
 	 * @deprecated
 	 * @param string|array $template_path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 */
 	public function show_on_template( $template_path ) {
 		// Backwards compatibility where only pages support templates
@@ -321,7 +321,7 @@ 
 	 *
 	 * @deprecated
 	 * @param string|array $template_path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 */
 	public function hide_on_template( $template_path ) {
 		$template_paths = is_array( $template_path ) ? $template_path : array( $template_path );
@@ -335,7 +335,7 @@ 
 	 *
 	 * @deprecated
 	 * @param int $level
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 */
 	public function show_on_level( $level ) {
 		$this->where( 'post_level', '=', intval( $level ) );
@@ -348,7 +348,7 @@ 
 	 *
 	 * @deprecated
 	 * @param string|array $post_format Name of the format as listed on Codex
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 */
 	public function show_on_post_format( $post_format ) {
 		$post_formats = is_array( $post_format ) ? $post_format : array( $post_format );
@@ -360,8 +360,8 @@ 
 	 * Show the container only on posts from the specified type(s).
 	 *
 	 * @deprecated
-	 * @param string|array $post_types
-	 * @return object $this
+	 * @param string $post_types
+	 * @return Post_Meta_Container $this
 	 */
 	public function show_on_post_type( $post_types ) {
 		$post_types = is_array( $post_types ) ? $post_types : array( $post_types );
@@ -376,7 +376,7 @@ 
 	 *
 	 * @deprecated
 	 * @param string $category_slug
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 */
 	public function show_on_category( $category_slug ) {
 		$this->where( 'post_term', '=', array(
@@ -393,7 +393,7 @@ 
 	 * @deprecated
 	 * @param string $taxonomy_slug
 	 * @param string $term_slug
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 */
 	public function show_on_taxonomy_term( $term_slug, $taxonomy_slug ) {
 		$this->where( 'post_term', '=', array(

core/Provider/Container_Condition_Provider.php

Doc Comments +7 added lines, -7 removed lines

@@ -249,7 +249,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_post_meta_container_static_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -263,7 +263,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_post_meta_container_dynamic_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -277,7 +277,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_term_meta_container_static_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -291,7 +291,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_term_meta_container_dynamic_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -305,7 +305,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_user_meta_container_static_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -319,7 +319,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_user_meta_container_dynamic_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -333,7 +333,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_theme_options_container_static_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(

core/Field/Checkbox_Field.php

Doc Comments +2 added lines, -1 removed lines

@@ -53,6 +53,7 @@ 
 
 	/**
 	 * {@inheritDoc}
+	 * @param string $value
 	 */
 	public function set_value( $value ) {
 		if ( is_bool( $value ) ) {
@@ -64,7 +65,7 @@ 
 	/**
 	 * Return a differently formatted value for end-users
 	 *
-	 * @return mixed
+	 * @return boolean
 	 */
 	public function get_formatted_value() {
 		return ( $this->get_value() === $this->get_option_value() );

core/Helper/Helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -401,7 +401,7 @@
 	 * Modified version of https://wpscholar.com/blog/get-attachment-id-from-wp-image-url/
 	 *
 	 * @param  string  $url
-	 * @return integet
+	 * @return integer
 	 */
 	public static function get_attachment_id( $url ) {
 		$dir = wp_upload_dir();

core/Field/Predefined_Options_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -92,7 +92,7 @@
 	/**
 	 * Retrieve the current options.
 	 *
-	 * @return array
+	 * @return callable
 	 */
 	public function get_options() {
 		return $this->load_options();