123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019 |
- <?php
- /**
- * WordPress Post Template Functions.
- *
- * Gets content for the current post in the loop.
- *
- * @package WordPress
- * @subpackage Template
- */
- /**
- * Displays the ID of the current item in the WordPress Loop.
- *
- * @since 0.71
- */
- function the_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
- echo get_the_ID();
- }
- /**
- * Retrieves the ID of the current item in the WordPress Loop.
- *
- * @since 2.1.0
- *
- * @return int|false The ID of the current item in the WordPress Loop. False if $post is not set.
- */
- function get_the_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
- $post = get_post();
- return ! empty( $post ) ? $post->ID : false;
- }
- /**
- * Displays or retrieves the current post title with optional markup.
- *
- * @since 0.71
- *
- * @param string $before Optional. Markup to prepend to the title. Default empty.
- * @param string $after Optional. Markup to append to the title. Default empty.
- * @param bool $echo Optional. Whether to echo or return the title. Default true for echo.
- * @return void|string Void if `$echo` argument is true, current post title if `$echo` is false.
- */
- function the_title( $before = '', $after = '', $echo = true ) {
- $title = get_the_title();
- if ( strlen( $title ) == 0 ) {
- return;
- }
- $title = $before . $title . $after;
- if ( $echo ) {
- echo $title;
- } else {
- return $title;
- }
- }
- /**
- * Sanitizes the current title when retrieving or displaying.
- *
- * Works like the_title(), except the parameters can be in a string or
- * an array. See the function for what can be override in the $args parameter.
- *
- * The title before it is displayed will have the tags stripped and esc_attr()
- * before it is passed to the user or displayed. The default as with the_title(),
- * is to display the title.
- *
- * @since 2.3.0
- *
- * @param string|array $args {
- * Title attribute arguments. Optional.
- *
- * @type string $before Markup to prepend to the title. Default empty.
- * @type string $after Markup to append to the title. Default empty.
- * @type bool $echo Whether to echo or return the title. Default true for echo.
- * @type WP_Post $post Current post object to retrieve the title for.
- * }
- * @return void|string Void if 'echo' argument is true, the title attribute if 'echo' is false.
- */
- function the_title_attribute( $args = '' ) {
- $defaults = array(
- 'before' => '',
- 'after' => '',
- 'echo' => true,
- 'post' => get_post(),
- );
- $parsed_args = wp_parse_args( $args, $defaults );
- $title = get_the_title( $parsed_args['post'] );
- if ( strlen( $title ) == 0 ) {
- return;
- }
- $title = $parsed_args['before'] . $title . $parsed_args['after'];
- $title = esc_attr( strip_tags( $title ) );
- if ( $parsed_args['echo'] ) {
- echo $title;
- } else {
- return $title;
- }
- }
- /**
- * Retrieves the post title.
- *
- * If the post is protected and the visitor is not an admin, then "Protected"
- * will be inserted before the post title. If the post is private, then
- * "Private" will be inserted before the post title.
- *
- * @since 0.71
- *
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
- * @return string
- */
- function get_the_title( $post = 0 ) {
- $post = get_post( $post );
- $post_title = isset( $post->post_title ) ? $post->post_title : '';
- $post_id = isset( $post->ID ) ? $post->ID : 0;
- if ( ! is_admin() ) {
- if ( ! empty( $post->post_password ) ) {
- /* translators: %s: Protected post title. */
- $prepend = __( 'Protected: %s' );
- /**
- * Filters the text prepended to the post title for protected posts.
- *
- * The filter is only applied on the front end.
- *
- * @since 2.8.0
- *
- * @param string $prepend Text displayed before the post title.
- * Default 'Protected: %s'.
- * @param WP_Post $post Current post object.
- */
- $protected_title_format = apply_filters( 'protected_title_format', $prepend, $post );
- $post_title = sprintf( $protected_title_format, $post_title );
- } elseif ( isset( $post->post_status ) && 'private' === $post->post_status ) {
- /* translators: %s: Private post title. */
- $prepend = __( 'Private: %s' );
- /**
- * Filters the text prepended to the post title of private posts.
- *
- * The filter is only applied on the front end.
- *
- * @since 2.8.0
- *
- * @param string $prepend Text displayed before the post title.
- * Default 'Private: %s'.
- * @param WP_Post $post Current post object.
- */
- $private_title_format = apply_filters( 'private_title_format', $prepend, $post );
- $post_title = sprintf( $private_title_format, $post_title );
- }
- }
- /**
- * Filters the post title.
- *
- * @since 0.71
- *
- * @param string $post_title The post title.
- * @param int $post_id The post ID.
- */
- return apply_filters( 'the_title', $post_title, $post_id );
- }
- /**
- * Displays the Post Global Unique Identifier (guid).
- *
- * The guid will appear to be a link, but should not be used as a link to the
- * post. The reason you should not use it as a link, is because of moving the
- * blog across domains.
- *
- * URL is escaped to make it XML-safe.
- *
- * @since 1.5.0
- *
- * @param int|WP_Post $post Optional. Post ID or post object. Default is global $post.
- */
- function the_guid( $post = 0 ) {
- $post = get_post( $post );
- $post_guid = isset( $post->guid ) ? get_the_guid( $post ) : '';
- $post_id = isset( $post->ID ) ? $post->ID : 0;
- /**
- * Filters the escaped Global Unique Identifier (guid) of the post.
- *
- * @since 4.2.0
- *
- * @see get_the_guid()
- *
- * @param string $post_guid Escaped Global Unique Identifier (guid) of the post.
- * @param int $post_id The post ID.
- */
- echo apply_filters( 'the_guid', $post_guid, $post_id );
- }
- /**
- * Retrieves the Post Global Unique Identifier (guid).
- *
- * The guid will appear to be a link, but should not be used as an link to the
- * post. The reason you should not use it as a link, is because of moving the
- * blog across domains.
- *
- * @since 1.5.0
- *
- * @param int|WP_Post $post Optional. Post ID or post object. Default is global $post.
- * @return string
- */
- function get_the_guid( $post = 0 ) {
- $post = get_post( $post );
- $post_guid = isset( $post->guid ) ? $post->guid : '';
- $post_id = isset( $post->ID ) ? $post->ID : 0;
- /**
- * Filters the Global Unique Identifier (guid) of the post.
- *
- * @since 1.5.0
- *
- * @param string $post_guid Global Unique Identifier (guid) of the post.
- * @param int $post_id The post ID.
- */
- return apply_filters( 'get_the_guid', $post_guid, $post_id );
- }
- /**
- * Displays the post content.
- *
- * @since 0.71
- *
- * @param string $more_link_text Optional. Content for when there is more text.
- * @param bool $strip_teaser Optional. Strip teaser content before the more text. Default false.
- */
- function the_content( $more_link_text = null, $strip_teaser = false ) {
- $content = get_the_content( $more_link_text, $strip_teaser );
- /**
- * Filters the post content.
- *
- * @since 0.71
- *
- * @param string $content Content of the current post.
- */
- $content = apply_filters( 'the_content', $content );
- $content = str_replace( ']]>', ']]>', $content );
- echo $content;
- }
- /**
- * Retrieves the post content.
- *
- * @since 0.71
- * @since 5.2.0 Added the `$post` parameter.
- *
- * @global int $page Page number of a single post/page.
- * @global int $more Boolean indicator for whether single post/page is being viewed.
- * @global bool $preview Whether post/page is in preview mode.
- * @global array $pages Array of all pages in post/page. Each array element contains
- * part of the content separated by the `<!--nextpage-->` tag.
- * @global int $multipage Boolean indicator for whether multiple pages are in play.
- *
- * @param string $more_link_text Optional. Content for when there is more text.
- * @param bool $strip_teaser Optional. Strip teaser content before the more text. Default false.
- * @param WP_Post|object|int $post Optional. WP_Post instance or Post ID/object. Default null.
- * @return string
- */
- function get_the_content( $more_link_text = null, $strip_teaser = false, $post = null ) {
- global $page, $more, $preview, $pages, $multipage;
- $_post = get_post( $post );
- if ( ! ( $_post instanceof WP_Post ) ) {
- return '';
- }
- // Use the globals if the $post parameter was not specified,
- // but only after they have been set up in setup_postdata().
- if ( null === $post && did_action( 'the_post' ) ) {
- $elements = compact( 'page', 'more', 'preview', 'pages', 'multipage' );
- } else {
- $elements = generate_postdata( $_post );
- }
- if ( null === $more_link_text ) {
- $more_link_text = sprintf(
- '<span aria-label="%1$s">%2$s</span>',
- sprintf(
- /* translators: %s: Post title. */
- __( 'Continue reading %s' ),
- the_title_attribute(
- array(
- 'echo' => false,
- 'post' => $_post,
- )
- )
- ),
- __( '(more…)' )
- );
- }
- $output = '';
- $has_teaser = false;
- // If post password required and it doesn't match the cookie.
- if ( post_password_required( $_post ) ) {
- return get_the_password_form( $_post );
- }
- // If the requested page doesn't exist.
- if ( $elements['page'] > count( $elements['pages'] ) ) {
- // Give them the highest numbered page that DOES exist.
- $elements['page'] = count( $elements['pages'] );
- }
- $page_no = $elements['page'];
- $content = $elements['pages'][ $page_no - 1 ];
- if ( preg_match( '/<!--more(.*?)?-->/', $content, $matches ) ) {
- if ( has_block( 'more', $content ) ) {
- // Remove the core/more block delimiters. They will be left over after $content is split up.
- $content = preg_replace( '/<!-- \/?wp:more(.*?) -->/', '', $content );
- }
- $content = explode( $matches[0], $content, 2 );
- if ( ! empty( $matches[1] ) && ! empty( $more_link_text ) ) {
- $more_link_text = strip_tags( wp_kses_no_null( trim( $matches[1] ) ) );
- }
- $has_teaser = true;
- } else {
- $content = array( $content );
- }
- if ( false !== strpos( $_post->post_content, '<!--noteaser-->' ) && ( ! $elements['multipage'] || 1 == $elements['page'] ) ) {
- $strip_teaser = true;
- }
- $teaser = $content[0];
- if ( $elements['more'] && $strip_teaser && $has_teaser ) {
- $teaser = '';
- }
- $output .= $teaser;
- if ( count( $content ) > 1 ) {
- if ( $elements['more'] ) {
- $output .= '<span id="more-' . $_post->ID . '"></span>' . $content[1];
- } else {
- if ( ! empty( $more_link_text ) ) {
- /**
- * Filters the Read More link text.
- *
- * @since 2.8.0
- *
- * @param string $more_link_element Read More link element.
- * @param string $more_link_text Read More text.
- */
- $output .= apply_filters( 'the_content_more_link', ' <a href="' . get_permalink( $_post ) . "#more-{$_post->ID}\" class=\"more-link\">$more_link_text</a>", $more_link_text );
- }
- $output = force_balance_tags( $output );
- }
- }
- return $output;
- }
- /**
- * Displays the post excerpt.
- *
- * @since 0.71
- */
- function the_excerpt() {
- /**
- * Filters the displayed post excerpt.
- *
- * @since 0.71
- *
- * @see get_the_excerpt()
- *
- * @param string $post_excerpt The post excerpt.
- */
- echo apply_filters( 'the_excerpt', get_the_excerpt() );
- }
- /**
- * Retrieves the post excerpt.
- *
- * @since 0.71
- * @since 4.5.0 Introduced the `$post` parameter.
- *
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
- * @return string Post excerpt.
- */
- function get_the_excerpt( $post = null ) {
- if ( is_bool( $post ) ) {
- _deprecated_argument( __FUNCTION__, '2.3.0' );
- }
- $post = get_post( $post );
- if ( empty( $post ) ) {
- return '';
- }
- if ( post_password_required( $post ) ) {
- return __( 'There is no excerpt because this is a protected post.' );
- }
- /**
- * Filters the retrieved post excerpt.
- *
- * @since 1.2.0
- * @since 4.5.0 Introduced the `$post` parameter.
- *
- * @param string $post_excerpt The post excerpt.
- * @param WP_Post $post Post object.
- */
- return apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );
- }
- /**
- * Determines whether the post has a custom excerpt.
- *
- * For more information on this and similar theme functions, check out
- * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
- * Conditional Tags} article in the Theme Developer Handbook.
- *
- * @since 2.3.0
- *
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
- * @return bool True if the post has a custom excerpt, false otherwise.
- */
- function has_excerpt( $post = 0 ) {
- $post = get_post( $post );
- return ( ! empty( $post->post_excerpt ) );
- }
- /**
- * Displays the classes for the post container element.
- *
- * @since 2.7.0
- *
- * @param string|string[] $class One or more classes to add to the class list.
- * @param int|WP_Post $post Optional. Post ID or post object. Defaults to the global `$post`.
- */
- function post_class( $class = '', $post = null ) {
- // Separates classes with a single space, collates classes for post DIV.
- echo 'class="' . esc_attr( implode( ' ', get_post_class( $class, $post ) ) ) . '"';
- }
- /**
- * Retrieves an array of the class names for the post container element.
- *
- * The class names are many. If the post is a sticky, then the 'sticky'
- * class name. The class 'hentry' is always added to each post. If the post has a
- * post thumbnail, 'has-post-thumbnail' is added as a class. For each taxonomy that
- * the post belongs to, a class will be added of the format '{$taxonomy}-{$slug}' -
- * eg 'category-foo' or 'my_custom_taxonomy-bar'.
- *
- * The 'post_tag' taxonomy is a special
- * case; the class has the 'tag-' prefix instead of 'post_tag-'. All class names are
- * passed through the filter, {@see 'post_class'}, with the list of class names, followed by
- * $class parameter value, with the post ID as the last parameter.
- *
- * @since 2.7.0
- * @since 4.2.0 Custom taxonomy class names were added.
- *
- * @param string|string[] $class Space-separated string or array of class names to add to the class list.
- * @param int|WP_Post $post Optional. Post ID or post object.
- * @return string[] Array of class names.
- */
- function get_post_class( $class = '', $post = null ) {
- $post = get_post( $post );
- $classes = array();
- if ( $class ) {
- if ( ! is_array( $class ) ) {
- $class = preg_split( '#\s+#', $class );
- }
- $classes = array_map( 'esc_attr', $class );
- } else {
- // Ensure that we always coerce class to being an array.
- $class = array();
- }
- if ( ! $post ) {
- return $classes;
- }
- $classes[] = 'post-' . $post->ID;
- if ( ! is_admin() ) {
- $classes[] = $post->post_type;
- }
- $classes[] = 'type-' . $post->post_type;
- $classes[] = 'status-' . $post->post_status;
- // Post Format.
- if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
- $post_format = get_post_format( $post->ID );
- if ( $post_format && ! is_wp_error( $post_format ) ) {
- $classes[] = 'format-' . sanitize_html_class( $post_format );
- } else {
- $classes[] = 'format-standard';
- }
- }
- $post_password_required = post_password_required( $post->ID );
- // Post requires password.
- if ( $post_password_required ) {
- $classes[] = 'post-password-required';
- } elseif ( ! empty( $post->post_password ) ) {
- $classes[] = 'post-password-protected';
- }
- // Post thumbnails.
- if ( current_theme_supports( 'post-thumbnails' ) && has_post_thumbnail( $post->ID ) && ! is_attachment( $post ) && ! $post_password_required ) {
- $classes[] = 'has-post-thumbnail';
- }
- // Sticky for Sticky Posts.
- if ( is_sticky( $post->ID ) ) {
- if ( is_home() && ! is_paged() ) {
- $classes[] = 'sticky';
- } elseif ( is_admin() ) {
- $classes[] = 'status-sticky';
- }
- }
- // hentry for hAtom compliance.
- $classes[] = 'hentry';
- // All public taxonomies.
- $taxonomies = get_taxonomies( array( 'public' => true ) );
- /**
- * Filters the taxonomies to generate classes for each individual term.
- *
- * Default is all public taxonomies registered to the post type.
- *
- * @since 6.1.0
- *
- * @param string[] $taxonomies List of all taxonomy names to generate classes for.
- * @param int $post_id The post ID.
- * @param string[] $classes An array of post class names.
- * @param string[] $class An array of additional class names added to the post.
- */
- $taxonomies = apply_filters( 'post_class_taxonomies', $taxonomies, $post->ID, $classes, $class );
- foreach ( (array) $taxonomies as $taxonomy ) {
- if ( is_object_in_taxonomy( $post->post_type, $taxonomy ) ) {
- foreach ( (array) get_the_terms( $post->ID, $taxonomy ) as $term ) {
- if ( empty( $term->slug ) ) {
- continue;
- }
- $term_class = sanitize_html_class( $term->slug, $term->term_id );
- if ( is_numeric( $term_class ) || ! trim( $term_class, '-' ) ) {
- $term_class = $term->term_id;
- }
- // 'post_tag' uses the 'tag' prefix for backward compatibility.
- if ( 'post_tag' === $taxonomy ) {
- $classes[] = 'tag-' . $term_class;
- } else {
- $classes[] = sanitize_html_class( $taxonomy . '-' . $term_class, $taxonomy . '-' . $term->term_id );
- }
- }
- }
- }
- $classes = array_map( 'esc_attr', $classes );
- /**
- * Filters the list of CSS class names for the current post.
- *
- * @since 2.7.0
- *
- * @param string[] $classes An array of post class names.
- * @param string[] $class An array of additional class names added to the post.
- * @param int $post_id The post ID.
- */
- $classes = apply_filters( 'post_class', $classes, $class, $post->ID );
- return array_unique( $classes );
- }
- /**
- * Displays the class names for the body element.
- *
- * @since 2.8.0
- *
- * @param string|string[] $class Space-separated string or array of class names to add to the class list.
- */
- function body_class( $class = '' ) {
- // Separates class names with a single space, collates class names for body element.
- echo 'class="' . esc_attr( implode( ' ', get_body_class( $class ) ) ) . '"';
- }
- /**
- * Retrieves an array of the class names for the body element.
- *
- * @since 2.8.0
- *
- * @global WP_Query $wp_query WordPress Query object.
- *
- * @param string|string[] $class Space-separated string or array of class names to add to the class list.
- * @return string[] Array of class names.
- */
- function get_body_class( $class = '' ) {
- global $wp_query;
- $classes = array();
- if ( is_rtl() ) {
- $classes[] = 'rtl';
- }
- if ( is_front_page() ) {
- $classes[] = 'home';
- }
- if ( is_home() ) {
- $classes[] = 'blog';
- }
- if ( is_privacy_policy() ) {
- $classes[] = 'privacy-policy';
- }
- if ( is_archive() ) {
- $classes[] = 'archive';
- }
- if ( is_date() ) {
- $classes[] = 'date';
- }
- if ( is_search() ) {
- $classes[] = 'search';
- $classes[] = $wp_query->posts ? 'search-results' : 'search-no-results';
- }
- if ( is_paged() ) {
- $classes[] = 'paged';
- }
- if ( is_attachment() ) {
- $classes[] = 'attachment';
- }
- if ( is_404() ) {
- $classes[] = 'error404';
- }
- if ( is_singular() ) {
- $post_id = $wp_query->get_queried_object_id();
- $post = $wp_query->get_queried_object();
- $post_type = $post->post_type;
- if ( is_page_template() ) {
- $classes[] = "{$post_type}-template";
- $template_slug = get_page_template_slug( $post_id );
- $template_parts = explode( '/', $template_slug );
- foreach ( $template_parts as $part ) {
- $classes[] = "{$post_type}-template-" . sanitize_html_class( str_replace( array( '.', '/' ), '-', basename( $part, '.php' ) ) );
- }
- $classes[] = "{$post_type}-template-" . sanitize_html_class( str_replace( '.', '-', $template_slug ) );
- } else {
- $classes[] = "{$post_type}-template-default";
- }
- if ( is_single() ) {
- $classes[] = 'single';
- if ( isset( $post->post_type ) ) {
- $classes[] = 'single-' . sanitize_html_class( $post->post_type, $post_id );
- $classes[] = 'postid-' . $post_id;
- // Post Format.
- if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
- $post_format = get_post_format( $post->ID );
- if ( $post_format && ! is_wp_error( $post_format ) ) {
- $classes[] = 'single-format-' . sanitize_html_class( $post_format );
- } else {
- $classes[] = 'single-format-standard';
- }
- }
- }
- }
- if ( is_attachment() ) {
- $mime_type = get_post_mime_type( $post_id );
- $mime_prefix = array( 'application/', 'image/', 'text/', 'audio/', 'video/', 'music/' );
- $classes[] = 'attachmentid-' . $post_id;
- $classes[] = 'attachment-' . str_replace( $mime_prefix, '', $mime_type );
- } elseif ( is_page() ) {
- $classes[] = 'page';
- $page_id = $wp_query->get_queried_object_id();
- $post = get_post( $page_id );
- $classes[] = 'page-id-' . $page_id;
- if ( get_pages(
- array(
- 'parent' => $page_id,
- 'number' => 1,
- )
- ) ) {
- $classes[] = 'page-parent';
- }
- if ( $post->post_parent ) {
- $classes[] = 'page-child';
- $classes[] = 'parent-pageid-' . $post->post_parent;
- }
- }
- } elseif ( is_archive() ) {
- if ( is_post_type_archive() ) {
- $classes[] = 'post-type-archive';
- $post_type = get_query_var( 'post_type' );
- if ( is_array( $post_type ) ) {
- $post_type = reset( $post_type );
- }
- $classes[] = 'post-type-archive-' . sanitize_html_class( $post_type );
- } elseif ( is_author() ) {
- $author = $wp_query->get_queried_object();
- $classes[] = 'author';
- if ( isset( $author->user_nicename ) ) {
- $classes[] = 'author-' . sanitize_html_class( $author->user_nicename, $author->ID );
- $classes[] = 'author-' . $author->ID;
- }
- } elseif ( is_category() ) {
- $cat = $wp_query->get_queried_object();
- $classes[] = 'category';
- if ( isset( $cat->term_id ) ) {
- $cat_class = sanitize_html_class( $cat->slug, $cat->term_id );
- if ( is_numeric( $cat_class ) || ! trim( $cat_class, '-' ) ) {
- $cat_class = $cat->term_id;
- }
- $classes[] = 'category-' . $cat_class;
- $classes[] = 'category-' . $cat->term_id;
- }
- } elseif ( is_tag() ) {
- $tag = $wp_query->get_queried_object();
- $classes[] = 'tag';
- if ( isset( $tag->term_id ) ) {
- $tag_class = sanitize_html_class( $tag->slug, $tag->term_id );
- if ( is_numeric( $tag_class ) || ! trim( $tag_class, '-' ) ) {
- $tag_class = $tag->term_id;
- }
- $classes[] = 'tag-' . $tag_class;
- $classes[] = 'tag-' . $tag->term_id;
- }
- } elseif ( is_tax() ) {
- $term = $wp_query->get_queried_object();
- if ( isset( $term->term_id ) ) {
- $term_class = sanitize_html_class( $term->slug, $term->term_id );
- if ( is_numeric( $term_class ) || ! trim( $term_class, '-' ) ) {
- $term_class = $term->term_id;
- }
- $classes[] = 'tax-' . sanitize_html_class( $term->taxonomy );
- $classes[] = 'term-' . $term_class;
- $classes[] = 'term-' . $term->term_id;
- }
- }
- }
- if ( is_user_logged_in() ) {
- $classes[] = 'logged-in';
- }
- if ( is_admin_bar_showing() ) {
- $classes[] = 'admin-bar';
- $classes[] = 'no-customize-support';
- }
- if ( current_theme_supports( 'custom-background' )
- && ( get_background_color() !== get_theme_support( 'custom-background', 'default-color' ) || get_background_image() ) ) {
- $classes[] = 'custom-background';
- }
- if ( has_custom_logo() ) {
- $classes[] = 'wp-custom-logo';
- }
- if ( current_theme_supports( 'responsive-embeds' ) ) {
- $classes[] = 'wp-embed-responsive';
- }
- $page = $wp_query->get( 'page' );
- if ( ! $page || $page < 2 ) {
- $page = $wp_query->get( 'paged' );
- }
- if ( $page && $page > 1 && ! is_404() ) {
- $classes[] = 'paged-' . $page;
- if ( is_single() ) {
- $classes[] = 'single-paged-' . $page;
- } elseif ( is_page() ) {
- $classes[] = 'page-paged-' . $page;
- } elseif ( is_category() ) {
- $classes[] = 'category-paged-' . $page;
- } elseif ( is_tag() ) {
- $classes[] = 'tag-paged-' . $page;
- } elseif ( is_date() ) {
- $classes[] = 'date-paged-' . $page;
- } elseif ( is_author() ) {
- $classes[] = 'author-paged-' . $page;
- } elseif ( is_search() ) {
- $classes[] = 'search-paged-' . $page;
- } elseif ( is_post_type_archive() ) {
- $classes[] = 'post-type-paged-' . $page;
- }
- }
- if ( ! empty( $class ) ) {
- if ( ! is_array( $class ) ) {
- $class = preg_split( '#\s+#', $class );
- }
- $classes = array_merge( $classes, $class );
- } else {
- // Ensure that we always coerce class to being an array.
- $class = array();
- }
- $classes = array_map( 'esc_attr', $classes );
- /**
- * Filters the list of CSS body class names for the current post or page.
- *
- * @since 2.8.0
- *
- * @param string[] $classes An array of body class names.
- * @param string[] $class An array of additional class names added to the body.
- */
- $classes = apply_filters( 'body_class', $classes, $class );
- return array_unique( $classes );
- }
- /**
- * Determines whether the post requires password and whether a correct password has been provided.
- *
- * @since 2.7.0
- *
- * @param int|WP_Post|null $post An optional post. Global $post used if not provided.
- * @return bool false if a password is not required or the correct password cookie is present, true otherwise.
- */
- function post_password_required( $post = null ) {
- $post = get_post( $post );
- if ( empty( $post->post_password ) ) {
- /** This filter is documented in wp-includes/post-template.php */
- return apply_filters( 'post_password_required', false, $post );
- }
- if ( ! isset( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] ) ) {
- /** This filter is documented in wp-includes/post-template.php */
- return apply_filters( 'post_password_required', true, $post );
- }
- require_once ABSPATH . WPINC . '/class-phpass.php';
- $hasher = new PasswordHash( 8, true );
- $hash = wp_unslash( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] );
- if ( 0 !== strpos( $hash, '$P$B' ) ) {
- $required = true;
- } else {
- $required = ! $hasher->CheckPassword( $post->post_password, $hash );
- }
- /**
- * Filters whether a post requires the user to supply a password.
- *
- * @since 4.7.0
- *
- * @param bool $required Whether the user needs to supply a password. True if password has not been
- * provided or is incorrect, false if password has been supplied or is not required.
- * @param WP_Post $post Post object.
- */
- return apply_filters( 'post_password_required', $required, $post );
- }
- //
- // Page Template Functions for usage in Themes.
- //
- /**
- * The formatted output of a list of pages.
- *
- * Displays page links for paginated posts (i.e. including the `<!--nextpage-->`
- * Quicktag one or more times). This tag must be within The Loop.
- *
- * @since 1.2.0
- * @since 5.1.0 Added the `aria_current` argument.
- *
- * @global int $page
- * @global int $numpages
- * @global int $multipage
- * @global int $more
- *
- * @param string|array $args {
- * Optional. Array or string of default arguments.
- *
- * @type string $before HTML or text to prepend to each link. Default is `<p> Pages:`.
- * @type string $after HTML or text to append to each link. Default is `</p>`.
- * @type string $link_before HTML or text to prepend to each link, inside the `<a>` tag.
- * Also prepended to the current item, which is not linked. Default empty.
- * @type string $link_after HTML or text to append to each Pages link inside the `<a>` tag.
- * Also appended to the current item, which is not linked. Default empty.
- * @type string $aria_current The value for the aria-current attribute. Possible values are 'page',
- * 'step', 'location', 'date', 'time', 'true', 'false'. Default is 'page'.
- * @type string $next_or_number Indicates whether page numbers should be used. Valid values are number
- * and next. Default is 'number'.
- * @type string $separator Text between pagination links. Default is ' '.
- * @type string $nextpagelink Link text for the next page link, if available. Default is 'Next Page'.
- * @type string $previouspagelink Link text for the previous page link, if available. Default is 'Previous Page'.
- * @type string $pagelink Format string for page numbers. The % in the parameter string will be
- * replaced with the page number, so 'Page %' generates "Page 1", "Page 2", etc.
- * Defaults to '%', just the page number.
- * @type int|bool $echo Whether to echo or not. Accepts 1|true or 0|false. Default 1|true.
- * }
- * @return string Formatted output in HTML.
- */
- function wp_link_pages( $args = '' ) {
- global $page, $numpages, $multipage, $more;
- $defaults = array(
- 'before' => '<p class="post-nav-links">' . __( 'Pages:' ),
- 'after' => '</p>',
- 'link_before' => '',
- 'link_after' => '',
- 'aria_current' => 'page',
- 'next_or_number' => 'number',
- 'separator' => ' ',
- 'nextpagelink' => __( 'Next page' ),
- 'previouspagelink' => __( 'Previous page' ),
- 'pagelink' => '%',
- 'echo' => 1,
- );
- $parsed_args = wp_parse_args( $args, $defaults );
- /**
- * Filters the arguments used in retrieving page links for paginated posts.
- *
- * @since 3.0.0
- *
- * @param array $parsed_args An array of page link arguments. See wp_link_pages()
- * for information on accepted arguments.
- */
- $parsed_args = apply_filters( 'wp_link_pages_args', $parsed_args );
- $output = '';
- if ( $multipage ) {
- if ( 'number' === $parsed_args['next_or_number'] ) {
- $output .= $parsed_args['before'];
- for ( $i = 1; $i <= $numpages; $i++ ) {
- $link = $parsed_args['link_before'] . str_replace( '%', $i, $parsed_args['pagelink'] ) . $parsed_args['link_after'];
- if ( $i != $page || ! $more && 1 == $page ) {
- $link = _wp_link_page( $i ) . $link . '</a>';
- } elseif ( $i === $page ) {
- $link = '<span class="post-page-numbers current" aria-current="' . esc_attr( $parsed_args['aria_current'] ) . '">' . $link . '</span>';
- }
- /**
- * Filters the HTML output of individual page number links.
- *
- * @since 3.6.0
- *
- * @param string $link The page number HTML output.
- * @param int $i Page number for paginated posts' page links.
- */
- $link = apply_filters( 'wp_link_pages_link', $link, $i );
- // Use the custom links separator beginning with the second link.
- $output .= ( 1 === $i ) ? ' ' : $parsed_args['separator'];
- $output .= $link;
- }
- $output .= $parsed_args['after'];
- } elseif ( $more ) {
- $output .= $parsed_args['before'];
- $prev = $page - 1;
- if ( $prev > 0 ) {
- $link = _wp_link_page( $prev ) . $parsed_args['link_before'] . $parsed_args['previouspagelink'] . $parsed_args['link_after'] . '</a>';
- /** This filter is documented in wp-includes/post-template.php */
- $output .= apply_filters( 'wp_link_pages_link', $link, $prev );
- }
- $next = $page + 1;
- if ( $next <= $numpages ) {
- if ( $prev ) {
- $output .= $parsed_args['separator'];
- }
- $link = _wp_link_page( $next ) . $parsed_args['link_before'] . $parsed_args['nextpagelink'] . $parsed_args['link_after'] . '</a>';
- /** This filter is documented in wp-includes/post-template.php */
- $output .= apply_filters( 'wp_link_pages_link', $link, $next );
- }
- $output .= $parsed_args['after'];
- }
- }
- /**
- * Filters the HTML output of page links for paginated posts.
- *
- * @since 3.6.0
- *
- * @param string $output HTML output of paginated posts' page links.
- * @param array|string $args An array or query string of arguments. See wp_link_pages()
- * for information on accepted arguments.
- */
- $html = apply_filters( 'wp_link_pages', $output, $args );
- if ( $parsed_args['echo'] ) {
- echo $html;
- }
- return $html;
- }
- /**
- * Helper function for wp_link_pages().
- *
- * @since 3.1.0
- * @access private
- *
- * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
- *
- * @param int $i Page number.
- * @return string Link.
- */
- function _wp_link_page( $i ) {
- global $wp_rewrite;
- $post = get_post();
- $query_args = array();
- if ( 1 == $i ) {
- $url = get_permalink();
- } else {
- if ( ! get_option( 'permalink_structure' ) || in_array( $post->post_status, array( 'draft', 'pending' ), true ) ) {
- $url = add_query_arg( 'page', $i, get_permalink() );
- } elseif ( 'page' === get_option( 'show_on_front' ) && get_option( 'page_on_front' ) == $post->ID ) {
- $url = trailingslashit( get_permalink() ) . user_trailingslashit( "$wp_rewrite->pagination_base/" . $i, 'single_paged' );
- } else {
- $url = trailingslashit( get_permalink() ) . user_trailingslashit( $i, 'single_paged' );
- }
- }
- if ( is_preview() ) {
- if ( ( 'draft' !== $post->post_status ) && isset( $_GET['preview_id'], $_GET['preview_nonce'] ) ) {
- $query_args['preview_id'] = wp_unslash( $_GET['preview_id'] );
- $query_args['preview_nonce'] = wp_unslash( $_GET['preview_nonce'] );
- }
- $url = get_preview_post_link( $post, $query_args, $url );
- }
- return '<a href="' . esc_url( $url ) . '" class="post-page-numbers">';
- }
- //
- // Post-meta: Custom per-post fields.
- //
- /**
- * Retrieves post custom meta data field.
- *
- * @since 1.5.0
- *
- * @param string $key Meta data key name.
- * @return array|string|false Array of values, or single value if only one element exists.
- * False if the key does not exist.
- */
- function post_custom( $key = '' ) {
- $custom = get_post_custom();
- if ( ! isset( $custom[ $key ] ) ) {
- return false;
- } elseif ( 1 === count( $custom[ $key ] ) ) {
- return $custom[ $key ][0];
- } else {
- return $custom[ $key ];
- }
- }
- /**
- * Displays a list of post custom fields.
- *
- * @since 1.2.0
- *
- * @deprecated 6.0.2 Use get_post_meta() to retrieve post meta and render manually.
- */
- function the_meta() {
- _deprecated_function( __FUNCTION__, '6.0.2', 'get_post_meta()' );
- $keys = get_post_custom_keys();
- if ( $keys ) {
- $li_html = '';
- foreach ( (array) $keys as $key ) {
- $keyt = trim( $key );
- if ( is_protected_meta( $keyt, 'post' ) ) {
- continue;
- }
- $values = array_map( 'trim', get_post_custom_values( $key ) );
- $value = implode( ', ', $values );
- $html = sprintf(
- "<li><span class='post-meta-key'>%s</span> %s</li>\n",
- /* translators: %s: Post custom field name. */
- esc_html( sprintf( _x( '%s:', 'Post custom field name' ), $key ) ),
- esc_html( $value )
- );
- /**
- * Filters the HTML output of the li element in the post custom fields list.
- *
- * @since 2.2.0
- *
- * @param string $html The HTML output for the li element.
- * @param string $key Meta key.
- * @param string $value Meta value.
- */
- $li_html .= apply_filters( 'the_meta_key', $html, $key, $value );
- }
- if ( $li_html ) {
- echo "<ul class='post-meta'>\n{$li_html}</ul>\n";
- }
- }
- }
- //
- // Pages.
- //
- /**
- * Retrieves or displays a list of pages as a dropdown (select list).
- *
- * @since 2.1.0
- * @since 4.2.0 The `$value_field` argument was added.
- * @since 4.3.0 The `$class` argument was added.
- *
- * @see get_pages()
- *
- * @param array|string $args {
- * Optional. Array or string of arguments to generate a page dropdown. See get_pages() for additional arguments.
- *
- * @type int $depth Maximum depth. Default 0.
- * @type int $child_of Page ID to retrieve child pages of. Default 0.
- * @type int|string $selected Value of the option that should be selected. Default 0.
- * @type bool|int $echo Whether to echo or return the generated markup. Accepts 0, 1,
- * or their bool equivalents. Default 1.
- * @type string $name Value for the 'name' attribute of the select element.
- * Default 'page_id'.
- * @type string $id Value for the 'id' attribute of the select element.
- * @type string $class Value for the 'class' attribute of the select element. Default: none.
- * Defaults to the value of `$name`.
- * @type string $show_option_none Text to display for showing no pages. Default empty (does not display).
- * @type string $show_option_no_change Text to display for "no change" option. Default empty (does not display).
- * @type string $option_none_value Value to use when no page is selected. Default empty.
- * @type string $value_field Post field used to populate the 'value' attribute of the option
- * elements. Accepts any valid post field. Default 'ID'.
- * }
- * @return string HTML dropdown list of pages.
- */
- function wp_dropdown_pages( $args = '' ) {
- $defaults = array(
- 'depth' => 0,
- 'child_of' => 0,
- 'selected' => 0,
- 'echo' => 1,
- 'name' => 'page_id',
- 'id' => '',
- 'class' => '',
- 'show_option_none' => '',
- 'show_option_no_change' => '',
- 'option_none_value' => '',
- 'value_field' => 'ID',
- );
- $parsed_args = wp_parse_args( $args, $defaults );
- $pages = get_pages( $parsed_args );
- $output = '';
- // Back-compat with old system where both id and name were based on $name argument.
- if ( empty( $parsed_args['id'] ) ) {
- $parsed_args['id'] = $parsed_args['name'];
- }
- if ( ! empty( $pages ) ) {
- $class = '';
- if ( ! empty( $parsed_args['class'] ) ) {
- $class = " class='" . esc_attr( $parsed_args['class'] ) . "'";
- }
- $output = "<select name='" . esc_attr( $parsed_args['name'] ) . "'" . $class . " id='" . esc_attr( $parsed_args['id'] ) . "'>\n";
- if ( $parsed_args['show_option_no_change'] ) {
- $output .= "\t<option value=\"-1\">" . $parsed_args['show_option_no_change'] . "</option>\n";
- }
- if ( $parsed_args['show_option_none'] ) {
- $output .= "\t<option value=\"" . esc_attr( $parsed_args['option_none_value'] ) . '">' . $parsed_args['show_option_none'] . "</option>\n";
- }
- $output .= walk_page_dropdown_tree( $pages, $parsed_args['depth'], $parsed_args );
- $output .= "</select>\n";
- }
- /**
- * Filters the HTML output of a list of pages as a dropdown.
- *
- * @since 2.1.0
- * @since 4.4.0 `$parsed_args` and `$pages` added as arguments.
- *
- * @param string $output HTML output for dropdown list of pages.
- * @param array $parsed_args The parsed arguments array. See wp_dropdown_pages()
- * for information on accepted arguments.
- * @param WP_Post[] $pages Array of the page objects.
- */
- $html = apply_filters( 'wp_dropdown_pages', $output, $parsed_args, $pages );
- if ( $parsed_args['echo'] ) {
- echo $html;
- }
- return $html;
- }
- /**
- * Retrieves or displays a list of pages (or hierarchical post type items) in list (li) format.
- *
- * @since 1.5.0
- * @since 4.7.0 Added the `item_spacing` argument.
- *
- * @see get_pages()
- *
- * @global WP_Query $wp_query WordPress Query object.
- *
- * @param array|string $args {
- * Optional. Array or string of arguments to generate a list of pages. See get_pages() for additional arguments.
- *
- * @type int $child_of Display only the sub-pages of a single page by ID. Default 0 (all pages).
- * @type string $authors Comma-separated list of author IDs. Default empty (all authors).
- * @type string $date_format PHP date format to use for the listed pages. Relies on the 'show_date' parameter.
- * Default is the value of 'date_format' option.
- * @type int $depth Number of levels in the hierarchy of pages to include in the generated list.
- * Accepts -1 (any depth), 0 (all pages), 1 (top-level pages only), and n (pages to
- * the given n depth). Default 0.
- * @type bool $echo Whether or not to echo the list of pages. Default true.
- * @type string $exclude Comma-separated list of page IDs to exclude. Default empty.
- * @type array $include Comma-separated list of page IDs to include. Default empty.
- * @type string $link_after Text or HTML to follow the page link label. Default null.
- * @type string $link_before Text or HTML to precede the page link label. Default null.
- * @type string $post_type Post type to query for. Default 'page'.
- * @type string|array $post_status Comma-separated list or array of post statuses to include. Default 'publish'.
- * @type string $show_date Whether to display the page publish or modified date for each page. Accepts
- * 'modified' or any other value. An empty value hides the date. Default empty.
- * @type string $sort_column Comma-separated list of column names to sort the pages by. Accepts 'post_author',
- * 'post_date', 'post_title', 'post_name', 'post_modified', 'post_modified_gmt',
- * 'menu_order', 'post_parent', 'ID', 'rand', or 'comment_count'. Default 'post_title'.
- * @type string $title_li List heading. Passing a null or empty value will result in no heading, and the list
- * will not be wrapped with unordered list `<ul>` tags. Default 'Pages'.
- * @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'.
- * Default 'preserve'.
- * @type Walker $walker Walker instance to use for listing pages. Default empty which results in a
- * Walker_Page instance being used.
- * }
- * @return void|string Void if 'echo' argument is true, HTML list of pages if 'echo' is false.
- */
- function wp_list_pages( $args = '' ) {
- $defaults = array(
- 'depth' => 0,
- 'show_date' => '',
- 'date_format' => get_option( 'date_format' ),
- 'child_of' => 0,
- 'exclude' => '',
- 'title_li' => __( 'Pages' ),
- 'echo' => 1,
- 'authors' => '',
- 'sort_column' => 'menu_order, post_title',
- 'link_before' => '',
- 'link_after' => '',
- 'item_spacing' => 'preserve',
- 'walker' => '',
- );
- $parsed_args = wp_parse_args( $args, $defaults );
- if ( ! in_array( $parsed_args['item_spacing'], array( 'preserve', 'discard' ), true ) ) {
- // Invalid value, fall back to default.
- $parsed_args['item_spacing'] = $defaults['item_spacing'];
- }
- $output = '';
- $current_page = 0;
- // Sanitize, mostly to keep spaces out.
- $parsed_args['exclude'] = preg_replace( '/[^0-9,]/', '', $parsed_args['exclude'] );
- // Allow plugins to filter an array of excluded pages (but don't put a nullstring into the array).
- $exclude_array = ( $parsed_args['exclude'] ) ? explode( ',', $parsed_args['exclude'] ) : array();
- /**
- * Filters the array of pages to exclude from the pages list.
- *
- * @since 2.1.0
- *
- * @param string[] $exclude_array An array of page IDs to exclude.
- */
- $parsed_args['exclude'] = implode( ',', apply_filters( 'wp_list_pages_excludes', $exclude_array ) );
- $parsed_args['hierarchical'] = 0;
- // Query pages.
- $pages = get_pages( $parsed_args );
- if ( ! empty( $pages ) ) {
- if ( $parsed_args['title_li'] ) {
- $output .= '<li class="pagenav">' . $parsed_args['title_li'] . '<ul>';
- }
- global $wp_query;
- if ( is_page() || is_attachment() || $wp_query->is_posts_page ) {
- $current_page = get_queried_object_id();
- } elseif ( is_singular() ) {
- $queried_object = get_queried_object();
- if ( is_post_type_hierarchical( $queried_object->post_type ) ) {
- $current_page = $queried_object->ID;
- }
- }
- $output .= walk_page_tree( $pages, $parsed_args['depth'], $current_page, $parsed_args );
- if ( $parsed_args['title_li'] ) {
- $output .= '</ul></li>';
- }
- }
- /**
- * Filters the HTML output of the pages to list.
- *
- * @since 1.5.1
- * @since 4.4.0 `$pages` added as arguments.
- *
- * @see wp_list_pages()
- *
- * @param string $output HTML output of the pages list.
- * @param array $parsed_args An array of page-listing arguments. See wp_list_pages()
- * for information on accepted arguments.
- * @param WP_Post[] $pages Array of the page objects.
- */
- $html = apply_filters( 'wp_list_pages', $output, $parsed_args, $pages );
- if ( $parsed_args['echo'] ) {
- echo $html;
- } else {
- return $html;
- }
- }
- /**
- * Displays or retrieves a list of pages with an optional home link.
- *
- * The arguments are listed below and part of the arguments are for wp_list_pages() function.
- * Check that function for more info on those arguments.
- *
- * @since 2.7.0
- * @since 4.4.0 Added `menu_id`, `container`, `before`, `after`, and `walker` arguments.
- * @since 4.7.0 Added the `item_spacing` argument.
- *
- * @param array|string $args {
- * Optional. Array or string of arguments to generate a page menu. See wp_list_pages() for additional arguments.
- *
- * @type string $sort_column How to sort the list of pages. Accepts post column names.
- * Default 'menu_order, post_title'.
- * @type string $menu_id ID for the div containing the page list. Default is empty string.
- * @type string $menu_class Class to use for the element containing the page list. Default 'menu'.
- * @type string $container Element to use for the element containing the page list. Default 'div'.
- * @type bool $echo Whether to echo the list or return it. Accepts true (echo) or false (return).
- * Default true.
- * @type int|bool|string $show_home Whether to display the link to the home page. Can just enter the text
- * you'd like shown for the home link. 1|true defaults to 'Home'.
- * @type string $link_before The HTML or text to prepend to $show_home text. Default empty.
- * @type string $link_after The HTML or text to append to $show_home text. Default empty.
- * @type string $before The HTML or text to prepend to the menu. Default is '<ul>'.
- * @type string $after The HTML or text to append to the menu. Default is '</ul>'.
- * @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve'
- * or 'discard'. Default 'discard'.
- * @type Walker $walker Walker instance to use for listing pages. Default empty which results in a
- * Walker_Page instance being used.
- * }
- * @return void|string Void if 'echo' argument is true, HTML menu if 'echo' is false.
- */
- function wp_page_menu( $args = array() ) {
- $defaults = array(
- 'sort_column' => 'menu_order, post_title',
- 'menu_id' => '',
- 'menu_class' => 'menu',
- 'container' => 'div',
- 'echo' => true,
- 'link_before' => '',
- 'link_after' => '',
- 'before' => '<ul>',
- 'after' => '</ul>',
- 'item_spacing' => 'discard',
- 'walker' => '',
- );
- $args = wp_parse_args( $args, $defaults );
- if ( ! in_array( $args['item_spacing'], array( 'preserve', 'discard' ), true ) ) {
- // Invalid value, fall back to default.
- $args['item_spacing'] = $defaults['item_spacing'];
- }
- if ( 'preserve' === $args['item_spacing'] ) {
- $t = "\t";
- $n = "\n";
- } else {
- $t = '';
- $n = '';
- }
- /**
- * Filters the arguments used to generate a page-based menu.
- *
- * @since 2.7.0
- *
- * @see wp_page_menu()
- *
- * @param array $args An array of page menu arguments. See wp_page_menu()
- * for information on accepted arguments.
- */
- $args = apply_filters( 'wp_page_menu_args', $args );
- $menu = '';
- $list_args = $args;
- // Show Home in the menu.
- if ( ! empty( $args['show_home'] ) ) {
- if ( true === $args['show_home'] || '1' === $args['show_home'] || 1 === $args['show_home'] ) {
- $text = __( 'Home' );
- } else {
- $text = $args['show_home'];
- }
- $class = '';
- if ( is_front_page() && ! is_paged() ) {
- $class = 'class="current_page_item"';
- }
- $menu .= '<li ' . $class . '><a href="' . esc_url( home_url( '/' ) ) . '">' . $args['link_before'] . $text . $args['link_after'] . '</a></li>';
- // If the front page is a page, add it to the exclude list.
- if ( 'page' === get_option( 'show_on_front' ) ) {
- if ( ! empty( $list_args['exclude'] ) ) {
- $list_args['exclude'] .= ',';
- } else {
- $list_args['exclude'] = '';
- }
- $list_args['exclude'] .= get_option( 'page_on_front' );
- }
- }
- $list_args['echo'] = false;
- $list_args['title_li'] = '';
- $menu .= wp_list_pages( $list_args );
- $container = sanitize_text_field( $args['container'] );
- // Fallback in case `wp_nav_menu()` was called without a container.
- if ( empty( $container ) ) {
- $container = 'div';
- }
- if ( $menu ) {
- // wp_nav_menu() doesn't set before and after.
- if ( isset( $args['fallback_cb'] ) &&
- 'wp_page_menu' === $args['fallback_cb'] &&
- 'ul' !== $container ) {
- $args['before'] = "<ul>{$n}";
- $args['after'] = '</ul>';
- }
- $menu = $args['before'] . $menu . $args['after'];
- }
- $attrs = '';
- if ( ! empty( $args['menu_id'] ) ) {
- $attrs .= ' id="' . esc_attr( $args['menu_id'] ) . '"';
- }
- if ( ! empty( $args['menu_class'] ) ) {
- $attrs .= ' class="' . esc_attr( $args['menu_class'] ) . '"';
- }
- $menu = "<{$container}{$attrs}>" . $menu . "</{$container}>{$n}";
- /**
- * Filters the HTML output of a page-based menu.
- *
- * @since 2.7.0
- *
- * @see wp_page_menu()
- *
- * @param string $menu The HTML output.
- * @param array $args An array of arguments. See wp_page_menu()
- * for information on accepted arguments.
- */
- $menu = apply_filters( 'wp_page_menu', $menu, $args );
- if ( $args['echo'] ) {
- echo $menu;
- } else {
- return $menu;
- }
- }
- //
- // Page helpers.
- //
- /**
- * Retrieves HTML list content for page list.
- *
- * @uses Walker_Page to create HTML list content.
- * @since 2.1.0
- *
- * @param array $pages
- * @param int $depth
- * @param int $current_page
- * @param array $args
- * @return string
- */
- function walk_page_tree( $pages, $depth, $current_page, $args ) {
- if ( empty( $args['walker'] ) ) {
- $walker = new Walker_Page;
- } else {
- /**
- * @var Walker $walker
- */
- $walker = $args['walker'];
- }
- foreach ( (array) $pages as $page ) {
- if ( $page->post_parent ) {
- $args['pages_with_children'][ $page->post_parent ] = true;
- }
- }
- return $walker->walk( $pages, $depth, $args, $current_page );
- }
- /**
- * Retrieves HTML dropdown (select) content for page list.
- *
- * @since 2.1.0
- * @since 5.3.0 Formalized the existing `...$args` parameter by adding it
- * to the function signature.
- *
- * @uses Walker_PageDropdown to create HTML dropdown content.
- * @see Walker_PageDropdown::walk() for parameters and return description.
- *
- * @param mixed ...$args Elements array, maximum hierarchical depth and optional additional arguments.
- * @return string
- */
- function walk_page_dropdown_tree( ...$args ) {
- if ( empty( $args[2]['walker'] ) ) { // The user's options are the third parameter.
- $walker = new Walker_PageDropdown;
- } else {
- /**
- * @var Walker $walker
- */
- $walker = $args[2]['walker'];
- }
- return $walker->walk( ...$args );
- }
- //
- // Attachments.
- //
- /**
- * Displays an attachment page link using an image or icon.
- *
- * @since 2.0.0
- *
- * @param int|WP_Post $post Optional. Post ID or post object.
- * @param bool $fullsize Optional. Whether to use full size. Default false.
- * @param bool $deprecated Deprecated. Not used.
- * @param bool $permalink Optional. Whether to include permalink. Default false.
- */
- function the_attachment_link( $post = 0, $fullsize = false, $deprecated = false, $permalink = false ) {
- if ( ! empty( $deprecated ) ) {
- _deprecated_argument( __FUNCTION__, '2.5.0' );
- }
- if ( $fullsize ) {
- echo wp_get_attachment_link( $post, 'full', $permalink );
- } else {
- echo wp_get_attachment_link( $post, 'thumbnail', $permalink );
- }
- }
- /**
- * Retrieves an attachment page link using an image or icon, if possible.
- *
- * @since 2.5.0
- * @since 4.4.0 The `$post` parameter can now accept either a post ID or `WP_Post` object.
- *
- * @param int|WP_Post $post Optional. Post ID or post object.
- * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array
- * of width and height values in pixels (in that order). Default 'thumbnail'.
- * @param bool $permalink Optional. Whether to add permalink to image. Default false.
- * @param bool $icon Optional. Whether the attachment is an icon. Default false.
- * @param string|false $text Optional. Link text to use. Activated by passing a string, false otherwise.
- * Default false.
- * @param array|string $attr Optional. Array or string of attributes. Default empty.
- * @return string HTML content.
- */
- function wp_get_attachment_link( $post = 0, $size = 'thumbnail', $permalink = false, $icon = false, $text = false, $attr = '' ) {
- $_post = get_post( $post );
- if ( empty( $_post ) || ( 'attachment' !== $_post->post_type ) || ! wp_get_attachment_url( $_post->ID ) ) {
- return __( 'Missing Attachment' );
- }
- $url = wp_get_attachment_url( $_post->ID );
- if ( $permalink ) {
- $url = get_attachment_link( $_post->ID );
- }
- if ( $text ) {
- $link_text = $text;
- } elseif ( $size && 'none' !== $size ) {
- $link_text = wp_get_attachment_image( $_post->ID, $size, $icon, $attr );
- } else {
- $link_text = '';
- }
- if ( '' === trim( $link_text ) ) {
- $link_text = $_post->post_title;
- }
- if ( '' === trim( $link_text ) ) {
- $link_text = esc_html( pathinfo( get_attached_file( $_post->ID ), PATHINFO_FILENAME ) );
- }
- $link_html = "<a href='" . esc_url( $url ) . "'>$link_text</a>";
- /**
- * Filters a retrieved attachment page link.
- *
- * @since 2.7.0
- * @since 5.1.0 Added the `$attr` parameter.
- *
- * @param string $link_html The page link HTML output.
- * @param int|WP_Post $post Post ID or object. Can be 0 for the current global post.
- * @param string|int[] $size Requested image size. Can be any registered image size name, or
- * an array of width and height values in pixels (in that order).
- * @param bool $permalink Whether to add permalink to image. Default false.
- * @param bool $icon Whether to include an icon.
- * @param string|false $text If string, will be link text.
- * @param array|string $attr Array or string of attributes.
- */
- return apply_filters( 'wp_get_attachment_link', $link_html, $post, $size, $permalink, $icon, $text, $attr );
- }
- /**
- * Wraps attachment in paragraph tag before content.
- *
- * @since 2.0.0
- *
- * @param string $content
- * @return string
- */
- function prepend_attachment( $content ) {
- $post = get_post();
- if ( empty( $post->post_type ) || 'attachment' !== $post->post_type ) {
- return $content;
- }
- if ( wp_attachment_is( 'video', $post ) ) {
- $meta = wp_get_attachment_metadata( get_the_ID() );
- $atts = array( 'src' => wp_get_attachment_url() );
- if ( ! empty( $meta['width'] ) && ! empty( $meta['height'] ) ) {
- $atts['width'] = (int) $meta['width'];
- $atts['height'] = (int) $meta['height'];
- }
- if ( has_post_thumbnail() ) {
- $atts['poster'] = wp_get_attachment_url( get_post_thumbnail_id() );
- }
- $p = wp_video_shortcode( $atts );
- } elseif ( wp_attachment_is( 'audio', $post ) ) {
- $p = wp_audio_shortcode( array( 'src' => wp_get_attachment_url() ) );
- } else {
- $p = '<p class="attachment">';
- // Show the medium sized image representation of the attachment if available, and link to the raw file.
- $p .= wp_get_attachment_link( 0, 'medium', false );
- $p .= '</p>';
- }
- /**
- * Filters the attachment markup to be prepended to the post content.
- *
- * @since 2.0.0
- *
- * @see prepend_attachment()
- *
- * @param string $p The attachment HTML output.
- */
- $p = apply_filters( 'prepend_attachment', $p );
- return "$p\n$content";
- }
- //
- // Misc.
- //
- /**
- * Retrieves protected post password form content.
- *
- * @since 1.0.0
- *
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
- * @return string HTML content for password form for password protected post.
- */
- function get_the_password_form( $post = 0 ) {
- $post = get_post( $post );
- $label = 'pwbox-' . ( empty( $post->ID ) ? rand() : $post->ID );
- $output = '<form action="' . esc_url( site_url( 'wp-login.php?action=postpass', 'login_post' ) ) . '" class="post-password-form" method="post">
- <p>' . __( 'This content is password protected. To view it please enter your password below:' ) . '</p>
- <p><label for="' . $label . '">' . __( 'Password:' ) . ' <input name="post_password" id="' . $label . '" type="password" size="20" /></label> <input type="submit" name="Submit" value="' . esc_attr_x( 'Enter', 'post password form' ) . '" /></p></form>
- ';
- /**
- * Filters the HTML output for the protected post password form.
- *
- * If modifying the password field, please note that the core database schema
- * limits the password field to 20 characters regardless of the value of the
- * size attribute in the form input.
- *
- * @since 2.7.0
- * @since 5.8.0 Added the `$post` parameter.
- *
- * @param string $output The password form HTML output.
- * @param WP_Post $post Post object.
- */
- return apply_filters( 'the_password_form', $output, $post );
- }
- /**
- * Determines whether the current post uses a page template.
- *
- * This template tag allows you to determine if you are in a page template.
- * You can optionally provide a template filename or array of template filenames
- * and then the check will be specific to that template.
- *
- * For more information on this and similar theme functions, check out
- * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
- * Conditional Tags} article in the Theme Developer Handbook.
- *
- * @since 2.5.0
- * @since 4.2.0 The `$template` parameter was changed to also accept an array of page templates.
- * @since 4.7.0 Now works with any post type, not just pages.
- *
- * @param string|string[] $template The specific template filename or array of templates to match.
- * @return bool True on success, false on failure.
- */
- function is_page_template( $template = '' ) {
- if ( ! is_singular() ) {
- return false;
- }
- $page_template = get_page_template_slug( get_queried_object_id() );
- if ( empty( $template ) ) {
- return (bool) $page_template;
- }
- if ( $template == $page_template ) {
- return true;
- }
- if ( is_array( $template ) ) {
- if ( ( in_array( 'default', $template, true ) && ! $page_template )
- || in_array( $page_template, $template, true )
- ) {
- return true;
- }
- }
- return ( 'default' === $template && ! $page_template );
- }
- /**
- * Gets the specific template filename for a given post.
- *
- * @since 3.4.0
- * @since 4.7.0 Now works with any post type, not just pages.
- *
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
- * @return string|false Page template filename. Returns an empty string when the default page template
- * is in use. Returns false if the post does not exist.
- */
- function get_page_template_slug( $post = null ) {
- $post = get_post( $post );
- if ( ! $post ) {
- return false;
- }
- $template = get_post_meta( $post->ID, '_wp_page_template', true );
- if ( ! $template || 'default' === $template ) {
- return '';
- }
- return $template;
- }
- /**
- * Retrieves formatted date timestamp of a revision (linked to that revisions's page).
- *
- * @since 2.6.0
- *
- * @param int|object $revision Revision ID or revision object.
- * @param bool $link Optional. Whether to link to revision's page. Default true.
- * @return string|false i18n formatted datetimestamp or localized 'Current Revision'.
- */
- function wp_post_revision_title( $revision, $link = true ) {
- $revision = get_post( $revision );
- if ( ! $revision ) {
- return $revision;
- }
- if ( ! in_array( $revision->post_type, array( 'post', 'page', 'revision' ), true ) ) {
- return false;
- }
- /* translators: Revision date format, see https://www.php.net/manual/datetime.format.php */
- $datef = _x( 'F j, Y @ H:i:s', 'revision date format' );
- /* translators: %s: Revision date. */
- $autosavef = __( '%s [Autosave]' );
- /* translators: %s: Revision date. */
- $currentf = __( '%s [Current Revision]' );
- $date = date_i18n( $datef, strtotime( $revision->post_modified ) );
- $edit_link = get_edit_post_link( $revision->ID );
- if ( $link && current_user_can( 'edit_post', $revision->ID ) && $edit_link ) {
- $date = "<a href='$edit_link'>$date</a>";
- }
- if ( ! wp_is_post_revision( $revision ) ) {
- $date = sprintf( $currentf, $date );
- } elseif ( wp_is_post_autosave( $revision ) ) {
- $date = sprintf( $autosavef, $date );
- }
- return $date;
- }
- /**
- * Retrieves formatted date timestamp of a revision (linked to that revisions's page).
- *
- * @since 3.6.0
- *
- * @param int|object $revision Revision ID or revision object.
- * @param bool $link Optional. Whether to link to revision's page. Default true.
- * @return string|false gravatar, user, i18n formatted datetimestamp or localized 'Current Revision'.
- */
- function wp_post_revision_title_expanded( $revision, $link = true ) {
- $revision = get_post( $revision );
- if ( ! $revision ) {
- return $revision;
- }
- if ( ! in_array( $revision->post_type, array( 'post', 'page', 'revision' ), true ) ) {
- return false;
- }
- $author = get_the_author_meta( 'display_name', $revision->post_author );
- /* translators: Revision date format, see https://www.php.net/manual/datetime.format.php */
- $datef = _x( 'F j, Y @ H:i:s', 'revision date format' );
- $gravatar = get_avatar( $revision->post_author, 24 );
- $date = date_i18n( $datef, strtotime( $revision->post_modified ) );
- $edit_link = get_edit_post_link( $revision->ID );
- if ( $link && current_user_can( 'edit_post', $revision->ID ) && $edit_link ) {
- $date = "<a href='$edit_link'>$date</a>";
- }
- $revision_date_author = sprintf(
- /* translators: Post revision title. 1: Author avatar, 2: Author name, 3: Time ago, 4: Date. */
- __( '%1$s %2$s, %3$s ago (%4$s)' ),
- $gravatar,
- $author,
- human_time_diff( strtotime( $revision->post_modified_gmt ) ),
- $date
- );
- /* translators: %s: Revision date with author avatar. */
- $autosavef = __( '%s [Autosave]' );
- /* translators: %s: Revision date with author avatar. */
- $currentf = __( '%s [Current Revision]' );
- if ( ! wp_is_post_revision( $revision ) ) {
- $revision_date_author = sprintf( $currentf, $revision_date_author );
- } elseif ( wp_is_post_autosave( $revision ) ) {
- $revision_date_author = sprintf( $autosavef, $revision_date_author );
- }
- /**
- * Filters the formatted author and date for a revision.
- *
- * @since 4.4.0
- *
- * @param string $revision_date_author The formatted string.
- * @param WP_Post $revision The revision object.
- * @param bool $link Whether to link to the revisions page, as passed into
- * wp_post_revision_title_expanded().
- */
- return apply_filters( 'wp_post_revision_title_expanded', $revision_date_author, $revision, $link );
- }
- /**
- * Displays a list of a post's revisions.
- *
- * Can output either a UL with edit links or a TABLE with diff interface, and
- * restore action links.
- *
- * @since 2.6.0
- *
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
- * @param string $type 'all' (default), 'revision' or 'autosave'
- */
- function wp_list_post_revisions( $post = 0, $type = 'all' ) {
- $post = get_post( $post );
- if ( ! $post ) {
- return;
- }
- // $args array with (parent, format, right, left, type) deprecated since 3.6.
- if ( is_array( $type ) ) {
- $type = ! empty( $type['type'] ) ? $type['type'] : $type;
- _deprecated_argument( __FUNCTION__, '3.6.0' );
- }
- $revisions = wp_get_post_revisions( $post->ID );
- if ( ! $revisions ) {
- return;
- }
- $rows = '';
- foreach ( $revisions as $revision ) {
- if ( ! current_user_can( 'read_post', $revision->ID ) ) {
- continue;
- }
- $is_autosave = wp_is_post_autosave( $revision );
- if ( ( 'revision' === $type && $is_autosave ) || ( 'autosave' === $type && ! $is_autosave ) ) {
- continue;
- }
- $rows .= "\t<li>" . wp_post_revision_title_expanded( $revision ) . "</li>\n";
- }
- echo "<div class='hide-if-js'><p>" . __( 'JavaScript must be enabled to use this feature.' ) . "</p></div>\n";
- echo "<ul class='post-revisions hide-if-no-js'>\n";
- echo $rows;
- echo '</ul>';
- }
- /**
- * Retrieves the parent post object for the given post.
- *
- * @since 5.7.0
- *
- * @param int|WP_Post|null $post Optional. Post ID or WP_Post object. Default is global $post.
- * @return WP_Post|null Parent post object, or null if there isn't one.
- */
- function get_post_parent( $post = null ) {
- $wp_post = get_post( $post );
- return ! empty( $wp_post->post_parent ) ? get_post( $wp_post->post_parent ) : null;
- }
- /**
- * Returns whether the given post has a parent post.
- *
- * @since 5.7.0
- *
- * @param int|WP_Post|null $post Optional. Post ID or WP_Post object. Default is global $post.
- * @return bool Whether the post has a parent post.
- */
- function has_post_parent( $post = null ) {
- return (bool) get_post_parent( $post );
- }
|