Description
This plugin provides the PHP function c2c_array_partition()
to split an array into any number of sub-arrays, suitable for creating evenly distributed, vertically filled “columns”. Also known as “chunking” or “partitioning”.
For example:
$topics = array( "aardvark", "bear", "cat", "dog", "emu", "fox", "gnu", "hippo", "ibis", "jackal" );
print_r( c2c_array_partition( $topics, 4 ) );
Yields:
Array
(
[0] => Array
(
[0] => ant
[1] => bear
[2] => cat
)
[1] => Array
(
[0] => dog
[1] => emu
[2] => fox
)
[2] => Array
(
[0] => gnu
[1] => hippo
)
[3] => Array
(
[0] => ibis
[1] => jackal
)
)
Note the array elements are distributed into the requested 4 “columns” as evenly as possible.
The function will fill as many partitions as requested, as long as there are enough elements in the array to do so. Any remaining unfilled partitions will be represented as empty arrays.
In contrast, using PHP’s built-in array_chunk()
as such:
print_r( array_chunk( $topics, 4 ) );
Yields:
Array
(
[0] => Array
(
[0] => aardvark
[1] => bear
[2] => cat
[3] => dog
)
[1] => Array
(
[0] => emu
[1] => fox
[2] => gnu
[3] => hippo
)
[2] => Array
(
[0] => ibis
[1] => jackal
)
)
It can be sent an array of any data types or objects.
Links: Plugin Homepage | Plugin Directory Page | GitHub | Author Homepage
Examples
<?php
$topics = array( "ant", "bear", "cat" );
print_r( c2c_array_partition( $topics, 5 ) );
?>
=>
Array
(
[0] => Array
(
[0] => ant
)
[1] => Array
(
[0] => bear
)
[2] => Array
(
[0] => cat
)
[3] => Array
(
)
[4] => Array
(
)
)
Also see Description section for another example. Definitely check out the packaged unit test file as it contains various examples.
Installation
- Install via the built-in WordPress plugin installer. Or download and unzip
array-partition.zip
inside the plugins directory for your site (typicallywp-content/plugins/
) - Activate the plugin through the ‘Plugins’ admin menu in WordPress
- Use the
c2c_array_partition()
function in your template(s) or code as desired.
FAQ
-
Why not use PHP’s built-in `array_chunk()`?
-
array_chunk() allows you to specify the number of elements per partition, not how many partitions you want. (See Description.).
For an array with 12 elements, if you requested a chunk size of 2, you would get back an array of 6 sub-arrays (the original elements grouped into arrays of 2 elements). With
array_partition()
, if you requested 2 partitions, you would get back an array of 2 sub-arrays (the original elements grouped into 2 arrays).Phrased another way, with
array_chunk()
you tell it how many elements max should be in a partition and it gives you as many partitions as necessary. Withc2c_array_partition()
, you tell it how many partitions you want, and it’ll evenly split the elements into those partitions as evenly as possible. -
Does this plugin include unit tests?
-
Yes. The tests are not packaged in the release .zip file or included in plugins.svn.wordpress.org, but can be found in the plugin’s GitHub repository.
Reviews
There are no reviews for this plugin.
Contributors and Developers
“array_partition” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “array_partition” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Change Log
1.3.4 (2024-08-02)
- Change: Note compatibility through WP 6.6+
- Change: Update copyright date (2024)
- New: Add
.gitignore
file - Change: Reduce number of ‘Tags’ from
readme.txt
- Change: Remove development and testing-related files from release packaging
- Unit tests:
- Hardening: Prevent direct web access to
bootstrap.php
- Allow tests to run against current versions of WordPress
- New: Add
composer.json
for PHPUnit Polyfill dependency - Change: In bootstrap, store path to plugin directory in a constant
- Hardening: Prevent direct web access to
1.3.3 (2023-05-21)
- Change: Note compatibility through WP 6.3+
- Change: Update copyright date (2023)
1.3.2 (2021-09-25)
- Change: Note compatibility through WP 5.8+
- Unit tests:
- Change: Restructure unit test directories
- Change: Move
phpunit/
intotests/phpunit/
- Change: Move
phpunit/bin/
intotests/
- Change: Move
- Change: Remove ‘test-‘ prefix from unit test file
- Change: In bootstrap, store path to plugin file constant
- Change: In bootstrap, add backcompat for PHPUnit pre-v6.0
- Change: Restructure unit test directories
Full changelog is available in CHANGELOG.md.