Función Referencia / Obtener páginas (get_pages)

fuente: http://codex.wordpress.org/Function_Reference/get_pages

Contenido

• 1 Descripción
• 2 Uso
  • 2.1 Uso predeterminado
• 3 Parámetros
• 4 Retorno
• 5 Ejemplo
  • 5.1 Viendo la página en la lista desplegable
  • 5.2 Viendo las páginas secundarias de la página actual en formato de mensaje
• 6 de cambios
• 7 Archivo de origen
• 8 Relacionados

Descripción

Esta función devuelve una serie de páginas que están en el blog, opcionalmente limitados por parámetros. Este arreglo no es como el árbol (jerárquica). Ver elwp_list_pages () etiqueta de plantilla para la salida de los títulos de las páginas de una forma arborescente.

Esta función también puede recuperar otros tipos de envíos utilizando el parámetro 'post_type', pero el tipo debe ser jerárquicas como las páginas, o la función devolverá falso.

Tenga en cuenta que, aunque similar a get_posts () , varios de los nombres de los parámetros y los valores difieren. (Se lleva a cabo de manera muy diferente, consulte get_posts ()).

NOTA: Esta función no recuperará páginas utilizando el 'meta_key' 'y los parámetros meta_value' en el array $ args como se describe a continuación. Hasta que esto no se fija en la base de código de WordPress, es posible que desee utilizar get_posts () en su lugar.

Uso

 <? php get_pages (  $ args  );  ?> 

Uso predeterminado

<? Php $ args = array (
 'Sort_order' => 'ASC',
 'Columna_ordenación' => 'POST_TITLE',
 'Jerárquico' => 1,
 'Excluir' => '',
 'Incluir' => '',
 'Meta_key' => '',
 'Meta_value' => '',
 'Autores' => '',
 'Child_of' => 0,
 'Padre' => -1,
 'Exclude_tree' => '',
 'Número' => '',
 "Compensar" => 0,
 'Post_type' => 'Página',
 'Post_status' => 'publicar'
); 
$ páginas = get_pages ($ args); 
?>

parámetros

columna_ordenación 

( Cadena ) Ordena la lista de páginas en un número de maneras diferentes. El ajuste predeterminado es ordenar alfabéticamente por el título de la página .

• 'POST_TITLE' - Ordenar Páginas alfabéticamente (por título) - por defecto
• 'menu_order' -. Ordena por Orden de páginas Páginas NB Tenga en cuenta la diferencia entre la Orden de las páginas y la ID de página . El ID de página es un número único asignado por WordPress para todos los envíos o página. La Orden de las páginas se puede configurar por el usuario en la escritura> Páginas del panel de administración.
• 'post_date' - Ordenar por el tiempo de creación.
• 'post_modified' - Ordenar por el tiempo de la última modificación.
• 'ID' - Ordenar por ID Página numérico.
• 'post_author' - Ordenar por ID numérico de la Página del autor.
• 'post_name' - Ordenar alfabéticamente por el poste de babosa . No se admite sin embargo, a partir de WP 3.3 (Ver:http://core.trac.wordpress.org/ticket/14368 )

Nota: El columna_ordenación parámetro se puede utilizar para ordenar la lista de páginas por el descriptor de cualquier campo de la tabla wp_post de la base de datos de WordPress. Algunos ejemplos útiles se enumeran aquí.

Nota: get_posts () utiliza el parámetro 'orderby' en lugar de 'columna_ordenación' . Además, get_posts () añade automáticamente 'post_' a estos valores: 'autor, la fecha, la modificación de los padres, título, extracto, contenido " .

sort_order 

( Cadena ) Cambiar el orden de clasificación de la lista de páginas (ascendente o descendente). El valor predeterminado esascendente . Los valores válidos:

• 'ASC' - Ordenar de menor a mayor (por defecto).
• 'desc' - Ordenar de mayor a menor.

Nota: get_posts () utiliza el parámetro "orden" en lugar de "sort_order ' .

excluir 

( Cadena o una tabla ) Definir una lista separada por comas de ID de página que deben excluirse de la lista (ejemplo: 'exclude = 3,7,31' ). A partir de la versión 3.0 , también se puede utilizar una matriz de ID de página. No existe un valor predeterminado.

incluir 

( Cadena o una tabla ) incluir sólo algunas de las páginas en la lista generada por get_pages . Al igual que excluye , este parámetro toma una lista separada por comas de los ID de página. A partir de la versión 3.0 , también se puede utilizar una matriz de ID de página. No existe un valor predeterminado.

Nota: Si se proporciona este parámetro, child_of, padre, excluir, meta_key, y params meta_value se ignoran, y jerárquica se establece en false.

niño de 

( Número entero ) Lista de las sub-páginas de una única página; utiliza el ID de una página como el valor. El valor predeterminado es 0 (lista de todas las páginas). Tenga en cuenta que el parámetro child_of también buscará "nietos" de la ID dada, no sólo los descendientes directos.

• 0 - por defecto, sin restricción child_of

Nota: El child_of parámetro no se aplica a la consulta SQL para las páginas. Se aplica a los resultados de la consulta. Si se proporciona también un parámetro de número, los resultados finales pueden ser menos que el número especificado.

padre 

( Número entero ) una lista de las páginas que se la proporcionados sola página Sólo ID como padre. El valor predeterminado es -1 (muestra todas las páginas, independientemente de los padres). Tenga en cuenta que el parámetro "jerárquica" debe establecerse en 0 (falso) - que no está por defecto - o si no, devuelve ningún resultado para cualquier página que no sea las páginas de nivel superior con ningún padre (ID = 0) y el valor predeterminado todas las páginas (ID = -1). En contraste con el parámetro 'child_of', este parámetro sólo devuelve los descendientes directos de los padres, no hay 'nietos'. Puede obviar la "jerárquica" se pone a 0 requisito pasando un parámetro 'child_of' se establece en el mismo valor de ID (padre).

• -1 - Por defecto, sin restricción de los padres
• 0 - devuelve todas las páginas de nivel superior

exclude_tree 

( Número entero ) Lo opuesto a 'child_of', 'exclude_tree' eliminará todos los niños de una determinada Identificación de los resultados. Útil para ocultar todos los niños de una página determinada. También se puede utilizar para ocultar nietos en conjunción con un valor 'child_of'. Este parámetro estaba disponible en la versión 2.7 .

jerárquico 

( Booleano ) Lista de sub-páginas por debajo de su padre o listas de la línea páginas. El valor predeterminado es verdadero (lista de sub-páginas por debajo del elemento de la lista de los padres). NOTA: Este valor por defecto impedirá búsquedas meta_key y página principal de búsqueda de sub-páginas. Es necesario configurar 'jerárquico' => 0 para estos parámetros para que funcione correctamente. Los valores válidos:

• 1 (verdadero) - por defecto
• 0 (falso)

meta_key 

( Cadena ) Sólo incluye las páginas que tienen este campo de clave personalizada (uso en conjunción con el campo meta_value).

meta_value 

( Cadena ) Sólo incluye las páginas que tienen este valor de campo personalizado (su uso en conjunción con el campo meta_key).

autores 

( Cadena ) incluyen sólo las páginas escritas por el autor determinado (s)

Nota: get_posts () utiliza el parámetro de "autor" en lugar de "autores" .

número 

( Número entero ) Define el número de páginas a la lista. Esto hace que el valor límite de SQL para definir. Por defecto a ningún límite. Este parámetro se añadió con la versión 2.8 .

Nota: get_posts () utiliza el parámetro 'numberposts' en lugar de "número" .

En segundo lugar Nota: no funciona si se utiliza junto con 'child_of' . En lugar de utilizar "padre" y establecer "jerárquica"en false.

compensar 

( Número entero ) El número de páginas pase por encima de (o desplazar) antes de recoger el conjunto de páginas. Por defecto no se compensa. Este parámetro se añadió con la versión 2.8 .

tipo de mensaje 

( "string") Mostrar mensajes asociados con cierto tipo . Los valores válidos incluyen:

• ' Palo ' - un puesto.
• ' Página ' - una página.
• ' Revisión ' - una revisión.
• ' Apego ' - un archivo adjunto.
• Tipos de encargo de correos.

post_status 

( Cadena ) Una lista separada por comas de los tipos de estado de correos que debe ser incluido. Por ejemplo, 'publicar, privada, el proyecto' .

Regreso

(Formación) 

Una matriz que contiene todas las páginas que concuerden con la solicitud, o falso en caso de error. La matriz devuelta es una matriz de objetos de "página". Cada objeto de página es un mapa que contiene 24 teclas:

• ID : página / post ID ( int )
• post_author ID autor (: string )
• post_date : cadena de fecha-hora ( AAAA-MM-DD HH: MM: SS ), por ejemplo, "10/15/2012 01:02:59"
• post_date_gmt : cadena de fecha-hora
• POST_CONTENT : HTML ( cadena )
• título de la entrada
• post_excerpt : HTML ( cadena )
• post_status : ( publicar | heredar | pendientes | privado | futuro | proyecto | basura )
• comment_status : cerrado / abierto
• ping_status : ( cerrado | abierta )
• post_password
• post_name por múltiples piezas de página / post
• to_ping
• pinged
• post_modified : cadena de fecha-hora
• post_modified_gmt : cadena de fecha-hora
• post_content_filtered
• post_parent ID padre (: int )
• GUID : URL
• menu_order : ( int )
• post_type : ( página | post | archivo adjunto )
• post_mime_type
• COMMENT_COUNT : número de comentarios ( cadena )
• filtrar

Todos los valores son cadenas menos que se indique de otra manera como ( int ).

Ejemplo

Viendo la página en la lista desplegable

En este ejemplo una lista desplegable con todas las páginas. Tenga en cuenta cómo se puede agarrar el enlace de la página con una simple llamada a la función get_page_link pasar el ID de la página.

<Select name = "page-desplegable"
 onchange = 'document.location.href = this.options [this.selectedIndex] .value; "> 
 <Option value = "">
<? Php echo esc_attr (__ ( 'Seleccione la página')); ?> </ Option>
 <? Php 
  $ Pages = get_pages (); 
  foreach ($ páginas como la página $) {
   $ Opción = '<option value = "'. Get_page_link ($ página-> ID). '">';
 $ Opción = $ página-> POST_TITLE.;
 . $ Opción = '</ option>';
 echo $ opción;
  }
 ?>
</ Select>

Viendo las páginas secundarias de la página actual en formato de mensaje

<? Php
 $ MIS PÁGINAS = get_pages (array ( 'child_of' => $ post-> ID, => 'post_date' 'columna_ordenación', 'sort_order' => 'desc'));

 foreach ($ MIS PÁGINAS como página $) {  
  $ Content = $ página-> POST_CONTENT;
  if (! $ contenido) // Verificar si la página en blanco
   continuar;

  $ Content = apply_filters ( 'the_content', $ contenido);
 ?>
  <H2> <a href="<?php eco get_page_link( $page-> ID);?> "> <? Php echo $ página-> POST_TITLE; ?> </a> </ H2>
  ? <Div class = "entrada"> <? Php echo $ contenido; ?> </ Div>
 <? Php
 } 
?>

Historial de cambios

• Desde: 1.5.0

Archivo fuente

get_pages () está situado en wp-includes / post.php .

Relacionado

Página Tags : get_all_page_ids() , get_ancestors() , get_page() , get_page_link() , get_page_by_path() , get_page_by_title() ,get_page_children() , get_page_hierarchy() , get_page_uri() , get_pages() , is_page() , page_uri_index() , wp_list_pages() ,wp_page_menu()

Véase también el índice de referencia de funciones y el índice de la plantilla Etiquetas .

Este artículo está marcado como en la necesidad de edición. Puede ayudar Codex por editarlo .

Categorías :

• corrección de estilo
• funciones