Add function to retrieve page ID or permalink based on template

[gustavocoimbra]

This contribution implements a new function that retrieves the ID or permalink of a page based on its assigned template. The function performs a query to find pages using a specific template and returns either the ID or permalink of the first matching page.

### Details:

• The function get_page_by_template() accepts two parameters: $template (the template name) and $field (which can be 'ID' for the page ID or 'permalink' for the page URL).
• It uses WP_Query to search for pages with the specified template.
• The function returns either the page ID or permalink based on the $field argument.

### Benefits:

• Provides an easy way to retrieve a page by its template, improving flexibility for theme and plugin developers.
• Reduces the need for custom queries in theme files.
• Helps in dynamically linking or referencing pages based on their template.

[gustavocoimbra]

<?php
/**
 * Retrieves the ID or permalink of a page based on its template.
 *
 * This function performs a query to find pages using a specific template
 * and returns the ID or permalink of the first matching page.
 *
 * @param string $template The name of the template to search for.
 * @param string $field The field to return: 'ID' for the page ID, 'permalink' for the page permalink.
 * @return string|int The ID or permalink of the page, or null if no page is found.
 */
function get_page_by_template( $template, $field = 'permalink' ){
    $query = new WP_Query([
        'post_type'     => 'page',
        'meta_query'    => [
            [
                'key'       => '_wp_page_template',
                'value'     => $template,
                'compare'   => '=='
            ]
        ]
    ]);
    while($query->have_posts()){
        $query->the_post();
        if($field == 'ID') {
            return get_the_ID();
        } elseif($field == 'permalink') {
            return get_permalink();
        }
    }
}

This contribution implements a new function that retrieves the ID or permalink of a page based on its assigned template. The function performs a query to find pages using a specific template and returns either the ID or permalink of the first matching page.

Trac ticket: https://core.trac.wordpress.org/ticket/62666

[gustavocoimbra]

​https://github.com/WordPress/wordpress-develop/pull/7977

Queries pages using a specified template file and returns an array of IDs, permalinks, or titles based on the provided field parameter.

[kadiwala]

Created pull request in trunk

[kadiwala]

removed extra space as suggested.

Hi @mukeshpanchal27
Thank you for the suggestion. I've removed that extra space.

ta me tirano kk

ta me tirano kk

[kadiwala]

Hi @gustavocoimbra

I've updated the code with an array because what if one template is assigned to multiple pages
So, we need to get all page IDs as per the template.

Hi @mukeshpanchal27

Please review my updated code.
but am not able to create diff file after commit. Can you please suggest me way how can we create diff file if possible.
Thanks

`
/

• Retrieves page IDs, permalinks, or titles based on a template file name. *
• Queries pages using a specified template file and returns an array of
• IDs, permalinks, or titles based on the provided field parameter. *
• @param string $template The template file name to search for.
• @param string $field The field to return: 'ID' for page IDs, 'permalink' for page permalinks, or 'title' for page titles.
• @return array|null An array of IDs, permalinks, or titles of matching pages, or null if no pages are found. */

function get_page_by_template( $template, $field = 'ID' ) {

$query = new WP_Query(

array(

'post_type' => 'page',
'meta_query' => array(

array(

'key' => '_wp_page_template',
'value' => $template,
'compare' => '==',

),

),
'fields' => 'ids',

)

);

if ( $query->have_posts() ) {

$template_page_ids = $query->posts;
wp_reset_postdata();
if ( 'ID' === $field ) {

return $template_page_ids;

} elseif ( 'title' === $field ) {

return array_combine( $template_page_ids, array_map( 'get_the_title', $template_page_ids ) );

} elseif ( 'permalink' === $field ) {

return array_combine( $template_page_ids, array_map( 'get_permalink', $template_page_ids ) );

}

}

wp_reset_postdata();
return null;

}
`