Count Array Items

Property	Value
description	Count array values stored in post meta.
tags	lib, php, wp, oop
rating

Human: 3 - Mixed authorship

Roughly half AI, half human. Core content reviewed, but minor risk remains.

Overview

Count array values stored in post meta, such as gallery fields.

The helper defaults to the current post ID when no post ID is passed, so it works in templates and Bricks query loops. It returns 0 for missing fields, invalid post IDs, empty values, or scalar values.

Bricks examples:

{echo:mac_count_array_items('gallery_images')}
{echo:mac_count_array_items('gallery_images', {post_id})}

Variants

Procedural

Add Macro

Add wp-count-array-items macro.

<?php
/**
 * Count array post meta values.
 *
 * Counts items stored as arrays, such as galleries.
 *
 * Examples:
 *   mac_count_array_items( 'gallery_images' );
 *   mac_count_array_items( 'gallery_images', 123 );
 *
 * Builder usage:
 *   {echo:mac_count_array_items('gallery_images')}
 *   {echo:mac_count_array_items('gallery_images', {post_id})}
 *
 * @param string   $meta_key Post meta key.
 * @param int|null $post_id  Optional. Defaults to current post ID.
 * @return int
 */
if ( ! function_exists( 'mac_count_array_items' ) ) {

    function mac_count_array_items( string $meta_key, ?int $post_id = null ): int {

        if ( $meta_key === '' ) {
            return 0;
        }

        $post_id = $post_id ?: (int) get_the_ID();

        if ( $post_id <= 0 ) {
            return 0;
        }

        $value = get_post_meta( $post_id, $meta_key, true );

        if ( is_array( $value ) ) {
            return count( $value );
        }

        if ( $value instanceof Countable ) {
            return count( $value );
        }

        return 0;
    }
}

OOP

Add Macro

Add wp-count-array-items--oop macro.

<?php
/**
 * Count array values stored in post meta.
 *
 * @package mac-core
 */

declare(strict_types=1);

namespace MacCore\Utils {

    /**
     * Count array values stored in post meta.
     */
    final class CountArrayItems
    {
        /**
         * Count items for a post meta key.
         *
         * @param string   $metaKey Post meta key.
         * @param int|null $postId  Optional. Defaults to current post ID.
         * @return int
         */
        public static function count( string $metaKey, ?int $postId = null ): int
        {
            if ( $metaKey === '' ) {
                return 0;
            }

            $postId = $postId ?: (int) \get_the_ID();
            if ( $postId <= 0 ) {
                return 0;
            }

            $value = \get_post_meta( $postId, $metaKey, true );

            if ( \is_array( $value ) ) {
                return \count( $value );
            }

            if ( $value instanceof \Countable ) {
                return \count( $value );
            }

            return 0;
        }
    }
}

namespace {
    if ( ! function_exists( 'mac_count_array_items' ) ) {
        /**
         * Count array post meta values.
         *
         * Counts items stored as arrays, such as galleries.
         *
         * Examples:
         *   mac_count_array_items('gallery_images');
         *   mac_count_array_items('gallery_images', 123);
         *
         * Builder usage:
         *   {echo:mac_count_array_items('gallery_images')}
         *   {echo:mac_count_array_items('gallery_images', {post_id})}
         *
         * @param string   $metaKey
         * @param int|null $postId
         * @return int
         */
        function mac_count_array_items( string $metaKey, ?int $postId = null ): int
        {
            return \MacCore\Utils\CountArrayItems::count( $metaKey, $postId );
        }
    }
}