Confluence Macro / Method giving total Child Page count for Parent


I've been hunting around looking for a Macro / Method that gives a single numerical total for the number of Child Pages for the current Parent.

The intent is to use this child page count number along side the {expand} macro and {children} macro to create a crude page header which works something like (wiki pseudocode):

There are {ChildPageCount} Child Pages,
{expand:Click here to see child pages...}

Does anyone have any suggestions?


3 answers

1 accepted

1 vote
Accepted answer

You can get the number of children using the $content object (which, when rendered in a page is an instance of a Page object). This class defines a getChildren() method, which returns a List of child pages. List has a count() method which returns an int.

All that to say, do this in your macro:


Thanks for this valuable input @Matthew J. Horn, but this is just getting the child pages to depth one, its not getting number of all the descendants. For example Page 1 has a child page 1a which further has a child page 1aa, then this code if used on Page 1 just gives number of children as one i.e. its counting the child 1a but not its child 1aa.

0 votes
Mirek Community Champion Mar 06, 2013

Hi Gavin,

Why creating a macro? When looking at the OOTB confluence page you have something that you want just above the comment section. It looks similar to what you want to achieve:

It could be expanded and collapsed and it is availabe on every page that have a child page

Best Regards,


Thanks for the feedback Mirek - I was aware OOB feature, and you're right it's pretty much what I'm looking for *however* my user community would like to see this (or something very similar) at the top of the parent page. The use case is simple, it allows drill down into child pages without having to scroll to the bottom of the parent page first.

Mirek, I've tried that using the Child Pages macro but the count never appears.

Here's the macro I created (used a lot of other peoples input - all credit goes to those that helped). Create a macro with the "no body" option selected. This count pages that matches the page "label" specified. {code} ## Macro title: Count Pages by Label Macro ## Macro has a body: N ## Body processing: No Macro Body ## Output: ## ## Developed by: Gavin Fowler ## Date created: 15/Oct/2013 ## Installed by: Gavin Fowler ## @param Space:title=Restrict to space|type=string|desc=Enter a space key to restrict label search. For all spaces use @all, if blank only the current space will be searched (space key is case sensitive) ## @param Label:title=Label|type=string|required=true|desc=label to count (if the label is is not found then a value of zero will be returned) #set( $labelManager = $action.LabelManager ) #set( $labRef = $labelManager.getLabel($paramLabel) ) #if (!$labRef) 0 #else #if (!$paramSpace) #set( $paramSpace = $space.getKey() ) #end #if ($paramSpace != "@all") #set( $pages = $labelManager.getContentInSpaceForLabel(0 , -1 , $paramSpace, $labRef) ) #else #set( $pages = $labelManager.getContentForLabel(0 , -1 , $labRef) ) #end $pages.getCount() #end {code}

Looks like this answers might help

Suggest an answer

Log in or Sign up to answer
Community showcase
Posted Oct 24, 2018 in Confluence

Atlassian Research opportunity with Confluence templates

Do you use templates with Confluence? Take part in a remote 1-hr workshop. You'll receive USD $100 for your time!   We're looking for people to participate in a   remote 1-hr workshop...

948 views 13 11
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you