Documentation

On this page

  • Category: Getting Started
  • Written: December 12, 2011
  • Updated: October 29, 2012

« Back to docs

Code Examples

Display a field

<p><?php the_field('field_name'); ?></p>

Retrieving a field as a variable

<?php
 
$variable = get_field('field_name');
 
// do something with $variable
 
?>

Using conditional statements

get_field returns false if (value == “” || value == null || value == false)

<?php
 
if(get_field('field_name'))
{
	echo '<p>' . get_field('field_name') . '</p>';
}
 
?>

Working with Array values

checkbox, select, relationship, repeater

<?php
 
$values = get_field('field_name');
if($values)
{
	echo '<ul>';
 
	foreach($values as $value)
	{
		echo '<li>' . $value . '</li>';
	}
 
	echo '</ul>';
}
 
// always good to see exactly what you are working with
var_dump($values);
 
?>

Working with Images – URL

<img src="<?php the_field('image_test'); ?>" alt="" />

Working with Images – ID

By using the ID, you can retrieve any crop size of the image and even get the name of the file!

<?php $image = wp_get_attachment_image_src(get_field('image_test'), 'full'); ?>
<img src="<?php echo $image[0]; ?>" alt="<?php echo get_the_title(get_field('image_test')) ?>" />

Working with the Repeater Field

repeater can be accessed by get_field or the_repeater_field / the_sub_field

<?php 
 
// using normal array
 
$rows = get_field('repeater_field_name');
if($rows)
{
	echo '<ul>';
 
	foreach($rows as $row)
	{
		echo '<li>sub_field_1 = ' . $row['sub_field_1'] . ', sub_field_2 = ' . $row['sub_field_2'] .', etc</li>';
	}
 
	echo '</ul>';
}
 
// or has_sub_field + get_sub_field
 
if(get_field('repeater_field_name'))
{
	echo '<ul>';
 
	while(has_sub_field('repeater_field_name'))
	{
		echo '<li>sub_field_1 = ' . get_sub_field('sub_field_1') . ', sub_field_2 = ' . get_sub_field('sub_field_2') .', etc</li>';
	}
 
	echo '</ul>';
}
 
// or the_repeater_field + the_sub_field
if(get_field('repeater_field_name')): ?>
 
	<ul>
 
	<?php while(has_sub_field('repeater_field_name')): ?>
 
		<li>sub_field_1 = <?php the_sub_field('sub_field_1'); ?>, sub_field_2 = <?php the_sub_field('sub_field_2'); ?>, etc</li>
 
	<?php endwhile; ?>
 
	</ul>
 
<?php endif; ?>

Randomly select a repeater field row

<?php
 
$rows = get_field('repeater_field_name');
$row_count = count($rows);
$i = rand(0, $row_count - 1);
 
echo $rows[$i]['sub_field_name'];
 
?>

Getting vales from another page

<?php
 
$other_page = 12;
 
?>
<p><?php the_field('field_name', $other_page); ?></p>
<?php
 
// get variable
$variable = get_field('field_name', $other_page);
 
// repeater - note that the_sub_field ad get_sub_field don't need a post id parameter
if(get_field('repeater_field_name', $other_page))
{
	echo '<ul>';
 
	while(has_sub_field('repeater_field_name', $other_page))
	{
		echo '<li>sub_field_1 = ' . get_sub_field('sub_field_1') . ', sub_field_2 = ' . get_sub_field('sub_field_2') .', etc</li>';
	}
 
	echo '</ul>';
}
 
?>

Query posts with acf values

Example of finding Events (post type) where location (custom field – select) equals Melbourne (value).
Lots to read here: http://codex.wordpress.org/Template_Tags/get_posts.

<?php
 
$posts = get_posts(array(
	'numberposts' => -1,
	'post_type' => 'event',
	'meta_key' => 'location',
	'meta_value' => 'melbourne'
));
 
if($posts)
{
	echo '<ul>';
 
	foreach($posts as $post)
	{
		echo '<li><a href="' . get_permalink($post->ID) . '">' . get_the_title($post->ID) . '</a></li>';
	}
 
	echo '</ul>';
}
 
?>