query.get_pages

/ Database / query.get_pages

Title : query.delete_term
Purpose : Retrieve a list of pages (or hierarchical post type items).
Syntax : [query.get_pages ]
Input Parameters :
  • ‘child_of’
    (int) Page ID to return child and grandchild pages of. Note: The value of $hierarchical has no bearing on whether $child_of returns hierarchical results. Default 0, or no restriction.
  • ‘sort_order’
    (string) How to sort retrieved pages. Accepts ‘ASC’, ‘DESC’. Default ‘ASC’.
  • ‘sort_column’
    (string) What columns to sort pages by, comma-separated. Accepts ‘post_author’, ‘post_date’, ‘post_title’, ‘post_name’, ‘post_modified’, ‘menu_order’, ‘post_modified_gmt’, ‘post_parent’, ‘ID’, ‘rand’, ‘comment*count’. ‘post*’ can be omitted for any values that start with it. Default ‘post_title’.
  • ‘hierarchical’
    (bool) Whether to return pages hierarchically. If false in conjunction with $child_of also being false, both arguments will be disregarded. Default true.
  • ‘exclude’
    (array) Array of page IDs to exclude.
  • ‘include’
    (array) Array of page IDs to include. Cannot be used with $child_of$parent$exclude$meta_key$meta_value, or $hierarchical.
  • ‘meta_key’
    (string) Only include pages with this meta key.
  • ‘meta_value’
    (string) Only include pages with this meta value. Requires $meta_key.
  • ‘authors’
    (string) A comma-separated list of author IDs.
  • ‘parent’
    (int) Page ID to return direct children of. Default -1, or no restriction.
  • ‘exclude_tree’
    (string|array) Comma-separated string or array of page IDs to exclude.
  • ‘number’
    (int) The number of pages to return. Default 0, or all pages.
  • ‘offset’
    (int) The number of pages to skip before returning. Requires $number. Default 0.
  • ‘post_type’
    (string) The post type to query. Default ‘page’.
  • ‘post_status’
    (string|array) A comma-separated list or array of post statuses to include. Default ‘publish’.
Return Value : (array|false) List of pages matching defaults or args.
Example 1 :
Code : [query.get_pages ]
{‘sort_order’ : ‘asc’,
‘sort_column’ : ‘post_title’,
‘hierarchical’ : 1,
‘exclude’ : ”,
‘include’ : ”,
‘meta_key’ : ”,
‘meta_value’ : ”,
‘authors’ : ”,
‘child_of’ : 0,
‘parent’ : -1,
‘exclude_tree’ : ”,
‘number’ : ”,
‘offset’ : 0,
‘post_type’ : ‘page’,
‘post_status’ : ‘publish’}
[/query.get_pages ]
Output : (array|false) List of pages matching defaults or args.
Description : Retrieve a list of pages (or hierarchical post type items).
Categories
Most Popular

Leave a Reply

Your email address will not be published. Required fields are marked *