Skip to content

use current page and teaser for the description #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pfefferle merged 1 commit into from
Sep 18, 2026
Merged

use current page and teaser for the description #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion opengraph.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,7 @@ function opengraph_default_description( $description = '', $length = 55 ) {
} elseif ( ! empty( $post->post_excerpt ) ) {
$description = $post->post_excerpt;
} else {
$description = $post->post_content;
$description = opengraph_page_teaser( $post );
}
} elseif ( is_author() ) {
$id = get_queried_object_id();
Expand All @@ -639,6 +639,27 @@ function opengraph_default_description( $description = '', $length = 55 ) {
}


/**
* Get the content of the current page of a post, cut at the `<!--more-->` tag.
*
* Splits the content at `<!--nextpage-->` the same way core does for
* `get_the_content()`, so every page of a multipage post gets its own
* description. If the page has a `<!--more-->` tag, only the teaser before
* it is returned.
*
* @param WP_Post $post The post.
*
* @return string The content.
*/
function opengraph_page_teaser( $post ) {
$elements = generate_postdata( $post );
$page = min( max( 1, (int) $elements['page'] ), count( $elements['pages'] ) );
$content = $elements['pages'][ $page - 1 ];

return get_extended( $content )['main'];
}


/**
* Default locale property, using the WordPress locale.
*
Expand Down
42 changes: 42 additions & 0 deletions tests/phpunit/tests/class-test-opengraph.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,48 @@ public function test_description_from_content() {
$this->assertSame( implode( ' ', array_fill( 0, 55, 'word' ) ) . ' [...]', $metadata['og:description'] );
}

/**
* Test the description of a multipage post is taken from the current page.
*
* @see https://github.com/pfefferle/wordpress-opengraph/issues/9
*
* @covers ::opengraph_default_description
* @covers ::opengraph_page_teaser
*/
public function test_description_from_multipage_content() {
$post_id = self::factory()->post->create(
array(
'post_content' => '<!-- wp:paragraph --><p>First page</p><!-- /wp:paragraph --><!-- wp:nextpage --><!--nextpage--><!-- /wp:nextpage --><!-- wp:paragraph --><p>Second page</p><!-- /wp:paragraph -->',
'post_excerpt' => '',
)
);

$metadata = $this->metadata_for( get_permalink( $post_id ) );
$this->assertSame( 'First page', $metadata['og:description'] );

$metadata = $this->metadata_for( add_query_arg( 'page', 2, get_permalink( $post_id ) ) );
$this->assertSame( 'Second page', $metadata['og:description'] );
}

/**
* Test the description is cut at the more tag.
*
* @covers ::opengraph_default_description
* @covers ::opengraph_page_teaser
*/
public function test_description_from_teaser() {
$post_id = self::factory()->post->create(
array(
'post_content' => '<!-- wp:paragraph --><p>Teaser</p><!-- /wp:paragraph --><!-- wp:more --><!--more--><!-- /wp:more --><!-- wp:paragraph --><p>Rest</p><!-- /wp:paragraph -->',
'post_excerpt' => '',
)
);

$metadata = $this->metadata_for( get_permalink( $post_id ) );

$this->assertSame( 'Teaser', $metadata['og:description'] );
}

/**
* Test a password protected post exposes neither its content nor its images.
*
Expand Down
Loading