WordPress.org

Make WordPress Core

Opened 4 years ago

Closed 3 years ago

Last modified 3 years ago

#37752 closed enhancement (fixed)

Detail docs for embed_html, embed_content and embed_content_meta

Reported by: matthieuscarset Owned by: DrewAPicture
Milestone: 4.9 Priority: normal
Severity: normal Version: 4.4
Component: Embeds Keywords: good-first-bug has-patch
Focuses: docs Cc:

Description

I was trying to find the right action to customize the output of embed post and I found hard to understand which action I should use and how to use it in my plugin between.

I first found that doc:
https://developer.wordpress.org/reference/hooks/embed_html/

Possible improvement

  1. Give details about what this filter actually filters (only the <iframe> tag)
  1. Add links to the others related actions:

https://developer.wordpress.org/reference/hooks/embed_content
https://developer.wordpress.org/reference/hooks/embed_content_meta/

  1. Add example of how to use each one of these filters

Feel free to ask me further details if needed.
Thanks!
Matt

Attachments (1)

37752.diff (518 bytes) - added by musus 3 years ago.
Change description of $output for clarification.

Download all attachments as: .zip

Change History (7)

#1 @swissspidy
4 years ago

  • Keywords needs-patch added
  • Version changed from 4.6 to 4.4

#2 @johnbillion
4 years ago

  • Keywords good-first-bug needs-docs added

This ticket was mentioned in Slack in #docs by morganestes. View the logs.


3 years ago

@musus
3 years ago

Change description of $output for clarification.

#4 @musus
3 years ago

  • Keywords has-patch added; needs-patch removed

#5 @DrewAPicture
3 years ago

  • Owner set to DrewAPicture
  • Resolution set to fixed
  • Status changed from new to closed

In 40945:

Docs: Add a clarification to the description about what the $output parameter in the embed_html filter doc represents.

Props musus.
Fixes #37752.

#6 @DrewAPicture
3 years ago

  • Keywords needs-docs removed
  • Milestone changed from Awaiting Review to 4.9
Note: See TracTickets for help on using tickets.