[oik] plugins.com

WordPress plugins and themes

  • Home
  • About
    • lazy shortcodes
    • smart shortcodes
    • oik base plugin
      • oik – donate
      • oik PayPal buttons
      • oik installation
      • oik Button Shortcode button
      • oik changelog
      • oik FAQ
      • oik plugins on SVN
      • oik plugins on GitHub
  • Plugins
    • oik base plugin
    • FREE oik plugins
    • WordPress plugins
    • Premium oik plugins
    • Bespoke oik plugins
  • Shortcodes
    • Shortcode examples
  • Blocks
    • Block examples
  • APIs
    • ALL action and filter hooks
  • Blog

oikai_build_apiref() – Automatically create the API reference

You appear to be a bot. Output may be restricted

Description

Automatically create the API reference

Create the API reference information for:

  • Short and long description
  • Usage
  • Parameters
  • Return
  • TO DO(s)
  • Sourcefile
Then show the dynamically generated Syntax

Usage

oikai_build_apiref( $funcname, $sourcefile, $plugin_slug, $classname, $post_id, $echo, $plugin_id );

Parameters

$funcname
( string ) required – the function name – @TODO which may be classname::funcname
$sourcefile
( string ) optional – the source file
$plugin_slug
( string ) optional default: oik – the plugin slug
$classname
( string ) optional – the class name for a method
$post_id
( ID ) optional – the post ID for the "api"
$echo
( bool ) optional default: 1 – true if we actually want the source to be listed
$plugin_id
( ID ) optional – the post ID for the plugin or theme

Returns

void

Source

File name: oik-shortcodes/shortcodes/oik-api-importer.php
Lines:
1 to 27 of 27
function oikai_build_apiref( $funcname, $sourcefile=null, $plugin_slug="oik", $classname=null, $post_id=null, $echo=true, $plugin_id=null ) {
  $func = oikai_get_func( $funcname, $classname );
  bw_context( "func", $func );
  $class = oikai_get_class( $funcname, $classname );
  bw_context( "classname", $class );
  // p( "Class: $class" );
  $refFunc = oikai_pseudo_reflect( $func, $sourcefile, $plugin_slug, $class );
  if ( $refFunc ) {
    if ( $echo ) {
      $docblock = oikai_reflect_docblock( $refFunc );
      oikai_reflect_descriptions( $docblock );
      oikai_reflect_usage( $refFunc, $docblock, $funcname );
      oikai_reflect_parameters( $refFunc, $docblock );
      oikai_print_return( $refFunc, $docblock );
      oikai_print_todos( $refFunc, $docblock );
      oikai_reflect_filename( $refFunc, $sourcefile, $plugin_slug );
      //bw_flush();
      //bw_push();
    }
    oik_require( "admin/oik-apis.php", "oik-shortcodes" );
    $component_type = oiksc_query_component_type( $plugin_slug );
    $source = oikai_listsource( $refFunc, $post_id, $plugin_slug, $component_type, $echo );
    oikai_external_links( $sourcefile, $plugin_slug, $post_id, $plugin_id, $refFunc );
  } else { 
    p( "No API information available for: " . $funcname );
  }  
}
 
 View on GitHub

Published: March 11, 2017 | Last updated: March 11, 2017

Information

Function name: oikai_build_apiref
Plugin ref: oik block shortcode and API server
Version: 1.41.1
Sourcefile: shortcodes/oik-api-importer.php
File ref: shortcodes/oik-api-importer.php
Deprecated?: No
API Letters: A,B,O

Recent plugin updates

oik v4.9.2 Upgrade to oik v4.9.2 for support for PHP 8.1 and PHP 8.2. ...
oik-block v0.3.0 oik-block v0.3.0 no longer displays the Editor selection meta box ...
oik-blocks v1.4.3 Upgrade to oik-blocks v1.4.3 for PHP 8.2 support. ...
cookie-cat v1.4.6 Upgrade to cookie-cat v1.4.6 for PHP 8.1 & PHP 8.2 support. ...
oik-fields v1.54.0 oik-fields v1.54.0 caters for the deprecation of get_page_by_title() in WordPress 6.2. ...

Plugins

  • All Plugins
  • oik base plugin
  • FREE oik plugins
  • WordPress plugins
  • Premium oik plugins

Themes

  • FREE themes
  • Bespoke themes
  • Premium themes

Blocks

  • All Blocks
  • Block examples
  • About Blocks

Shortcodes

  • All Shortcodes
  • Shortcode examples
  • About Shortcodes

Reference

  • About APIs
  • All APIs
  • All Classes
  • All Files
  • All Hooks

Support

  • Contact
  • Cookies policy
  • Get API key
  • Privacy
  • Request support
  • Sitemap
  • Stay informed
  • Terms and Conditions
oik-plugins
Email: herb@bobbingwide.com

Weight shipping plugins

Find out which cart weight shipping plugin you need for your WooCommerce site.
Which cart weight based plugin do I need?

Site:  www.oik-plugins.com
© Copyright oik-plugins 2011-2023. All rights reserved.


Website designed and developed by Herb Miller of Bobbing Wide
Proudly powered by WordPress and oik-plugins
WordPress 6.3.1. PHP: 7.4.33. Memory limit: 768M