Questions tagged [documentation]

The tag has no usage guidance.

Filter by
Sorted by
Tagged with
1 vote
2 answers
43 views

Is there a script to collect all hooks and filters provided by a plugin?

As a plugin developer who wants to provide better documentations to my customers I'm also including a dev section inside my docs. This section should contain all provided hooks and filters by my ...
  • 217
1 vote
0 answers
25 views

PHPStorm and CodeSniffer do not recognize WPCS [closed]

I'm trying to use Wordpress Coding Standards in my PHP Storm projects but I keep getting errors. What I already did: I put it in composer.json: "require": { "squizlabs/php_codesniffer&...
0 votes
0 answers
36 views

Is the default value of FORCE_SSL_ADMIN documented?

(Update. I rephrased the title since I understood better meanwhile what was going on.) Dealing with an attempt to understand HTTPS redirection, I ended up seeing with a massive grep -r '...
  • 101
0 votes
1 answer
106 views

Callback hooked to post_updated firing on new posts as well

Context: I'm using a plugin that allows me to add author boxes throughout my site (Simple Author Box), while providing an easy way for any user to update their social media links and profile pictures. ...
5 votes
2 answers
799 views

Is there a list / reference for all current native WordPress blocks?

I'm working on a theme that should style all native WordPress blocks via CSS, including potentially extending them with custom 'style' options in the block editor via JS. Does anyone know of a list or ...
  • 3,353
0 votes
1 answer
192 views

How to use embed_content hook?

From the document of embed_content: Prints additional content after the embed excerpt. But I don't know which content it will print. Does it take any arguments?
0 votes
2 answers
39 views

Is it possible to view WP documentation within the WordPress shell?

I'm having trouble navigating the WP documentation so forgive me if this is common knowledge. Is it possible to view the documentation of classes and methods from within the shell? That is, is there ...
0 votes
1 answer
164 views

Changing the the_author_posts_link() hover title

Is it possible to change the title="" attribute that Wordpress generates with the_author_posts_link() ? It is currently displaying 'Messages of [User]' as a hover title but I wish to change this to ...
8 votes
2 answers
932 views

What's the difference between the capability remove_users and delete_users?

In the list of capabilities, I found there's both remove_users and delete_users. It's not clear to me what remove_users is supposed to do, the Codex documentation just says it was introduced in ...
  • 215
10 votes
2 answers
11k views

What are all the query parameters for getEntityRecords?

I'm working on a plugin that defined a custom block for the Gutenberg/Block Editor. The block shows a select box of posts. When you select one, I create HTML with some of the selected post's fields, ...
  • 201
3 votes
1 answer
691 views

Gutenberg & Pre-formatted Templates: Core Block Attributes

The Gutenberg Handbook currently has a short entry for creating whole templates of blocks, e.g. used for Custom Post Types or just pre-formatting posts. https://wordpress.org/gutenberg/handbook/...
  • 315
0 votes
1 answer
222 views

Check class_exists before class definition / Doxygen problem

Currently when I create a class for my WordPress, I start the class with if ( ! class_exist( 'class_i_want_create' ) ) : .... class_definition .... endif; But now I want to create a ...
2 votes
1 answer
32 views

When should I use @see tag in my inline doc for Functions & Class Methods?

The coding standards state to use @see for "Reference to a function, method, or class that is heavily-relied on within." Ok. But if I have a function, it always means that something uses it, ...
  • 38
5 votes
3 answers
537 views

Is there widely accepted phpDoc syntax for documenting which hook calls a function?

I keep all hooks in one file, and the functions are organized in their respective classes (different auto-loaded files). Looking for a standard way to document that a function's sole purpose is to be ...
  • 111
1 vote
0 answers
461 views

Documentation for adding a tinyMCE view for visual live preview of custom shortcode?

I'm trying to add a WYSIWYG visual representation for a custom shortcode into the tinyMCE editor but I can barely find any information on how to do that. Researching the last few days resulted in ...
0 votes
1 answer
73 views

Will php documentation conflict with wordpress documentation?

Hi I have a php script that makes liberal use of /* */ // my question is will that conflict with wordpress since the wordpress engine often reads variables inside those things? The reason ...
0 votes
1 answer
2k views

Are the default entries for a user in wp_usermeta documented?

On a fresh vanilla install of wordpress users have default entries like nickename, first_name, last_name and so forth in wp_usermeta. I'm not sure if that changes often or at all but I can't seem to ...
1 vote
0 answers
70 views

Plugin developer automated documentation

I have published a plugin which provides a nice extensibility. Now, I want to provide my users an automated PHP Documentation which describes the API Functions, Filters and Actions like this page here:...
0 votes
2 answers
36 views

Smarter Document Management links between three Wordpress sites sought

I've built and manage two primary/junior school sites in the UK. They've recently come together under a Multi Academy Trust (MAT) and consequently, they now share a fair amount of common policies and ...
  • 31
1 vote
1 answer
53 views

How to incorporate Documentation into wordpress?

I am building a site, and I would like to have my documentation built into the site. For example if I use JSDoc to generate documentation for javascript, I get the auto generated files, I can just ...
9 votes
1 answer
445 views

Is the codex no longer actively maintained?

I generally Google when I need a quick reference for a Wordpress function, and generally it's a Codex post that comes up first (eg. https://codex.wordpress.org/Function_Reference/get_term when ...
  • 4,489
0 votes
1 answer
1k views

Private pdf files

I would like to give access some private pdf files to only logged in users. I have this in my htaccess: RewriteCond %{REQUEST_FILENAME} ^.*(pdf)$ RewriteCond %{HTTP_COOKIE} !^.*wordpress_logged_in.*$...
8 votes
1 answer
134 views

Is there a top-down documentation for WordPress?

This may sound like a silly question, but is there any technical top-down documentation that explains how WordPress works? There's a lot of "How to..." style documentation, i.e. explaining how to get ...
0 votes
1 answer
36 views

Mutliple users editing single document in wordspress

My team is working on wordpress for documentation purpose. No I want to create a document with multiple chapters and different team members should edit different chapters. One chapter opened by one ...
  • 101
0 votes
0 answers
58 views

Adding list of Indexes in wordpress document

I have been exploring wordpress to use it for documentation puposes. I'm stuck at a point where I am unable to add a list of Indexes to the document. Can I add indexes to a wordpress document the way ...
  • 101
1 vote
1 answer
1k views

How to view WordPress' default category IDs?

It seems that Wordpress has default categories with default (and unchangeable) IDs. For example, the uncategorized category seems to always have an id of 1. Is this always the case? Is there any ...
0 votes
1 answer
33 views

Do define() statements need phpDocumentor-style docblocks?

There's no word on this in the WordPress Documentation Standards, but do define() statements need phpDocumentor-style docblocks? /** * Should this docblock be here? * * @since 1.0.0 */ define( '...
  • 3,007
1 vote
1 answer
851 views

Why does my <Style> dissappear?

Why does my style-tag disappear, in both my free site and my localhost site? Where do I find the Wordpress guidelines that specify what can-not be done. Example, where do I find: "Wordpress does not ...
5 votes
2 answers
632 views

How should I document function calls?

Reading the WordPress PHP Documentation Standards, I can't see anywhere that mentions how to document a function call such as add_action( 'foo', 'bar' ); Should I be documenting function calls and, ...
  • 3,007
0 votes
0 answers
74 views

Does a codex exist for creating meta boxes in taxonomy

I am looking for WordPress official documentation to create meta boxes in a taxonomy. There are many tutorials, but each of them is completely different. I don't want to use any plugins. I need the ...
7 votes
2 answers
6k views

Javascript WP Object Documentation?

I was working on implementing the media library within one of my plugins/themes. I found a nice tutorial (http://mikejolley.com/2012/12/using-the-new-wordpress-3-5-media-uploader-in-plugins/) that ...
  • 173
2 votes
1 answer
115 views

How to submit documentation with plugin

When I submit a plugin to the wordpress public repo, how am I supposed to submit documentation? What is considered standard or good practice? Should I just have all documentation on the be page that ...
0 votes
2 answers
4k views

wp_nav_menu $theme_location parameter ignored

This is the first paragraph of the documentation of the function wp nav menu: Given a theme_location parameter, the function displays the menu assigned to that location, or nothing if no such ...
5 votes
1 answer
246 views

WordPress objects class reference

In WordPress we have several objects defined through classes that are enough documented. These are the WP_Query, WPDB, WP_Post and other. There are other objects however that are actually created at ...
-1 votes
4 answers
63 views

documentation on arguements?

I have seen many different parameters or arguments that can be passed to a query. For example, category_in, category_and term_id to name a few. Some of these can be found by using print_r to print out ...
  • 1,343
0 votes
1 answer
29 views

How indicate when a functions was upgraded in relationship to the entire program [closed]

for inline documentation there are those @somethings for some php documenter, when there is the common @since @version and so on. I have a lot of functions that are all part of a big package. But ...
  • 375
1 vote
2 answers
1k views

where is the documentation for add_action() parameters?

I am reading the source of a plugin (gallery to slideshow plugin) to make it behave like i want and it is using an action add_action( 'the_posts', array( &$this, 'have_gallery' ), 10, 1 ); I ...
  • 235
0 votes
1 answer
66 views

Knowledgebase / Docs: Custom Post Type, Pages or as a Post Category?

I'm trying to decide on how to organize a new site/theme. It has the standard sections: Home, About, Contact, Blog but also an (admin-only editable) Knowledgebase/Documentation area. My first ...
  • 133
2 votes
3 answers
4k views

Wordpress plugin for authoring technical documentation? [closed]

We'd like to use WordPress to author the technical documentation for our software product. We've used plain-old WordPress pages, arranged then hierarchically, and it works ok, but it's not great. The ...
2 votes
1 answer
128 views

Workflow and best practice for documentation [closed]

We have been creating a bunch of templates that are very custom and change from time to time but also have a bunch of similar parts from theme to theme. I am looking to streamline the way we create ...
  • 223
15 votes
1 answer
5k views

Alternative to query_posts for main loop? [duplicate]

Possible Duplicate: When to use WP_query(), query_posts() and pre_get_posts I just noticed today that the documentation for query_posts() mentions some "disadvantages" of using query_posts for ...
  • 6,796
2 votes
3 answers
330 views

Styling readme.html in plugin?

I am making readme.html file for a plugin with some detailed setup instruction that need to include screenshots. As rest of UI I want it be consistent with WordPress style and so I looked at its own ...
  • 98.1k
1 vote
2 answers
4k views

WordPress documentation - WP_Query arguments

I've been looking for a list all WP_Query arguments. This looks obvious, but http://codex.wordpress.org/Function_Reference/WP_Query isn't helpful at all, "post_type" is mentioned only in an example, ...
  • 4,941
0 votes
3 answers
123 views

Codex Version Focus on Production or Nightly?

The function get_users_of_blog() is to be deprecated in WP 3.1.0 but the current production release is 3.0.5. Does it make since to have the documentation reflect a nightly change when the ...
  • 103
6 votes
2 answers
2k views

Where can I find a real architecture document on Wordpress?

I can only find some db schemas, what about all the rest of business logics in UML ?
's user avatar
1 vote
2 answers
142 views

User Training Materials

Does anybody know of any good publicly-available Wordpress training materials (videos, manuals, etc.) that could be used to give content editors a basic overview of Wordpress. We have a a handful of ...
  • 113
5 votes
5 answers
2k views

WordPress training materials

Are there any good publicly-available WordPress training materials (videos, manuals, etc.) that could be used to give content editors a basic overview of WordPress? We have a handful of blogs on a ...
48 votes
8 answers
24k views

Local copy of WordPress Codex?

Sometimes I want to develop WordPress themes when I have no internet connection. I need the Function Reference and Template Tags to be productive. I searched for a downloadable or SVN copy of the ...
  • 2,977