htmlburger / carbon-fields

core/Field/Checkbox_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 	/**
 	 * Return a differently formatted value for end-users
 	 *
-	 * @return mixed
+	 * @return boolean
 	 **/
 	public function get_formatted_value() {
 		return ( $this->get_value() === $this->option_value );

core/Container/Post_Meta_Container.php

Doc Comments +11 added lines, -10 removed lines

@@ -178,6 +178,7 @@ 
 	/**
 	 * Check container attachment rules against object id
 	 *
+	 * @param integer $object_id
 	 * @return bool
 	 **/
 	public function is_valid_attach_for_object( $object_id = null ) {
@@ -345,7 +346,7 @@ 
 	 * Show the container only on particular page referenced by it's path.
 	 *
 	 * @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 );
@@ -371,7 +372,7 @@ 
 	 * Show the container only on pages whose parent is referenced by $parent_page_path.
 	 *
 	 * @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 );
@@ -393,7 +394,7 @@ 
 	 * @see show_on_taxonomy_term()
 	 *
 	 * @param string $category_slug
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_category( $category_slug ) {
 		$this->settings['show_on']['category'] = $category_slug;
@@ -405,7 +406,7 @@ 
 	 * Show the container only on pages whose template has filename $template_path.
 	 *
 	 * @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
@@ -430,7 +431,7 @@ 
 	 * Hide the container from pages whose template has filename $template_path.
 	 *
 	 * @param string|array $template_path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function hide_on_template( $template_path ) {
 		if ( is_array( $template_path ) ) {
@@ -450,7 +451,7 @@ 
 	 * Levels start from 1 (top level post)
 	 *
 	 * @param int $level
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_level( $level ) {
 		if ( $level < 0 ) {
@@ -467,7 +468,7 @@ 
 	 *
 	 * @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 ) {
 		$term = get_term_by( 'slug', $term_slug, $taxonomy_slug );
@@ -484,7 +485,7 @@ 
 	 * Learn more about {@link http://codex.wordpress.org/Post_Formats Post Formats (Codex)}
 	 *
 	 * @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 ) {
 		if ( is_array( $post_format ) ) {
@@ -506,8 +507,8 @@ 
 	/**
 	 * Show the container only on posts from the specified type(s).
 	 *
-	 * @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 = (array) $post_types;

core/Container/Term_Meta_Container.php

Doc Comments +3 added lines, -2 removed lines

@@ -96,6 +96,7 @@ 
 	/**
 	 * Check container attachment rules against object id
 	 *
+	 * @param integer $object_id
 	 * @return bool
 	 **/
 	public function is_valid_attach_for_object( $object_id = null ) {
@@ -141,7 +142,7 @@ 
 	 * Show the container only on terms from the specified taxonomies.
 	 *
 	 * @param string|array $taxonomies
-	 * @return object $this
+	 * @return Term_Meta_Container $this
 	 **/
 	public function show_on_taxonomy( $taxonomies ) {
 		$taxonomies = (array) $taxonomies;
@@ -155,7 +156,7 @@ 
 	 * Show the container only on particular term level.
 	 *
 	 * @param int $term_level
-	 * @return object $this
+	 * @return Term_Meta_Container $this
 	 */
 	public function show_on_level( $term_level ) {
 		$this->settings['show_on_level'] = $term_level;

core/Container/User_Meta_Container.php

Doc Comments +5 added lines, -4 removed lines

@@ -45,7 +45,7 @@ 
 	/**
 	 * Checks whether the current request is valid
 	 *
-	 * @return bool
+	 * @return null|boolean
 	 **/
 	public function is_valid_save( $user_id = 0 ) {
 		if ( ! $this->verified_nonce_in_request() ) {
@@ -95,7 +95,8 @@ 
 	/**
 	 * Check container attachment rules against object id
 	 *
-	 * @return bool
+	 * @param integer $object_id
+	 * @return null|boolean
 	 **/
 	public function is_valid_attach_for_object( $object_id = null ) {
 		$valid = true;
@@ -250,7 +251,7 @@ 
 	 * Show the container only on users who have the $role role.
 	 *
 	 * @param string $role
-	 * @return object $this
+	 * @return User_Meta_Container $this
 	 **/
 	public function show_on_user_role( $role ) {
 		$this->settings['show_on']['role'] = (array) $role;
@@ -262,7 +263,7 @@ 
 	 * Show the container only for users who have either capabilities or roles setup
 	 *
 	 * @param array $show_for
-	 * @return object $this
+	 * @return User_Meta_Container $this
 	 **/
 	public function show_for( $show_for ) {
 		$this->settings['show_for'] = $this->parse_show_for( $show_for );